Inline Search: Return when the_title filter is called with the incorrect number of parameters #43511

anaemnesis · 2025-05-19T09:22:16Z

Fixes #p1747423124187819-slack-C02FMH4G8

Proposed changes:

This PR re-enables title highlighting for Inline Search if the active theme is not based on o2, which is being checked against for two reasons:

Per the discussion above, o2 has its own the_title filter that doesn't pass the required number of parameters. o2 passes a post_title but not a post_id, which can lead to fatals. With checks for this in place...
A post_id does eventually get passed, but post titles render with <mark> tags visible as part of the title.

Both of these need either a fix to o2 (to pass the correct number of parameters) or potential changes to escaping, to allow <mark> tags. Both should be addressed in future PRs.

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?

N/A

Testing instructions:

Sandbox PfsEZG-r-p2
Using the bin/jetpack-downloader script (command below), check out this branch on your sandbox.
Ensure no fatals
Ensure titles are returned without <mark> tags on words that match your search term, e.g., billing
Ensure functionality continues to work for title and excerpt highlighting on your local environment. On your local environment, using a theme like TwentyTwentyFour, we'd expect to see:

It's been reported that at least one theme calls the_title() filter with the incorrect number of arguments, 1 instead of 2. This change should address that by returning early when handling title highlighting.

…n-improper-the_title-filter

github-actions · 2025-05-19T09:23:06Z

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 fix/early-return-when-improper-the_title-filter branch.
To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack fix/early-return-when-improper-the_title-filter

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 · 2025-05-19T09:23:15Z

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:

Ensure all required checks appearing at the bottom of this PR are passing.
Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
You can use GitHub's Reviewers functionality to request a review.
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: June 3, 2025
- Code freeze: June 2, 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.

jp-launch-control · 2025-05-19T09:38:07Z

Code Coverage Summary

Coverage changed in 1 file.

File	Coverage	Δ%	Δ Uncovered
projects/packages/search/src/inline-search/class-inline-search-highlighter.php	0/69 (0.00%)	0.00%	6 💔

Full summary · PHP report · JS report

_{Coverage check overridden by

Coverage tests to be added later
Use to ignore the Code coverage requirement check when tests will be added in a follow-up PR
.}

o2's behaviour is a bit more involved than it at first seemed. For the moment let's skip o2 based themes.

trakos

Tested and works as described

valterlorran

LGTM! I tested it on PfsEZG-r-p2 and it looks good.

valterlorran · 2025-05-21T14:39:11Z

projects/packages/search/src/inline-search/class-inline-search-highlighter.php

+		$body_class = get_body_class();
+		if ( is_array( $body_class ) && in_array( 'o2', $body_class, true ) ) {
+			return $title;
+		}
+


Nit: Since get_body_class() ultimately returns array_unique, we might be able to simplify this check.

if ( in_array( 'o2', $body_class, true ) ) { return $title; }

This is a good point, and I've given it some thought. I'm going to keep it as is, just in case there's a something out there filtering body_class and not returning an array. I appreciate that this is probably overly defensive, but also this PR exists, so there we are. :)

…n-improper-the_title-filter

anaemnesis added 6 commits May 16, 2025 22:15

P2 bug mitigation

62fd6f0

changelog

2250a0d

Let us disable the filter entirely for now

6325f40

Protect against incorrect use of the_title filter

b9204f2

It's been reported that at least one theme calls the_title() filter with the incorrect number of arguments, 1 instead of 2. This change should address that by returning early when handling title highlighting.

Merge remote-tracking branch 'origin/trunk' into fix/early-return-whe…

1b05726

…n-improper-the_title-filter

changelog

d5be723

anaemnesis self-assigned this May 19, 2025

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 May 19, 2025

Uncomment the_title filter

b612076

anaemnesis added the Coverage tests to be added later Use to ignore the Code coverage requirement check when tests will be added in a follow-up PR label May 19, 2025

anaemnesis marked this pull request as ready for review May 19, 2025 09:28

anaemnesis added 3 commits May 19, 2025 10:53

We're still seeing <mark> tags. Let's try to be more strict

0694340

This works on sandbox.

b5ae5ef

Skip o2 theme title highlighting entirely

2cdf24d

o2's behaviour is a bit more involved than it at first seemed. For the moment let's skip o2 based themes.

anaemnesis requested review from trakos and valterlorran May 19, 2025 13:42

trakos approved these changes May 20, 2025

View reviewed changes

valterlorran approved these changes May 21, 2025

View reviewed changes

Merge remote-tracking branch 'origin/trunk' into fix/early-return-whe…

3842bfc

…n-improper-the_title-filter

anaemnesis merged commit f1a29be into trunk May 27, 2025
68 checks passed

anaemnesis deleted the fix/early-return-when-improper-the_title-filter branch May 27, 2025 08:59

github-actions bot removed [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. [Status] In Progress labels May 27, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Inline Search: Return when the_title filter is called with the incorrect number of parameters #43511

Inline Search: Return when the_title filter is called with the incorrect number of parameters #43511

Uh oh!

anaemnesis commented May 19, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 19, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 19, 2025 •

edited

Loading

Uh oh!

jp-launch-control bot commented May 19, 2025 •

edited

Loading

Uh oh!

trakos left a comment

Uh oh!

valterlorran left a comment

Uh oh!

valterlorran May 21, 2025 •

edited

Loading

Uh oh!

anaemnesis May 26, 2025

Uh oh!

Uh oh!

Uh oh!

Inline Search: Return when the_title filter is called with the incorrect number of parameters #43511

Inline Search: Return when the_title filter is called with the incorrect number of parameters #43511

Uh oh!

Conversation

anaemnesis commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes:

Other information:

Jetpack product discussion

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

Testing instructions:

Uh oh!

github-actions bot commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jp-launch-control bot commented May 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage Summary

Uh oh!

trakos left a comment

Choose a reason for hiding this comment

Uh oh!

valterlorran left a comment

Choose a reason for hiding this comment

Uh oh!

valterlorran May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anaemnesis May 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

anaemnesis commented May 19, 2025 •

edited

Loading

github-actions bot commented May 19, 2025 •

edited

Loading

github-actions bot commented May 19, 2025 •

edited

Loading

jp-launch-control bot commented May 19, 2025 •

edited

Loading

valterlorran May 21, 2025 •

edited

Loading