Allow exact search in REST API #3677

mehulkaklotar · 2022-11-24T13:25:49Z

Trac ticket: https://core.trac.wordpress.org/ticket/56350

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

mukeshpanchal27 · 2022-11-25T09:40:41Z

tests/phpunit/tests/rest-api/rest-posts-controller.php

+		$this->assertCount( 1, $data, 'Querying the API with exact_search should return posts matching the search keyword' );
+
+		// Note that "exact_search" is still true.
+		$request->set_param( 'search', 'Rye Bread' );


What result do you get when you search Types of Bread?

Much like /?s=Types+of+Bread&exact=1, this will not return a match. This applies to any exact search in which the search term includes a space.

When we exact search the one word, it will return the posts matching exactly, but if there are multiple words to exact search, it doesn't work actually. so would it make sense to introduce sentence as well in the REST api?

@TimothyBJacobs What do you think?

#3677 (comment)

mukeshpanchal27 · 2022-11-25T09:51:06Z

@ironprogrammer @TimothyBJacobs What is your thoughts on #3677 (comment)?

tests/phpunit/tests/rest-api/rest-posts-controller.php

costdev · 2022-11-30T06:06:11Z

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

@@ -251,6 +251,7 @@ public function get_items( $request ) {
 			'search'         => 's',
 			'slug'           => 'post_name__in',
 			'status'         => 'post_status',
+			'exact_search'   => 'exact',


These appear to be organised alphabetically by key, so the new exact_search key should be placed above exclude.

@costdev I have updated the placement for exact_search now.

Thanks @mehulkaklotar!

github-actions · 2024-09-17T17:08:14Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props mehulkaklotar, flixos90, mukesh27, costdev, timothyblynjacobs.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

github-actions · 2024-09-17T17:20:33Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

tests/phpunit/tests/rest-api/rest-posts-controller.php

TimothyBJacobs

this looks good to me! we just need to regenerate wp-api-generated.js

Co-authored-by: Timothy Jacobs <[email protected]>

TimothyBJacobs · 2024-09-17T17:33:31Z

Hm, though looking at this, if we do want to add sentence support, we probably want to change this to be something like search_semantics as an enum of either exact or sentence? So you could do search_semantics=exact,sentence?

felixarntz · 2024-09-17T17:56:06Z

@TimothyBJacobs At this point, we'd probably only support the exact value though, right (as for this PR)? I'm okay choosing a future compatible path here, that said we could also go with the current pragmatic approach and if we want to support more later change it (e.g. deprecate the current one). What do you think?

TimothyBJacobs · 2024-09-17T18:06:57Z

Yeah, I don't think this is bad as is. A search_semantics style parameter is more forward compatible. I don't think we've officially deprecated any actual query parameters yet. But I don't think a search_exact and search_sentence is the worst thing.

…arameter.

felixarntz · 2024-09-17T20:47:26Z

@TimothyBJacobs Updated to use search_semantics enum parameter in 15ee682.

TimothyBJacobs · 2024-09-17T20:59:37Z

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

@@ -337,6 +337,13 @@ public function get_items( $request ) {
 			}
 		}

+		if (
+			isset( $registered['search_semantics'], $request['search_semantics'] )


We don't technically need the isset check since the rest request object will just return null in this case.

Fair. I feel like it's okay keeping though for consistency. Maybe also a tiny bit safer.

Works for me.

felixarntz · 2024-09-17T21:58:03Z

Committed in https://core.trac.wordpress.org/changeset/59034

REST API: add exact search support in api

149f87e

mukeshpanchal27 reviewed Nov 25, 2022

View reviewed changes

costdev reviewed Nov 26, 2022

View reviewed changes

tests/phpunit/tests/rest-api/rest-posts-controller.php Outdated Show resolved Hide resolved

mehulkaklotar added 5 commits November 28, 2022 11:33

REST API: data provider for tests changes

0928d17

REST API: data provider for tests changes lint fixes

c26114d

REST API: data provider for tests changes test fixes

fbae724

REST API: change placement of data provider for tests

e030648

Merge branch 'WordPress:trunk' into 56350-exact-search

309b429

costdev reviewed Nov 30, 2022

View reviewed changes

mehulkaklotar and others added 2 commits December 6, 2022 16:39

REST API: placement of exact search in parameter mappings fixed

6085f44

Merge branch 'trunk' into 56350-exact-search

1d0a8b9

TimothyBJacobs reviewed Sep 17, 2024

View reviewed changes

tests/phpunit/tests/rest-api/rest-posts-controller.php Outdated Show resolved Hide resolved

TimothyBJacobs approved these changes Sep 17, 2024

View reviewed changes

felixarntz and others added 3 commits September 17, 2024 10:27

Update wp-api-generated.js.

22b3c37

Use array syntax to set REST params.

808c1f8

Co-authored-by: Timothy Jacobs <[email protected]>

Fix indentation.

95db6ff

Fix indentation.

9bc7287

Use search_semantics enum parameter instead of exact_search boolean p…

15ee682

…arameter.

TimothyBJacobs reviewed Sep 17, 2024

View reviewed changes

TimothyBJacobs self-requested a review September 17, 2024 21:11

TimothyBJacobs approved these changes Sep 17, 2024

View reviewed changes

felixarntz closed this Sep 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow exact search in REST API #3677

Allow exact search in REST API #3677

mehulkaklotar commented Nov 24, 2022

mukeshpanchal27 Nov 25, 2022

costdev Nov 26, 2022

mehulkaklotar Nov 28, 2022

costdev Dec 6, 2022

TimothyBJacobs Sep 17, 2024

mukeshpanchal27 commented Nov 25, 2022

costdev Nov 30, 2022

mehulkaklotar Dec 6, 2022

costdev Dec 6, 2022

github-actions bot commented Sep 17, 2024 •

edited

Loading

github-actions bot commented Sep 17, 2024

TimothyBJacobs left a comment

TimothyBJacobs commented Sep 17, 2024

felixarntz commented Sep 17, 2024

TimothyBJacobs commented Sep 17, 2024

felixarntz commented Sep 17, 2024

TimothyBJacobs Sep 17, 2024

felixarntz Sep 17, 2024

TimothyBJacobs Sep 17, 2024

felixarntz commented Sep 17, 2024

Allow exact search in REST API #3677

Allow exact search in REST API #3677

Conversation

mehulkaklotar commented Nov 24, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mukeshpanchal27 commented Nov 25, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 17, 2024 • edited Loading

github-actions bot commented Sep 17, 2024

Test using WordPress Playground

Some things to be aware of

TimothyBJacobs left a comment

Choose a reason for hiding this comment

TimothyBJacobs commented Sep 17, 2024

felixarntz commented Sep 17, 2024

TimothyBJacobs commented Sep 17, 2024

felixarntz commented Sep 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

felixarntz commented Sep 17, 2024

github-actions bot commented Sep 17, 2024 •

edited

Loading