<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[59034] trunk: REST API: Support exact search in the REST API posts endpoint.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/59034">59034</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/59034","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>flixos90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-09-17 21:56:18 +0000 (Tue, 17 Sep 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/56350">#56350</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestattachmentscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestpagescontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-pages-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestpostscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php</a></li>
<li><a href="#trunktestsqunitfixtureswpapigeneratedjs">trunk/tests/qunit/fixtures/wp-api-generated.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2024-09-17 21:52:54 UTC (rev 59033)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2024-09-17 21:56:18 UTC (rev 59034)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -337,6 +337,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (
+ isset( $registered['search_semantics'], $request['search_semantics'] )
+ && 'exact' === $request['search_semantics']
+ ) {
+ $args['exact'] = true;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $args = $this->prepare_tax_query( $args, $request );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Force the post_type argument, since it's not a user input variable.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2886,6 +2893,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $query_params['search_semantics'] = array(
+ 'description' => __( 'How to interpret the search input.' ),
+ 'type' => 'string',
+ 'enum' => array( 'exact' ),
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $query_params['offset'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Offset the result set by a specific number of items.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'integer',
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestattachmentscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2024-09-17 21:52:54 UTC (rev 59033)
+++ trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2024-09-17 21:56:18 UTC (rev 59034)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -229,6 +229,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'per_page',
</span><span class="cx" style="display: block; padding: 0 10px"> 'search',
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_columns',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'search_semantics',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'slug',
</span><span class="cx" style="display: block; padding: 0 10px"> 'status',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestpagescontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-pages-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-pages-controller.php 2024-09-17 21:52:54 UTC (rev 59033)
+++ trunk/tests/phpunit/tests/rest-api/rest-pages-controller.php 2024-09-17 21:56:18 UTC (rev 59034)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,6 +85,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'per_page',
</span><span class="cx" style="display: block; padding: 0 10px"> 'search',
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_columns',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'search_semantics',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'slug',
</span><span class="cx" style="display: block; padding: 0 10px"> 'status',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestpostscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2024-09-17 21:52:54 UTC (rev 59033)
+++ trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2024-09-17 21:56:18 UTC (rev 59034)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -206,6 +206,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'per_page',
</span><span class="cx" style="display: block; padding: 0 10px"> 'search',
</span><span class="cx" style="display: block; padding: 0 10px"> 'search_columns',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'search_semantics',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'slug',
</span><span class="cx" style="display: block; padding: 0 10px"> 'status',
</span><span class="cx" style="display: block; padding: 0 10px"> 'sticky',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -765,6 +766,64 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket 56350
+ *
+ * @dataProvider data_get_items_exact_search
+ *
+ * @param string $search_term The search term.
+ * @param bool $exact_search Whether the search is an exact or general search.
+ * @param int $expected The expected number of matching posts.
+ */
+ public function test_get_items_exact_search( $search_term, $exact_search, $expected ) {
+ self::factory()->post->create(
+ array(
+ 'post_title' => 'Rye',
+ 'post_content' => 'This is a post about Rye Bread',
+ )
+ );
+
+ self::factory()->post->create(
+ array(
+ 'post_title' => 'Types of Bread',
+ 'post_content' => 'Types of bread are White and Rye Bread',
+ )
+ );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+ $request['search'] = $search_term;
+ if ( $exact_search ) {
+ $request['search_semantics'] = 'exact';
+ }
+ $response = rest_get_server()->dispatch( $request );
+ $this->assertCount( $expected, $response->get_data() );
+ }
+
+ /**
+ * Data provider for test_get_items_exact_search().
+ *
+ * @return array[]
+ */
+ public function data_get_items_exact_search() {
+ return array(
+ 'general search, one exact match and one partial match' => array(
+ 'search_term' => 'Rye',
+ 'exact_search' => false,
+ 'expected' => 2,
+ ),
+ 'exact search, one exact match and one partial match' => array(
+ 'search_term' => 'Rye',
+ 'exact_search' => true,
+ 'expected' => 1,
+ ),
+ 'exact search, no match and one partial match' => array(
+ 'search_term' => 'Rye Bread',
+ 'exact_search' => true,
+ 'expected' => 0,
+ ),
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_items_order_and_orderby() {
</span><span class="cx" style="display: block; padding: 0 10px"> self::factory()->post->create(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span></span></pre></div>
<a id="trunktestsqunitfixtureswpapigeneratedjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/fixtures/wp-api-generated.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/fixtures/wp-api-generated.js 2024-09-17 21:52:54 UTC (rev 59033)
+++ trunk/tests/qunit/fixtures/wp-api-generated.js 2024-09-17 21:56:18 UTC (rev 59034)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -362,6 +362,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "default": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "search_semantics": {
+ "description": "How to interpret the search input.",
+ "type": "string",
+ "enum": [
+ "exact"
+ ],
+ "required": false
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "offset": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Offset the result set by a specific number of items.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "integer",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1719,6 +1727,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "integer",
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "search_semantics": {
+ "description": "How to interpret the search input.",
+ "type": "string",
+ "enum": [
+ "exact"
+ ],
+ "required": false
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "offset": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Offset the result set by a specific number of items.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "integer",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2820,6 +2836,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "default": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "search_semantics": {
+ "description": "How to interpret the search input.",
+ "type": "string",
+ "enum": [
+ "exact"
+ ],
+ "required": false
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "offset": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Offset the result set by a specific number of items.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "integer",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3571,6 +3595,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "default": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "search_semantics": {
+ "description": "How to interpret the search input.",
+ "type": "string",
+ "enum": [
+ "exact"
+ ],
+ "required": false
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "offset": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Offset the result set by a specific number of items.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "integer",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4382,6 +4414,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "default": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "search_semantics": {
+ "description": "How to interpret the search input.",
+ "type": "string",
+ "enum": [
+ "exact"
+ ],
+ "required": false
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "offset": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Offset the result set by a specific number of items.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "integer",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6995,6 +7035,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "default": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "search_semantics": {
+ "description": "How to interpret the search input.",
+ "type": "string",
+ "enum": [
+ "exact"
+ ],
+ "required": false
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "offset": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Offset the result set by a specific number of items.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "integer",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7812,6 +7860,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "default": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "search_semantics": {
+ "description": "How to interpret the search input.",
+ "type": "string",
+ "enum": [
+ "exact"
+ ],
+ "required": false
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "offset": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Offset the result set by a specific number of items.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "integer",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8017,6 +8073,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "default": [],
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "search_semantics": {
+ "description": "How to interpret the search input.",
+ "type": "string",
+ "enum": [
+ "exact"
+ ],
+ "required": false
+ },
</ins><span class="cx" style="display: block; padding: 0 10px"> "offset": {
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "Offset the result set by a specific number of items.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "integer",
</span></span></pre>
</div>
</div>
</body>
</html>