diff --git a/src/wp-includes/rest-api.php b/src/wp-includes/rest-api.php index c3c8a09d03..2c96ef6bff 100644 --- a/src/wp-includes/rest-api.php +++ b/src/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/src/wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php b/src/wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php new file mode 100644 index 0000000000..ced445ed56 --- /dev/null +++ b/src/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/src/wp-settings.php b/src/wp-settings.php index f777b60a5e..3f247cc8c9 100644 --- a/src/wp-settings.php +++ b/src/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'; diff --git a/tests/phpunit/tests/rest-api/rest-search-controller.php b/tests/phpunit/tests/rest-api/rest-search-controller.php index 5de145d96d..f7ac562ee4 100644 --- a/tests/phpunit/tests/rest-api/rest-search-controller.php +++ b/tests/phpunit/tests/rest-api/rest-search-controller.php @@ -54,6 +54,8 @@ class WP_Test_REST_Search_Controller extends WP_Test_REST_Controller_Testcase { * @param WP_UnitTest_Factory $factory Helper that lets us create fake data. */ public static function wpSetUpBeforeClass( $factory ) { + add_theme_support( 'post-formats' ); + self::$my_title_post_ids = $factory->post->create_many( 4, array( @@ -77,6 +79,8 @@ class WP_Test_REST_Search_Controller extends WP_Test_REST_Controller_Testcase { ) ); + set_post_format( self::$my_title_post_ids[0], 'aside' ); + self::$my_category_id = $factory->term->create( array( 'taxonomy' => 'category', @@ -96,6 +100,8 @@ class WP_Test_REST_Search_Controller extends WP_Test_REST_Controller_Testcase { * Delete our fake data after our tests run. */ public static function wpTearDownAfterClass() { + remove_theme_support( 'post-formats' ); + $post_ids = array_merge( self::$my_title_post_ids, self::$my_title_page_ids, @@ -703,6 +709,65 @@ class WP_Test_REST_Search_Controller extends WP_Test_REST_Controller_Testcase { $this->assertEmpty( $response->get_data() ); } + /** + * Search through post formats of any type. + * + * @ticket 51459 + */ + public function test_get_items_search_type_post_format() { + $response = $this->do_request_with_params( + array( + 'per_page' => 100, + 'type' => 'post-format', + ) + ); + $this->assertEquals( 200, $response->get_status() ); + $this->assertContains( + 'Aside', + wp_list_pluck( $response->get_data(), 'title' ) + ); + } + + /** + * Search through all that matches a 'Aside' search. + * + * @ticket 51459 + */ + public function test_get_items_search_for_test_post_format() { + $response = $this->do_request_with_params( + array( + 'per_page' => 100, + 'search' => 'Aside', + 'type' => 'post-format', + ) + ); + + $this->assertEquals( 200, $response->get_status() ); + $this->assertContains( + 'Aside', + wp_list_pluck( $response->get_data(), 'title' ) + ); + } + + /** + * Searching for a post format that doesn't exist should return an empty + * result. + * + * @ticket 51459 + */ + public function test_get_items_search_for_missing_post_format() { + $response = $this->do_request_with_params( + array( + 'per_page' => 100, + 'search' => 'Doesn\'t exist', + 'type' => 'post-format', + ) + ); + + $this->assertEquals( 200, $response->get_status() ); + $this->assertEmpty( $response->get_data() ); + } + /** * Perform a REST request to our search endpoint with given parameters. */ diff --git a/tests/qunit/fixtures/wp-api-generated.js b/tests/qunit/fixtures/wp-api-generated.js index 87f7b3f018..99bec50763 100644 --- a/tests/qunit/fixtures/wp-api-generated.js +++ b/tests/qunit/fixtures/wp-api-generated.js @@ -4510,7 +4510,8 @@ mockedApiResponse.Schema = { "default": "post", "enum": [ "post", - "term" + "term", + "post-format" ], "description": "Limit results to items of an object type.", "type": "string"