Changeset 49103

Timestamp:

10/08/2020 01:30:25 AM (6 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Introduce search term handler.

This allows for clients to search the available terms via the /wp/v2/search endpoint by using a type=term query parameter.

Fixes #51458.
Props andraganescu, zieladam, noisysocks, TimothyBlynJacobs.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (2 diffs)
• src/wp-includes/rest-api/search/class-wp-rest-term-search-handler.php (added)
• src/wp-settings.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-search-controller.php (modified) (4 diffs)
• tests/qunit/fixtures/wp-api-generated.js (modified) (2 diffs)

trunk/src/wp-includes/rest-api.php

@@ -269 +269 @@
         $controller->register_routes();
 
+        $search_handlers = array(
+                new WP_REST_Post_Search_Handler(),
+                new WP_REST_Term_Search_Handler(),
+        );
+
         /**
          * Filters the search handlers to use in the REST search controller.
@@ -278 +283 @@
          *                               Default is only a handler for posts.
          */
-        $search_handlers = apply_filters( 'wp_rest_search_handlers', array( new WP_REST_Post_Search_Handler() ) );
+        $search_handlers = apply_filters( 'wp_rest_search_handlers', $search_handlers );
 
         $controller = new WP_REST_Search_Controller( $search_handlers );

trunk/src/wp-settings.php

@@ -267 +267 @@
 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 . '/sitemaps.php';
 require ABSPATH . WPINC . '/sitemaps/class-wp-sitemaps.php';

trunk/tests/phpunit/tests/rest-api/rest-search-controller.php

@@ -36 +36 @@
 
         /**
+         * Categories.
+         *
+         * @var int
+         */
+        private static $my_category_id;
+
+        /**
+         * Tags.
+         *
+         * @var int
+         */
+        private static $my_tag_id;
+
+        /**
          * Create fake data before our tests run.
          *
@@ -61 +75 @@
                         array(
                                 'post_content' => 'my-foocontent',
+                        )
+                );
+
+                self::$my_category_id = $factory->term->create(
+                        array(
+                                'taxonomy' => 'category',
+                                'name'     => 'Test Category',
+                        )
+                );
+
+                self::$my_tag_id = $factory->term->create(
+                        array(
+                                'taxonomy' => 'post_tag',
+                                'name'     => 'Test Tag',
                         )
                 );
@@ -77 +105 @@
                 foreach ( $post_ids as $post_id ) {
                         wp_delete_post( $post_id, true );
+                }
+
+                $term_ids = array(
+                        self::$my_category_id,
+                        self::$my_tag_id,
+                );
+
+                foreach ( $term_ids as $term_id ) {
+                        wp_delete_term( $term_id, true );
                 }
         }
@@ -516 +553 @@
 
         /**
+         * Search through terms of any type.
+         *
+         * @ticket 51458
+         */
+        public function test_get_items_search_type_term() {
+                $response = $this->do_request_with_params(
+                        array(
+                                'per_page' => 100,
+                                'type'     => 'term',
+                        )
+                );
+                $this->assertEquals( 200, $response->get_status() );
+                $this->assertEqualSets(
+                        array(
+                                0 => 1, // That is the default category.
+                                self::$my_category_id,
+                                self::$my_tag_id,
+                        ),
+                        wp_list_pluck( $response->get_data(), 'id' )
+                );
+        }
+
+        /**
+         * Search through terms of subtype 'category'.
+         *
+         * @ticket 51458
+         */
+        public function test_get_items_search_type_term_subtype_category() {
+                $response = $this->do_request_with_params(
+                        array(
+                                'per_page' => 100,
+                                'type'     => 'term',
+                                'subtype'  => 'category',
+                        )
+                );
+
+                $this->assertEquals( 200, $response->get_status() );
+                $this->assertEqualSets(
+                        array(
+                                0 => 1, // That is the default category.
+                                self::$my_category_id,
+                        ),
+                        wp_list_pluck( $response->get_data(), 'id' )
+                );
+        }
+
+        /**
+         * Search through posts of an invalid post type.
+         *
+         * @ticket 51458
+         */
+        public function test_get_items_search_term_subtype_invalid() {
+                $response = $this->do_request_with_params(
+                        array(
+                                'per_page' => 100,
+                                'type'     => 'term',
+                                'subtype'  => 'invalid',
+                        )
+                );
+
+                $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+        }
+
+        /**
+         * Search through posts and pages.
+         *
+         * @ticket 51458
+         */
+        public function test_get_items_search_categories_and_tags() {
+                $response = $this->do_request_with_params(
+                        array(
+                                'per_page' => 100,
+                                'type'     => 'term',
+                                'subtype'  => 'category,post_tag',
+                        )
+                );
+                $this->assertEquals( 200, $response->get_status() );
+                $this->assertEqualSets(
+                        array(
+                                0 => 1, // This is the default category.
+                                self::$my_category_id,
+                                self::$my_tag_id,
+                        ),
+                        wp_list_pluck( $response->get_data(), 'id' )
+                );
+        }
+
+        /**
+         * Search through all that matches a 'Test Category' search.
+         *
+         * @ticket 51458
+         */
+        public function test_get_items_search_for_test_category() {
+                $response = $this->do_request_with_params(
+                        array(
+                                'per_page' => 100,
+                                'search'   => 'Test Category',
+                                'type'     => 'term',
+                        )
+                );
+
+                $this->assertEquals( 200, $response->get_status() );
+                $this->assertEqualSets(
+                        array(
+                                self::$my_category_id,
+                        ),
+                        wp_list_pluck( $response->get_data(), 'id' )
+                );
+        }
+
+        /**
+         * Search through all that matches a 'Test Tag' search.
+         *
+         * @ticket 51458
+         */
+        public function test_get_items_search_for_test_tag() {
+                $response = $this->do_request_with_params(
+                        array(
+                                'per_page' => 100,
+                                'search'   => 'Test Tag',
+                                'type'     => 'term',
+                        )
+                );
+
+                $this->assertEquals( 200, $response->get_status() );
+                $this->assertEqualSets(
+                        array(
+                                self::$my_tag_id,
+                        ),
+                        wp_list_pluck( $response->get_data(), 'id' )
+                );
+        }
+
+        /**
+         * Searching for a term that doesn't exist should return an empty result.
+         *
+         * @ticket 51458
+         */
+        public function test_get_items_search_for_missing_term() {
+                $response = $this->do_request_with_params(
+                        array(
+                                'per_page' => 100,
+                                'search'   => 'Doesn\'t exist',
+                                'type'     => 'term',
+                        )
+                );
+
+                $this->assertEquals( 200, $response->get_status() );
+                $this->assertEmpty( $response->get_data() );
+        }
+
+        /**
          * Perform a REST request to our search endpoint with given parameters.
          */

trunk/tests/qunit/fixtures/wp-api-generated.js

@@ -4414 +4414 @@
                             "default": "post",
                             "enum": [
-                                "post"
+                                "post",
+                                "term"
                             ],
                             "description": "Limit results to items of an object type.",
@@ -4428 +4429 @@
                                     "post",
                                     "page",
+                                    "category",
+                                    "post_tag",
                                     "any"
                                 ],