From 49a399db0541e91a542a3d9d88334446114032a2 Mon Sep 17 00:00:00 2001 From: TimothyBlynJacobs Date: Mon, 12 Oct 2020 19:54:05 +0000 Subject: [PATCH] REST API: Introduce search post format handler. This allows for clients to search the used post formats via the /wp/v2/search endpoint by using a type=post-format query parameter. Fixes #51459. Props andraganescu, zieladam, noisysocks, TimothyBlynJacobs. Built from https://develop.svn.wordpress.org/trunk@49132 git-svn-id: http://core.svn.wordpress.org/trunk@48894 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/rest-api.php | 1 + ...ass-wp-rest-post-format-search-handler.php | 128 ++++++++++++++++++ wp-includes/version.php | 2 +- wp-settings.php | 1 + 4 files changed, 131 insertions(+), 1 deletion(-) create mode 100644 wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php diff --git a/wp-includes/rest-api.php b/wp-includes/rest-api.php index c3c8a09d03..2c96ef6bff 100644 --- a/wp-includes/rest-api.php +++ b/wp-includes/rest-api.php @@ -276,6 +276,7 @@ function create_initial_rest_routes() { $search_handlers = array( new WP_REST_Post_Search_Handler(), new WP_REST_Term_Search_Handler(), + new WP_REST_Post_Format_Search_Handler(), ); /** diff --git a/wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php b/wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php new file mode 100644 index 0000000000..ced445ed56 --- /dev/null +++ b/wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php @@ -0,0 +1,128 @@ +type = 'post-format'; + } + + /** + * Searches the object type content for a given search request. + * + * @since 5.6.0 + * + * @param WP_REST_Request $request Full REST request. + * @return array Associative array containing an `WP_REST_Search_Handler::RESULT_IDS` containing + * an array of found IDs and `WP_REST_Search_Handler::RESULT_TOTAL` containing the + * total count for the matching search results. + */ + public function search_items( WP_REST_Request $request ) { + $format_strings = get_post_format_strings(); + $format_slugs = array_keys( $format_strings ); + + $query_args = array(); + + if ( ! empty( $request['search'] ) ) { + $query_args['search'] = $request['search']; + } + + /** + * Filters the query arguments for a search request. + * + * Enables adding extra arguments or setting defaults for a post format search request. + * + * @since 5.6.0 + * + * @param array $query_args Key value array of query var to query value. + * @param WP_REST_Request $request The request used. + */ + $query_args = apply_filters( 'rest_post_format_search_query', $query_args, $request ); + + $found_ids = array(); + foreach ( $format_slugs as $index => $format_slug ) { + if ( ! empty( $query_args['search'] ) ) { + $format_string = get_post_format_string( $format_slug ); + $format_slug_match = stripos( $format_slug, $query_args['search'] ) !== false; + $format_string_match = stripos( $format_string, $query_args['search'] ) !== false; + if ( ! $format_slug_match && ! $format_string_match ) { + continue; + } + } + + $format_link = get_post_format_link( $format_slug ); + if ( $format_link ) { + $found_ids[] = $format_slug; + } + } + + $page = (int) $request['page']; + $per_page = (int) $request['per_page']; + + return array( + self::RESULT_IDS => array_slice( $found_ids, ( $page - 1 ) * $per_page, $per_page ), + self::RESULT_TOTAL => count( $found_ids ), + ); + } + + /** + * Prepares the search result for a given ID. + * + * @since 5.6.0 + * + * @param string $id Item ID, the post format slug. + * @param array $fields Fields to include for the item. + * @return array Associative array containing all fields for the item. + */ + public function prepare_item( $id, array $fields ) { + $data = array(); + + if ( in_array( WP_REST_Search_Controller::PROP_ID, $fields, true ) ) { + $data[ WP_REST_Search_Controller::PROP_ID ] = $id; + } + + if ( in_array( WP_REST_Search_Controller::PROP_TITLE, $fields, true ) ) { + $data[ WP_REST_Search_Controller::PROP_TITLE ] = get_post_format_string( $id ); + } + + if ( in_array( WP_REST_Search_Controller::PROP_URL, $fields, true ) ) { + $data[ WP_REST_Search_Controller::PROP_URL ] = get_post_format_link( $id ); + } + + if ( in_array( WP_REST_Search_Controller::PROP_TYPE, $fields, true ) ) { + $data[ WP_REST_Search_Controller::PROP_TYPE ] = $this->type; + } + + return $data; + } + + /** + * Prepares links for the search result. + * + * @since 5.6.0 + * + * @param string $id Item ID, the post format slug. + * @return array Links for the given item. + */ + public function prepare_item_links( $id ) { + return array(); + } +} diff --git a/wp-includes/version.php b/wp-includes/version.php index 9a8baac864..6546bd93da 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -13,7 +13,7 @@ * * @global string $wp_version */ -$wp_version = '5.6-alpha-49131'; +$wp_version = '5.6-alpha-49132'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. diff --git a/wp-settings.php b/wp-settings.php index f777b60a5e..3f247cc8c9 100644 --- a/wp-settings.php +++ b/wp-settings.php @@ -269,6 +269,7 @@ require ABSPATH . WPINC . '/rest-api/fields/class-wp-rest-user-meta-fields.php'; require ABSPATH . WPINC . '/rest-api/search/class-wp-rest-search-handler.php'; require ABSPATH . WPINC . '/rest-api/search/class-wp-rest-post-search-handler.php'; require ABSPATH . WPINC . '/rest-api/search/class-wp-rest-term-search-handler.php'; +require ABSPATH . WPINC . '/rest-api/search/class-wp-rest-post-format-search-handler.php'; require ABSPATH . WPINC . '/sitemaps.php'; require ABSPATH . WPINC . '/sitemaps/class-wp-sitemaps.php'; require ABSPATH . WPINC . '/sitemaps/class-wp-sitemaps-index.php';