Changeset 55248 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Timestamp:

02/07/2023 08:53:01 AM (20 months ago)

Author:

audrasjb

Message:

Query: Add a search_columns argument to control which fields are searched in a search query.

Previously, the s argument of the WP_Query::parse_query() method searched the post_title, post_excerpt, and post_content fields, with no way of controlling this apart from using the posts_search filter and adjusting the SQL manually. This changeset adds the ability to specify which fields are searched when performing a query, using the search_columns argument.

Props johnbillion, birgire, petitphp, audrasjb, costdev, mukesh27.
Fixes #43867.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (2 diffs)

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

@@ -250 +250 @@
             'parent_exclude' => 'post_parent__not_in',
             'search'         => 's',
+            'search_columns' => 'search_columns',
             'slug'           => 'post_name__in',
             'status'         => 'post_status',
@@ -2892 +2893 @@
         }
 
+        $query_params['search_columns'] = array(
+            'default'     => array(),
+            'description' => __( 'Array of column names to be searched.' ),
+            'type'        => 'array',
+            'items'       => array(
+                'enum' => array( 'post_title', 'post_content', 'post_excerpt' ),
+                'type' => 'string',
+            ),
+        );
+
         $query_params['slug'] = array(
             'description' => __( 'Limit result set to posts with one or more specific slugs.' ),