Changeset 43739

Timestamp:

10/17/2018 05:02:04 PM (6 years ago)

Author:

danielbachhuber

Message:

REST API: Introduce controller for searching across post types.

Introduces a WP_REST_Search_Controller class which registers a /wp/v2/search endpoint. Search types are handled by extending WP_REST_Search_Handler. The default search type is WP_REST_Post_Search_Handler but can be filtered by plugins or a theme.

Props danielbachhuber, flixos90, pento, rmccue.
Fixes #39965.

Location:

branches/5.0

Files:

• src/wp-includes/rest-api.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php (added)
• src/wp-includes/rest-api/search (added)
• src/wp-includes/rest-api/search/class-wp-rest-post-search-handler.php (added)
• src/wp-includes/rest-api/search/class-wp-rest-search-handler.php (added)
• src/wp-settings.php (modified) (2 diffs)
• tests/phpunit/includes/bootstrap.php (modified) (1 diff)
• tests/phpunit/includes/class-wp-rest-test-search-handler.php (added)
• tests/phpunit/tests/rest-api/rest-schema-setup.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-search-controller.php (added)
• tests/qunit/fixtures/wp-api-generated.js (modified) (1 diff)

branches/5.0/src/wp-includes/rest-api.php

@@ -229 +229 @@
     // Comments.
     $controller = new WP_REST_Comments_Controller;
+    $controller->register_routes();
+
+    /**
+     * Filters the search handlers to use in the REST search controller.
+     *
+     * @since 5.0.0
+     *
+     * @param array $search_handlers List of search handlers to use in the controller. Each search
+     *                               handler instance must extend the `WP_REST_Search_Handler` class.
+     *                               Default is only a handler for posts.
+     */
+    $search_handlers = apply_filters( 'wp_rest_search_handlers', array( new WP_REST_Post_Search_Handler() ) );
+
+    $controller = new WP_REST_Search_Controller( $search_handlers );
     $controller->register_routes();
 

branches/5.0/src/wp-settings.php

@@ -234 +234 @@
 require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-users-controller.php' );
 require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-comments-controller.php' );
+require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-search-controller.php' );
 require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-settings-controller.php' );
 require( ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-themes-controller.php' );
@@ -241 +242 @@
 require( ABSPATH . WPINC . '/rest-api/fields/class-wp-rest-term-meta-fields.php' );
 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' );
 
 $GLOBALS['wp_embed'] = new WP_Embed();

branches/5.0/tests/phpunit/includes/bootstrap.php

@@ -118 +118 @@
 require dirname( __FILE__ ) . '/utils.php';
 require dirname( __FILE__ ) . '/spy-rest-server.php';
+require dirname( __FILE__ ) . '/class-wp-rest-test-search-handler.php';
 
 /**

branches/5.0/tests/phpunit/tests/rest-api/rest-schema-setup.php

@@ -111 +111 @@
             '/wp/v2/comments',
             '/wp/v2/comments/(?P<id>[\\d]+)',
+            '/wp/v2/search',
             '/wp/v2/settings',
             '/wp/v2/themes',

branches/5.0/tests/qunit/fixtures/wp-api-generated.js

@@ -3406 +3406 @@
                 }
             ]
+        },
+        "/wp/v2/search": {
+            "namespace": "wp/v2",
+            "methods": [
+                "GET"
+            ],
+            "endpoints": [
+                {
+                    "methods": [
+                        "GET"
+                    ],
+                    "args": {
+                        "context": {
+                            "required": false,
+                            "default": "view",
+                            "enum": [
+                                "view",
+                                "embed"
+                            ],
+                            "description": "Scope under which the request is made; determines fields present in response.",
+                            "type": "string"
+                        },
+                        "page": {
+                            "required": false,
+                            "default": 1,
+                            "description": "Current page of the collection.",
+                            "type": "integer"
+                        },
+                        "per_page": {
+                            "required": false,
+                            "default": 10,
+                            "description": "Maximum number of items to be returned in result set.",
+                            "type": "integer"
+                        },
+                        "search": {
+                            "required": false,
+                            "description": "Limit results to those matching a string.",
+                            "type": "string"
+                        },
+                        "type": {
+                            "required": false,
+                            "default": "post",
+                            "enum": [
+                                "post"
+                            ],
+                            "description": "Limit results to items of an object type.",
+                            "type": "string"
+                        },
+                        "subtype": {
+                            "required": false,
+                            "default": "any",
+                            "description": "Limit results to items of one or more object subtypes.",
+                            "type": "array",
+                            "items": {
+                                "enum": [
+                                    "post",
+                                    "page",
+                                    "any"
+                                ],
+                                "type": "string"
+                            }
+                        }
+                    }
+                }
+            ],
+            "_links": {
+                "self": "http://example.org/index.php?rest_route=/wp/v2/search"
+            }
         },
         "/wp/v2/settings": {