Skip to content

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

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

Merged
merged 11 commits into from
May 27, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
62fd6f0
P2 bug mitigation
anaemnesis May 16, 2025
2250a0d
changelog
anaemnesis May 16, 2025
6325f40
Let us disable the filter entirely for now
anaemnesis May 16, 2025
b9204f2
Protect against incorrect use of the_title filter
anaemnesis May 19, 2025
1b05726
Merge remote-tracking branch 'origin/trunk' into fix/early-return-whe…
anaemnesis May 19, 2025
d5be723
changelog
anaemnesis May 19, 2025
b612076
Uncomment the_title filter
anaemnesis May 19, 2025
0694340
We're still seeing <mark> tags. Let's try to be more strict
anaemnesis May 19, 2025
b5ae5ef
This works on sandbox.
anaemnesis May 19, 2025
2cdf24d
Skip o2 theme title highlighting entirely
anaemnesis May 19, 2025
3842bfc
Merge remote-tracking branch 'origin/trunk' into fix/early-return-whe…
anaemnesis May 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions projects/packages/search/changelog/fix-early-return-when-improper-the_title-filter
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Significance: patch
Type: fixed

Protect against improper calls to the_title() filter.
24 changes: 17 additions & 7 deletions projects/packages/search/src/inline-search/class-inline-search-highlighter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@ public function __construct( array $search_result_ids = array(), ?array $results
* Set up the WordPress filters for highlighting.
*/
public function setup(): void {
// phpcs:ignore Squiz.PHP.CommentedOutCode.Found -- Temporarily disabled due to incompatibility with P2 theme
// add_filter( 'the_title', array( $this, 'filter_highlighted_title' ), 10, 2 );
add_filter( 'the_title', array( $this, 'filter_highlighted_title' ), 10, 2 );
add_filter( 'the_excerpt', array( $this, 'filter_highlighted_excerpt' ) );
add_filter( 'render_block_core/post-excerpt', array( $this, 'filter_render_highlighted_block' ), 10, 3 );
}
Expand All @@ -72,12 +71,18 @@ public function process_results( array $results ): void {
/**
* Filter the post title to show highlighted version.
*
* @param string $title The post title.
* @param int $post_id The post ID.
* @param string $title The post title.
* @param int|null $post_id Optional. The post ID. Default null.
*
* @return string The filtered title.
*/
public function filter_highlighted_title( string $title, int $post_id ): string {
public function filter_highlighted_title( string $title, ?int $post_id = null ): string {
// o2 is currently rendering <mark> tags in post titles, so we need to return the original.
$body_class = get_body_class();
if ( is_array( $body_class ) && in_array( 'o2', $body_class, true ) ) {
return $title;
}

Comment on lines +81 to +85
Copy link
Contributor

@valterlorran valterlorran May 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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. :)

if ( ! $this->is_search_result( $post_id ) ) {
return $title;
}
Expand Down Expand Up @@ -163,11 +168,16 @@ private function extract_highlight_field( array $result, string $field ): string
/**
* Check if the current post is a search result from our API
*
* @param int $post_id The post ID to check.
* @param int|null $post_id The post ID to check.
*
* @return bool Whether the post is a search result.
*/
public function is_search_result( int $post_id ): bool {
public function is_search_result( ?int $post_id ): bool {
// o2 is initially returning null due to mishandling of the_title() filter.
if ( null === $post_id ) {
return false;
}

return is_search() && in_the_loop() && ! empty( $this->search_result_ids ) && in_array( $post_id, $this->search_result_ids, true );
}

Expand Down
4 changes: 4 additions & 0 deletions projects/plugins/jetpack/changelog/fix-early-return-when-improper-the_title-filter
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Significance: patch
Type: bugfix

Protect against improper calls to the_title() filter.
4 changes: 4 additions & 0 deletions projects/plugins/search/changelog/fix-early-return-when-improper-the_title-filter
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Significance: patch
Type: fixed

Protect against improper calls to the_title() filter.
Loading