Changeset 54123

Timestamp:

09/11/2022 09:10:31 PM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Add support for searching resources by id.

This brings support for the include and exclude collection parameters to the Search Controller. This can be used to find an item by id when it's subtype is unknown.

Props kadamwhite.
Fixes #56546.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php (modified) (1 diff)
• src/wp-includes/rest-api/search/class-wp-rest-post-search-handler.php (modified) (1 diff)
• src/wp-includes/rest-api/search/class-wp-rest-term-search-handler.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-search-controller.php (modified) (1 diff)
• tests/qunit/fixtures/wp-api-generated.js (modified) (1 diff)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php

@@ -332 +332 @@
                 );
 
+                $query_params['exclude'] = array(
+                        'description' => __( 'Ensure result set excludes specific IDs.' ),
+                        'type'        => 'array',
+                        'items'       => array(
+                                'type' => 'integer',
+                        ),
+                        'default'     => array(),
+                );
+
+                $query_params['include'] = array(
+                        'description' => __( 'Limit result set to specific IDs.' ),
+                        'type'        => 'array',
+                        'items'       => array(
+                                'type' => 'integer',
+                        ),
+                        'default'     => array(),
+                );
+
                 return $query_params;
         }

trunk/src/wp-includes/rest-api/search/class-wp-rest-post-search-handler.php

@@ -70 +70 @@
                 }
 
+                if ( ! empty( $request['exclude'] ) ) {
+                        $query_args['post__not_in'] = $request['exclude'];
+                }
+
+                if ( ! empty( $request['include'] ) ) {
+                        $query_args['post__in'] = $request['include'];
+                }
+
                 /**
                  * Filters the query arguments for a REST API search request.

trunk/src/wp-includes/rest-api/search/class-wp-rest-term-search-handler.php

@@ -69 +69 @@
                 if ( ! empty( $request['search'] ) ) {
                         $query_args['search'] = $request['search'];
+                }
+
+                if ( ! empty( $request['exclude'] ) ) {
+                        $query_args['exclude'] = $request['exclude'];
+                }
+
+                if ( ! empty( $request['include'] ) ) {
+                        $query_args['include'] = $request['include'];
                 }
 

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

@@ -820 +820 @@
         }
 
+        /**
+         * @ticket 56546
+         */
+        public function test_get_items_search_posts_include_ids() {
+                $response = $this->do_request_with_params(
+                        array(
+                                'include' => array_slice( self::$my_title_post_ids, 1, 2 ),
+                        )
+                );
+
+                $this->assertSame( 200, $response->get_status() );
+                $this->assertSameSets(
+                        array( self::$my_title_post_ids[1], self::$my_title_post_ids[2] ),
+                        wp_list_pluck( $response->get_data(), 'id' )
+                );
+        }
+
+        /**
+         * @ticket 56546
+         */
+        public function test_get_items_search_posts_exclude_ids() {
+                $response = $this->do_request_with_params(
+                        array(
+                                'exclude' => self::$my_title_page_ids,
+                        )
+                );
+
+                $this->assertSame( 200, $response->get_status() );
+                $this->assertSameSets(
+                        array_merge(
+                                self::$my_title_post_ids,
+                                self::$my_content_post_ids
+                        ),
+                        wp_list_pluck( $response->get_data(), 'id' )
+                );
+        }
+
+        /**
+         * @ticket 56546
+         */
+        public function test_get_items_search_terms_include_ids() {
+                $response = $this->do_request_with_params(
+                        array(
+                                'include' => self::$my_tag_id,
+                                'type'    => 'term',
+                        )
+                );
+
+                $this->assertSame( 200, $response->get_status() );
+                $this->assertSameSets(
+                        array( self::$my_tag_id ),
+                        wp_list_pluck( $response->get_data(), 'id' )
+                );
+        }
+
+        /**
+         * @ticket 56546
+         */
+        public function test_get_items_search_terms_exclude_ids() {
+                $response = $this->do_request_with_params(
+                        array(
+                                // "1" is the default category.
+                                'exclude' => array( 1, self::$my_tag_id ),
+                                'type'    => 'term',
+                        )
+                );
+
+                $this->assertSame( 200, $response->get_status() );
+                $this->assertSameSets(
+                        array( self::$my_category_id ),
+                        wp_list_pluck( $response->get_data(), 'id' )
+                );
+        }
+
 }

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

@@ -9270 +9270 @@
                             },
                             "required": false
+                        },
+                        "exclude": {
+                            "description": "Ensure result set excludes specific IDs.",
+                            "type": "array",
+                            "items": {
+                                "type": "integer"
+                            },
+                            "default": [],
+                            "required": false
+                        },
+                        "include": {
+                            "description": "Limit result set to specific IDs.",
+                            "type": "array",
+                            "items": {
+                                "type": "integer"
+                            },
+                            "default": [],
+                            "required": false
                         }
                     }