Jetpack Search: additional filters support for Inline Search (#43441)

Committed via a GitHub action: https://github.com/Automattic/jetpack/actions/runs/15014401981

Upstream-Ref: Automattic/jetpack@54cdd85

Author: trakos

CHANGELOG.md

@@ -5,10 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.48.1-alpha] - unreleased
+## [0.49.0-alpha] - unreleased
 
 This is an alpha version! The changes listed here are not final.
 
+### Added
+- Jetpack Search: add query filters support to Inline Search
+
 ## [0.48.0] - 2025-05-12
 ### Added
 - Surface search corrections when correcting search terms. [#42473]
@@ -1218,7 +1221,7 @@ This is an alpha version! The changes listed here are not final.
 - Updated package dependencies.
 - Update PHPUnit configs to include just what needs coverage rather than include everything then try to exclude stuff that doesn't.
 
-[0.48.1-alpha]: https://github.com/Automattic/jetpack-search/compare/v0.48.0...v0.48.1-alpha
+[0.49.0-alpha]: https://github.com/Automattic/jetpack-search/compare/v0.48.0...v0.49.0-alpha
 [0.48.0]: https://github.com/Automattic/jetpack-search/compare/v0.47.24...v0.48.0
 [0.47.24]: https://github.com/Automattic/jetpack-search/compare/v0.47.23...v0.47.24
 [0.47.23]: https://github.com/Automattic/jetpack-search/compare/v0.47.22...v0.47.23

composer.json

@@ -63,7 +63,7 @@
 			"link-template": "https://github.com/Automattic/jetpack-search/compare/v${old}...v${new}"
 		},
 		"branch-alias": {
-			"dev-trunk": "0.48.x-dev"
+			"dev-trunk": "0.49.x-dev"
 		},
 		"version-constants": {
 			"::VERSION": "src/class-package.php"

src/class-package.php

@@ -11,7 +11,7 @@
  * Search package general information
  */
 class Package {
-	const VERSION = '0.48.1-alpha';
+	const VERSION = '0.49.0-alpha';
 	const SLUG    = 'search';
 
 	/**

src/inline-search/class-inline-search.php

@@ -91,6 +91,7 @@ public function filter__posts_pre_query( $posts, $query ) {
 
 		if ( ! is_array( $this->search_result ) ) {
 			do_action( 'jetpack_search_abort', 'no_search_results_array', $this->search_result );
+
 			return $posts;
 		}
 
@@ -136,6 +137,7 @@ public function filter__posts_pre_query( $posts, $query ) {
 	public function do_search( \WP_Query $query ) {
 		if ( ! $this->should_handle_query( $query ) ) {
 			do_action( 'jetpack_search_abort', 'search_attempted_non_search_query', $query );
+
 			return;
 		}
 
@@ -181,8 +183,8 @@ public function do_search( \WP_Query $query ) {
 		 *
 		 * @since  5.0.0
 		 *
-		 * @param array     $wp_query_args The current query args, in WP_Query format.
-		 * @param \WP_Query $query            The original WP_Query object.
+		 * @param array $wp_query_args The current query args, in WP_Query format.
+		 * @param \WP_Query $query The original WP_Query object.
 		 */
 		$wp_query_args = apply_filters( 'jetpack_search_es_wp_query_args', $wp_query_args, $query );
 
@@ -203,15 +205,17 @@ public function do_search( \WP_Query $query ) {
 		}
 
 		// Convert the WP-style args into ES args.
-		$es_query_args = $this->convert_wp_query_to_api_args( $wp_query_args );
+		$api_query_args = $this->convert_wp_query_to_api_args( $wp_query_args );
+		$api_query_args = $this->trigger_es_query_args_filter( $api_query_args, $query );
+		$api_query_args = $this->trigger_instant_search_query_args_filter( $api_query_args );
 
 		// Only trust ES to give us IDs, not the content since it is a mirror.
-		$es_query_args['fields'] = array(
+		$api_query_args['fields'] = array(
 			'post_id',
 		);
 
 		// Do the actual search query!
-		$this->search_result = $this->search( $es_query_args );
+		$this->search_result = $this->search( $api_query_args );
 
 		if ( is_wp_error( $this->search_result ) || ! is_array( $this->search_result ) || empty( $this->search_result['results'] ) || ! is_array( $this->search_result['results'] ) ) {
 			$this->found_posts = 0;
@@ -331,6 +335,108 @@ public function convert_wp_query_to_api_args( array $args ) {
 		);
 	}
 
+	/**
+	 * Trigger the jetpack_search_es_query_args filter for compatibility with Classic Search.
+	 *
+	 * The arguments can only be simulated, so this is not a 1:1 replacement.
+	 * We support only some modifications, since not all of them are supported by Instant API.
+	 * The goal is to support all common ones.
+	 *
+	 * @param array     $api_query_args Array of API query arguments.
+	 * @param \WP_Query $query The original WP_Query object.
+	 *
+	 * @return array
+	 */
+	private function trigger_es_query_args_filter( array $api_query_args, \WP_Query $query ): array {
+		$es_query_args = array(
+			'blog_id'      => $api_query_args['blog_id'] ?? 1,
+			'size'         => $api_query_args['size'] ?? 10,
+			'from'         => $api_query_args['from'] ?? 0,
+			'sort'         => array(
+				array( '_score' => array( 'order' => 'desc' ) ),
+			),
+			'filter'       => $api_query_args['filter'] ?? array(),
+			'query'        => array(
+				'function_score' => array(
+					'query'      => array(
+						'bool' => array(
+							'must' => array(
+								array(
+									'multi_match' => array(
+										'fields'   => array( 'title.en' ),
+										'query'    => $api_query_args['query'] ?? '',
+										'operator' => 'and',
+									),
+								),
+							),
+						),
+					),
+					'functions'  => array( array( 'gauss' => array( 'date_gmt' => array( 'origin' => '2025-05-13' ) ) ) ),
+					'max_boost'  => 2.0,
+					'score_mode' => 'multiply',
+					'boost_mode' => 'multiply',
+				),
+			),
+			'aggregations' => $api_query_args['aggregations'] ?? array(),
+			'fields'       => $api_query_args['fields'] ?? array(),
+		);
+
+		$es_query_args = apply_filters( 'jetpack_search_es_query_args', $es_query_args, $query );
+
+		if ( ! empty( $es_query_args['aggregations'] ) && is_array( $es_query_args['aggregations'] ) ) {
+			$api_query_args['aggregations'] = $es_query_args['aggregations'];
+		}
+		$api_query_args['filter'] = $es_query_args['filter'] ?? $api_query_args['filter'];
+		$api_query_args['size']   = $es_query_args['size'] ?? $api_query_args['size'];
+		$api_query_args['from']   = $es_query_args['from'] ?? $api_query_args['from'];
+		if ( isset( $es_query_args['query']['bool']['must_not'] ) ) {
+			$api_query_args['filter'] = array(
+				'bool' => array(
+					'must_not' => $es_query_args['query']['bool']['must_not'],
+					'filter'   => array(
+						$api_query_args['filter'],
+					),
+				),
+			);
+		}
+		if ( isset( $es_query_args['query']['bool']['filter'] ) && is_array( $es_query_args['query']['bool']['filter'] ) ) {
+			$new_filter = array(
+				'bool' => array(
+					'filter' => $es_query_args['query']['bool']['filter'],
+				),
+			);
+			if ( ! empty( $api_query_args['filter'] ) ) {
+				$new_filter['bool']['filter'][] = $api_query_args['filter'];
+			}
+			$api_query_args['filter'] = $new_filter;
+		}
+
+		return $api_query_args;
+	}
+
+	/**
+	 * Trigger jetpack_instant_search_options for compatibility with Instant Search.
+	 *
+	 * @param array $api_query_args Array of API query arguments.
+	 *
+	 * @return array
+	 */
+	private function trigger_instant_search_query_args_filter( array $api_query_args ): array {
+		// this will trigger jetpack_instant_search_options filter
+		$options = Helper::generate_initial_javascript_state();
+
+		if ( isset( $options['adminQueryFilter'] ) ) {
+			$api_query_args['filter'] = array(
+				'bool' => array(
+					'filter' => $api_query_args['filter'],
+					'must'   => $options['adminQueryFilter'],
+				),
+			);
+		}
+
+		return $api_query_args;
+	}
+
 	/**
 	 * Return array of languages to search on after executing the dedicated filter.
 	 *
@@ -419,6 +525,7 @@ private function build_es_filters( array $args ): array {
 	protected function instant_api( array $es_args ) {
 		$instant_search                  = new Instant_Search();
 		$instant_search->jetpack_blog_id = $this->jetpack_blog_id;
+
 		return $instant_search->instant_api( $es_args );
 	}