Skip to content

Instant Search: Add searched term to results string #43243

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open

Instant Search: Add searched term to results string #43243

wants to merge 2 commits into from
+22 −3

Conversation

anaemnesis
Copy link
Contributor

@anaemnesis anaemnesis commented Apr 25, 2025 •
edited
Loading

Addresses: p1745516011684089-slack-jetpack-search

Proposed changes:

When returning Instant Search results, include the searched term in the results string. This updates the results string from Found X result(s) to Found X result(s) for '$searched-term'

Before

CleanShot 2025-04-25 at 10 44 00

This PR

CleanShot 2025-04-25 at 10 40 42

This PR with corrected query

CleanShot 2025-04-25 at 10 47 46

This PR with multiple results

CleanShot 2025-04-25 at 11 26 50

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

N/A

Does this pull request change what data or activity we track or use?

This PR does not change what data or activity we track or use.

Testing instructions:

Ensure you're watching for package changes, e.g. jp watch packages/search.

  • Enable Instant Search on your local environment
  • On trunk run a search to confirm the Before state shown above.
  • Check out branch.
  • Run a new search to confirm the This PR state shown above, and another to confirm the This PR with corrected query state.

@anaemnesis
Add searched term to results string
b7ff2fd 
Let's add the searched term to the results string, so that it says "Found X result for '$term'" instead
of only "Found X result".
@anaemnesis
changelog
eaf0f58
@anaemnesis anaemnesis added [Type] Bug When a feature is broken and / or not performing as intended [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Feature] Search For all things related to Search labels Apr 25, 2025
@anaemnesis anaemnesis requested a review from gibrown April 25, 2025 09:48
@anaemnesis anaemnesis self-assigned this Apr 25, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 25, 2025 •
edited
Loading

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (Jetpack), and enable the add/searched-term-to-results-string branch.
  • To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack add/searched-term-to-results-string

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions github-actions bot added [Package] Search Contains core Search functionality for Jetpack and Search plugins [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Search A plugin to add an instant search modal to your site to help visitors find content faster. labels Apr 25, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 25, 2025 •
edited
Loading

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen as soon as you deploy your changes after merging this PR (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly:
    • Scheduled release: May 6, 2025
    • Code freeze: May 5, 2025

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Search plugin:

No scheduled milestone found for this plugin.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Apr 25, 2025
@jp-launch-control JP Launch Control
Copy link

Code Coverage Summary

This PR did not change code coverage!

That could be good or bad, depending on the situation. Everything covered before, and still is? Great! Nothing was covered before? Not so great. 🤷

Full summary · PHP report · JS report

@anaemnesis anaemnesis added [Status] Needs Review This PR is ready for review. and removed [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. [Type] Bug When a feature is broken and / or not performing as intended labels Apr 25, 2025
gibrown
gibrown reviewed Apr 25, 2025
View reviewed changes
projects/packages/search/src/instant-search/components/search-results.jsx
_n( 'Found %s result', 'Found %s results', total, 'jetpack-search-pkg' ),
num
/* translators: %1$s: number of results. %2$s: the search query. */
_n(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this shouldn't be the default. To me it feels like we are adding noise to the UI by repeating the search term when it is already just above it. At most I would add it as an option or add a filter that lets the string get overridden.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was going back and forth on this myself and noticed in searching that there are places that show the term twice, e.g. Amazon

CleanShot 2025-04-25 at 16 55 43

Though there is more proximity between the searched term and the results string in the Instant Search model. 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gibrown gibrown gibrown left review comments

Assignees

@anaemnesis anaemnesis

Labels
[Feature] Search For all things related to Search [Package] Search Contains core Search functionality for Jetpack and Search plugins [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Search A plugin to add an instant search modal to your site to help visitors find content faster. [Status] Needs Review This PR is ready for review. [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@anaemnesis @gibrown