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

Timestamp:

09/17/2024 09:56:18 PM (4 weeks ago)

Author:

flixos90

Message:

REST API: Support exact search in the REST API posts endpoint.

This changeset adds support for a new search_semantics enum query parameter that can be passed alongside the search string parameter. At this point, it only supports "exact" as possible value, but an enum is used for forward compatibility with potential enhancements like "sentence" search support. If search_semantics=exact is passed, it will look for an exact match rather than do a full text search, which for some use-cases is more appropriate and more performant.

Props mehulkaklotar, timothyblynjacobs, jimmyh61, ironprogrammer, johnregan3, mukesh27, costdev.
Fixes #56350.

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

@@ -336 +336 @@
                 $args['post__not_in'] = array_merge( $args['post__not_in'], $sticky_posts );
             }
+        }
+
+        if (
+            isset( $registered['search_semantics'], $request['search_semantics'] )
+            && 'exact' === $request['search_semantics']
+        ) {
+            $args['exact'] = true;
         }
 
@@ -2887 +2894 @@
         }
 
+        $query_params['search_semantics'] = array(
+            'description' => __( 'How to interpret the search input.' ),
+            'type'        => 'string',
+            'enum'        => array( 'exact' ),
+        );
+
         $query_params['offset'] = array(
             'description' => __( 'Offset the result set by a specific number of items.' ),