Inline Search: Address Blaskan theme body class conflict with inline highlighter #43797

anaemnesis · 2025-06-05T15:14:27Z

Fixes p1749054774731169-slack-C081BEZPLAZ

Proposed changes:

This PR moves away from the body_class detection approach introduced in #43511, and moves instead to theme detection using wp_get_theme(). While this approach worked for its intended purpose, it seems there are themes that call the body_class filter incorrectly, such as earlier versions of the Blaskan theme:

https://themes.trac.wordpress.org/browser/blaskan/2.6.6/functions.php#L285

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:

On your environment, make sure Jetpack Search is active, but Instant Search is disabled.
Either set add_filter( 'jetpack_search_replace_classic', '__return_true', 20 ); somewhere (e.g. using theCode Snippets plugin) or add an early return true to should_replace_classic_search().
With this branch checked out on your local environment, ensure that search highlighting works for both Block themes (e.g. Twenty Twenty Four) and Classic themes (e.g. Dara), that use the_excerpt() and the_title() to return search results. Twenty Twenty Five returns search results using the_concent(), and this is not compatible with highlighting at this point.
Point PfsEZG-r-p2 to your WordPress.com sandbox
On your sandbox, check out this branch, or manually add the changes toclass-inline-search-highlighter.php.
Ensure you encounter no fatals while browsing the P2 above, and that search results are returned without <mark> tags in the title. Highlighting is not expected to function on P2 at this point.

This commit addresses the Blaskan theme fatal by moving away from body_class() based checking, to theme name and theme template checking. We use this to return the $title early in filter_highlighted_title(), both for the Blasken theme, and p2020, which loads o2 as a plugin and which calls the_title filter incorrectly (which previously caused its own fatal).

github-actions · 2025-06-05T15:15:15Z

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/blaskan_theme_body_class_conflict_with_inline_highlighter branch.
To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack fix/blaskan_theme_body_class_conflict_with_inline_highlighter

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-06-05T15:15:27Z

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: July 1, 2025
- Code freeze: June 30, 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.

anaemnesis · 2025-06-05T15:18:46Z

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

-			return $title;
+		$incompatible_themes = array(
+			'blaskan', // Blaskan incorrectly uses wp_nav_menu() in body_class filter, causing infinite recursion.
+			'p2020',   // P2 loads o2 as a plugin, which calls the_title() filter incorrectly.


o2 is loaded as a plugin on P2, so I'm excluding instead on the basis of p2020 as the active theme. I don't think we need to include o2 separately, and even Blaskan is old enough that ehhh... But this should be a more robust approach, regardless.

jp-launch-control · 2025-06-05T15:27:55Z

Code Coverage Summary

Coverage changed in 1 file.

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

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
.}

sotirispl

I've tested this by overriding should_replace_classic_search and checked how results are getting highlighted for a couple of themes, mentioned in the test instructions. Everything worked as described. LGTM.

anaemnesis added 2 commits June 5, 2025 15:57

changelog

a304117

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 Jun 5, 2025

anaemnesis commented Jun 5, 2025

View reviewed changes

anaemnesis self-assigned this Jun 5, 2025

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 Jun 5, 2025

anaemnesis marked this pull request as ready for review June 5, 2025 15:46

anaemnesis requested review from valterlorran, gibrown, trakos and sotirispl June 5, 2025 15:46

sotirispl approved these changes Jun 6, 2025

View reviewed changes

anaemnesis merged commit 47f04f9 into trunk Jun 9, 2025
74 checks passed

anaemnesis deleted the fix/blaskan_theme_body_class_conflict_with_inline_highlighter branch June 9, 2025 12:04

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Inline Search: Address Blaskan theme body class conflict with inline highlighter #43797

Inline Search: Address Blaskan theme body class conflict with inline highlighter #43797

anaemnesis commented Jun 5, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jun 5, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jun 5, 2025 •

edited

Loading

Uh oh!

anaemnesis Jun 5, 2025 •

edited

Loading

Uh oh!

jp-launch-control bot commented Jun 5, 2025 •

edited

Loading

Uh oh!

sotirispl left a comment

Uh oh!

Uh oh!

Uh oh!

Inline Search: Address Blaskan theme body class conflict with inline highlighter #43797

Inline Search: Address Blaskan theme body class conflict with inline highlighter #43797

Conversation

anaemnesis commented Jun 5, 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 Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

anaemnesis Jun 5, 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!

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

Uh oh!

Code Coverage Summary

Uh oh!

sotirispl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

anaemnesis commented Jun 5, 2025 •

edited

Loading

github-actions bot commented Jun 5, 2025 •

edited

Loading

github-actions bot commented Jun 5, 2025 •

edited

Loading

anaemnesis Jun 5, 2025 •

edited

Loading

jp-launch-control bot commented Jun 5, 2025 •

edited

Loading