Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
80.99%
690 / 852
60.71%
51 / 84
 CRAP
0.00%
0 / 1
Search_Blocks
80.99%
690 / 852
60.71%
51 / 84
 923.82
0.00%
0 / 1
 init
97.22%
35 / 36
0.00%
0 / 1
 12
 owns_search_results
100.00%
2 / 2
100.00%
1 / 1
 2
 is_tracking_disabled
100.00%
2 / 2
100.00%
1 / 1
 3
 filter__posts_pre_query
100.00%
5 / 5
100.00%
1 / 1
 3
 is_block_template_overlay_enabled
100.00%
3 / 3
100.00%
1 / 1
 2
 is_block_template_overlay_filter_on
100.00%
1 / 1
100.00%
1 / 1
 1
 is_free_plan
100.00%
3 / 3
100.00%
1 / 1
 2
 reset_is_free_plan_cache
0.00%
0 / 1
0.00%
0 / 1
 2
 supports_paid_search
100.00%
4 / 4
100.00%
1 / 1
 3
 set_supports_paid_search_for_testing
100.00%
1 / 1
100.00%
1 / 1
 1
 reset_supports_paid_search_cache
100.00%
1 / 1
100.00%
1 / 1
 1
 woocommerce_blocks_enabled
100.00%
7 / 7
100.00%
1 / 1
 3
 woocommerce_version_supported
100.00%
2 / 2
100.00%
1 / 1
 3
 set_woocommerce_blocks_enabled_for_testing
100.00%
1 / 1
100.00%
1 / 1
 1
 reset_woocommerce_blocks_enabled_cache
100.00%
1 / 1
100.00%
1 / 1
 1
 woocommerce_search_template_override_enabled
100.00%
1 / 1
100.00%
1 / 1
 1
 is_woocommerce_product_search
100.00%
3 / 3
100.00%
1 / 1
 3
 woocommerce_only_block_names
100.00%
7 / 7
100.00%
1 / 1
 1
 is_woocommerce_only_block
100.00%
4 / 4
100.00%
1 / 1
 2
 custom_taxonomy_map
100.00%
1 / 1
100.00%
1 / 1
 1
 resolve_taxonomy_slot
100.00%
1 / 1
100.00%
1 / 1
 1
 reset_custom_taxonomy_map_cache
100.00%
2 / 2
100.00%
1 / 1
 1
 supported_custom_taxonomies
88.89%
16 / 18
0.00%
0 / 1
 4.02
 get_search_param_name
100.00%
3 / 3
100.00%
1 / 1
 3
 enqueue_editor_assets
96.88%
31 / 32
0.00%
0 / 1
 3
 widget_area_hiding_blocks
100.00%
6 / 6
100.00%
1 / 1
 5
 register_block_category
0.00%
0 / 8
0.00%
0 / 1
 12
 register_blocks
0.00%
0 / 10
0.00%
0 / 1
 12
 register_store_script_module
92.31%
12 / 13
0.00%
0 / 1
 3.00
 same_origin_script_module_src
100.00%
19 / 19
100.00%
1 / 1
 8
 inject_filter_checkbox_variations
100.00%
98 / 98
100.00%
1 / 1
 7
 register_patterns
0.00%
0 / 11
0.00%
0 / 1
 42
 pattern_content_from_template
100.00%
5 / 5
100.00%
1 / 1
 3
 get_search_template_content
100.00%
3 / 3
100.00%
1 / 1
 2
 register_search_template
100.00%
13 / 13
100.00%
1 / 1
 4
 should_use_product_overlay
100.00%
2 / 2
100.00%
1 / 1
 2
 get_overlay_template_content
78.57%
11 / 14
0.00%
0 / 1
 7.48
 reset_overlay_template_content_cache
66.67%
2 / 3
0.00%
0 / 1
 3.33
 print_block_template_overlay
0.00%
0 / 19
0.00%
0 / 1
 12
 enqueue_block_template_overlay_assets
0.00%
0 / 21
0.00%
0 / 1
 12
 print_theme_token_sampler
100.00%
3 / 3
100.00%
1 / 1
 3
 block_template_overlay_inline_css
n/a
0 / 0
n/a
0 / 0
 1
 enqueue_search_page_assets
0.00%
0 / 3
0.00%
0 / 1
 6
 enqueue_search_layout_style
0.00%
0 / 5
0.00%
0 / 1
 6
 search_layout_inline_css
n/a
0 / 0
n/a
0 / 0
 1
 get_product_search_template_content
100.00%
3 / 3
100.00%
1 / 1
 2
 substitute_template_placeholders
91.67%
11 / 12
0.00%
0 / 1
 2.00
 resolve_chrome_slugs
100.00%
1 / 1
100.00%
1 / 1
 1
 sync_filters_popover_content
100.00%
8 / 8
100.00%
1 / 1
 5
 find_block_by_name
100.00%
8 / 8
100.00%
1 / 1
 5
 replace_block_inner_content
88.89%
8 / 9
0.00%
0 / 1
 5.03
 replace_block_template
100.00%
5 / 5
100.00%
1 / 1
 3
 register_product_search_template
84.62%
11 / 13
0.00%
0 / 1
 4.06
 get_parent_plugin_slug
100.00%
9 / 9
100.00%
1 / 1
 3
 prepend_search_template
100.00%
14 / 14
100.00%
1 / 1
 5
 route_classic_theme_search_template
92.86%
13 / 14
0.00%
0 / 1
 10.04
 get_classic_theme_search_body
100.00%
4 / 4
100.00%
1 / 1
 2
 get_classic_theme_product_search_body
100.00%
4 / 4
100.00%
1 / 1
 2
 strip_top_level_template_parts
66.67%
2 / 3
0.00%
0 / 1
 2.15
 get_classic_theme_layout_style
n/a
0 / 0
n/a
0 / 0
 1
 set_block_templates_active_for_testing
100.00%
1 / 1
100.00%
1 / 1
 1
 block_templates_active
100.00%
3 / 3
100.00%
1 / 1
 2
 route_woocommerce_product_search_template
100.00%
13 / 13
100.00%
1 / 1
 4
 seed_interactivity_state
0.00%
0 / 6
0.00%
0 / 1
 6
 build_seed_state
100.00%
3 / 3
100.00%
1 / 1
 1
 collect_filter_configs_from_post
78.57%
11 / 14
0.00%
0 / 1
 8.63
 post_content_has_filter_block
100.00%
4 / 4
100.00%
1 / 1
 3
 filter_block_helpers
100.00%
13 / 13
100.00%
1 / 1
 4
 walk_blocks_for_filter_configs
84.62%
11 / 13
0.00%
0 / 1
 7.18
 build_initial_state
100.00%
56 / 56
100.00%
1 / 1
 14
 get_instant_search_query_options
100.00%
1 / 1
100.00%
1 / 1
 1
 build_stock_status_labels
77.78%
7 / 9
0.00%
0 / 1
 4.18
 block_directories
93.33%
14 / 15
0.00%
0 / 1
 8.02
 is_initial_loading
100.00%
10 / 10
100.00%
1 / 1
 4
 reset_initial_loading_cache
66.67%
2 / 3
0.00%
0 / 1
 3.33
 pre_hydration_filter_view
66.67%
10 / 15
0.00%
0 / 1
 3.33
 emit_filter_wrapper_context
90.00%
9 / 10
0.00%
0 / 1
 2.00
 normalize_display_style
100.00%
1 / 1
100.00%
1 / 1
 2
 build_initial_strings
51.35%
19 / 37
0.00%
0 / 1
 4.04
 build_ai_extended_loading_hints
51.43%
18 / 35
0.00%
0 / 1
 2.46
 parse_url_search_query
100.00%
5 / 5
100.00%
1 / 1
 2
 has_search_param
100.00%
2 / 2
100.00%
1 / 1
 2
 parse_url_sort
100.00%
10 / 10
100.00%
1 / 1
 3
 parse_url_price_range
91.67%
11 / 12
0.00%
0 / 1
 7.03
 parse_price_bound
77.78%
7 / 9
0.00%
0 / 1
 7.54
 parse_url_filters
96.77%
30 / 31
0.00%
0 / 1
 10
 parse_url_filter_logic
43.75%
7 / 16
0.00%
0 / 1
 27.80
1<?php
2/**
3 * Search Blocks: Interactivity API block registration and state initialization.
4 *
5 * @package automattic/jetpack-search
6 */
7
8namespace Automattic\Jetpack\Search;
9
10use Automattic\Jetpack\Status;
11
12/**
13 * Registers Jetpack Search Interactivity API blocks and initializes their shared state.
14 */
15class Search_Blocks {
16
17    /**
18     * Reserved query params (mirrors `RESERVED_PARAMS` in `store/url-state.js`).
19     * `s` is the WP search route key; `q` is what the inline blocks use on
20     * non-search pages (see `get_search_param_name()`). Neither may be parsed as a filter key.
21     */
22    const RESERVED_QUERY_PARAMS = array( 's', 'q', 'orderby', 'min_price', 'max_price' );
23
24    /**
25     * Query-string param for inline search on non-search pages (e.g. `/about/?q=boots`).
26     * Not `s`, because on singular pages WP's `WP_Query::get_posts()` AND's a
27     * `post_content LIKE` clause into the lookup and 404s on refresh. See
28     * `docs/explorations/embedded-search-refresh-404.md` (RSM-1754).
29     */
30    const NON_SEARCH_QUERY_PARAM = 'q';
31
32    /**
33     * Jetpack Search page template slug. Distinct from WP's `search` slug so a
34     * block theme's `search.html` doesn't dedupe ours; `search_template_hierarchy`
35     * prepends this slug so it still wins on `/?s=...`.
36     */
37    const SEARCH_TEMPLATE_SLUG = 'jetpack-search';
38
39    /**
40     * Jetpack product-search template slug. Separate from `SEARCH_TEMPLATE_SLUG`
41     * so it gets its own Site Editor entry.
42     */
43    const PRODUCT_SEARCH_TEMPLATE_SLUG = 'jetpack-search-product-results';
44
45    /**
46     * Mirror of `ProductSearchResultsTemplate::SLUG`, inlined to avoid a hard
47     * dependency on the WooCommerce class.
48     */
49    const WC_PRODUCT_SEARCH_TEMPLATE_SLUG = 'product-search-results';
50
51    /**
52     * Lowest WC version that registers the `product-search-results` template
53     * (WC 6.5 bundled WC Blocks 7.4, the release that first added it). Below
54     * this, WC-only Search features have nothing to front and the gate stays closed.
55     */
56    const MIN_WOOCOMMERCE_VERSION = '6.5.0';
57
58    /**
59     * Per-request memo for `is_initial_loading()`. Lifted out of a method-local
60     * `static` so tests can clear it via `reset_initial_loading_cache()`;
61     * otherwise URL state from the first test leaks into subsequent ones.
62     *
63     * @var bool|null
64     */
65    private static $is_initial_loading_cache = null;
66
67    /**
68     * Per-request memo for `get_overlay_template_content()`, keyed `default` /
69     * `product`. Lifted out of a method-local `static` so tests can clear it via
70     * `reset_overlay_template_content_cache()` — otherwise a CPT-customized
71     * overlay saved mid-test would be pinned by an earlier bundled-file read.
72     *
73     * @var array<string,string>
74     */
75    private static $overlay_template_content_cache = array();
76
77    /**
78     * Per-request memo for `is_free_plan()`. Avoids the cold-cache hazard where
79     * `Plan::get_plan_info()` falls back to a synchronous WPCOM HTTP call —
80     * render callbacks hit the plan gate on every inner render.
81     *
82     * @var bool|null
83     */
84    private static $is_free_plan_cache = null;
85
86    /**
87     * Per-request memo for `supports_paid_search()`. Separate from
88     * `is_free_plan_cache` because the two answers can disagree: a site with
89     * no plan info is neither on the free plan nor on a paid one.
90     *
91     * @var bool|null
92     */
93    private static $supports_paid_search_cache = null;
94
95    /**
96     * Per-request memo for `woocommerce_blocks_enabled()`. Centralized so every
97     * gate (registration, render, editor config, IA store seed) shares one probe.
98     *
99     * @var bool|null
100     */
101    private static $woocommerce_blocks_enabled_cache = null;
102
103    /**
104     * Per-request memo for `supported_custom_taxonomies()`. Derived from the
105     * Sync allowlist intersected with registered taxonomies and unioned with
106     * the map's user-facing keys — same inputs every request.
107     *
108     * @var string[]|null
109     */
110    private static $supported_custom_taxonomies_cache = null;
111
112    /**
113     * Cached rendered overlay-template HTML. Filled during `wp_enqueue_scripts`
114     * so the embedded blocks' view-module enqueues land before
115     * `wp_print_import_map()` (footer priority 1) — see AGENTS.md
116     * § Hydration & SSR seeding.
117     *
118     * @var string|null
119     */
120    private static $block_template_overlay_rendered_html = null;
121
122    /**
123     * Register block types and hook into WordPress.
124     *
125     * Two gates apply: the caller (`Initializer`) gates everything behind the
126     * `jetpack_search_blocks_enabled` feature flag, and within this method the
127     * template-takeover surface (registering the Search template and prepending
128     * it to `search_template_hierarchy`) is additionally gated on the saved
129     * experience being `'embedded'` — only Embedded should override the theme's
130     * `search.html`. Block registration, editor assets, and IA state seeding
131     * always run so blocks inserted anywhere (post content, widgets, custom
132     * templates) get their base seed.
133     */
134    public static function init() {
135        add_action( 'init', array( static::class, 'register_blocks' ) );
136        add_filter( 'block_categories_all', array( static::class, 'register_block_category' ) );
137        add_action( 'enqueue_block_editor_assets', array( static::class, 'enqueue_editor_assets' ) );
138        add_action( 'wp_body_open', array( static::class, 'print_theme_token_sampler' ) );
139        // Relativize `jetpack-search/*` Script Module URLs whose host matches
140        // the site canonical so the rendered `<script type="module">` is
141        // same-origin with the page. ES modules go through CORS even without
142        // a `crossorigin` attribute, and `wp-content/*` typically lacks the
143        // `Access-Control-Allow-Origin` header — see
144        // `same_origin_script_module_src()`.
145        add_filter( 'script_module_loader_src', array( static::class, 'same_origin_script_module_src' ), 10, 2 );
146        Custom_Taxonomy_Slot_Mapping::init();
147        // Both hooks needed; see AGENTS.md § Hydration & SSR seeding.
148        add_action( 'template_redirect', array( static::class, 'seed_interactivity_state' ) );
149        add_action( 'wp_enqueue_scripts', array( static::class, 'seed_interactivity_state' ) );
150
151        $experience = ( new Module_Control() )->get_experience();
152
153        if ( Module_Control::EXPERIENCE_EMBEDDED === $experience ) {
154            if ( static::block_templates_active() ) {
155                // Block themes: register the template and front it via the FSE hierarchy filter.
156                add_action( 'init', array( static::class, 'register_search_template' ) );
157                add_filter( 'search_template_hierarchy', array( static::class, 'prepend_search_template' ) );
158                add_action( 'wp_enqueue_scripts', array( static::class, 'enqueue_search_page_assets' ) );
159                Theme_Chrome_Slug_Resolver::register_hooks();
160            } else {
161                // Classic themes: no FSE hierarchy to prepend to, so swap the
162                // resolved template path via `template_include`. The block markup
163                // renders inside the theme's `get_header()`/`get_footer()`.
164                //
165                // Priority 20: WooCommerce's `WC_Template_Loader::template_loader`
166                // hooks at priority 10 and rewrites the path to `archive-product.php`
167                // on product-archive requests — that includes product search. We
168                // need to run *after* WC so the override actually sticks; running
169                // at 10 (same priority, later registration) is order-of-load
170                // dependent. Higher priorities (anything > 20 used by chrome
171                // filters) aren't relevant — nothing else swaps the path.
172                add_filter( 'template_include', array( static::class, 'route_classic_theme_search_template' ), 20 );
173                // No Site Editor entry on classic themes; the singleton CPTs give
174                // authors the standard block editor on hidden posts instead. Both
175                // init regardless of the WooCommerce override option so admins can
176                // pre-customize either template before activating the relevant
177                // surface — matching `Search_Template`'s "expose URLs before
178                // activation" rule. The override option still gates the actual
179                // front-end render path in `route_classic_theme_search_template()`.
180                Search_Template::init();
181                Product_Search_Template::init();
182            }
183        }
184
185        // Inline on a classic theme: the theme renders regular searches, but a
186        // WooCommerce product search can still be routed to the Jetpack product
187        // shim. `route_classic_theme_search_template()` is product-only for
188        // Inline (it bails on regular searches unless Embedded); the block-theme
189        // Inline path is covered by the `search_template_hierarchy` route below.
190        // Init the product CPT regardless of the override so admins can
191        // pre-customize it (expose-before-activation, as in the Embedded branch).
192        if (
193            Module_Control::EXPERIENCE_INLINE === $experience
194            && ! static::block_templates_active()
195        ) {
196            add_filter( 'template_include', array( static::class, 'route_classic_theme_search_template' ), 20 );
197            Product_Search_Template::init();
198        }
199
200        // Blocks render results client-side, so the server-side search is wasted work.
201        // (Classic/Instant init is also suppressed in `Initializer::init_search_blocks()`.)
202        if ( ! is_admin() && static::owns_search_results() ) {
203            add_filter( 'posts_pre_query', array( static::class, 'filter__posts_pre_query' ), 10, 2 );
204        }
205
206        // Priority 20: after WC's priority-10 prepend so the result is load-order
207        // independent. Gated to server-rendered experiences (Embedded / Inline) —
208        // Overlay intercepts client-side, and a stale option from a since-switched
209        // experience must not keep rerouting the template hierarchy.
210        if (
211            static::woocommerce_search_template_override_enabled()
212            && in_array( $experience, array( Module_Control::EXPERIENCE_EMBEDDED, Module_Control::EXPERIENCE_INLINE ), true )
213        ) {
214            add_action( 'init', array( static::class, 'register_product_search_template' ) );
215            add_filter( 'search_template_hierarchy', array( static::class, 'route_woocommerce_product_search_template' ), 20 );
216            // Inline experience doesn't go through the EMBEDDED branch above, so
217            // hook the page-template CSS enqueue here too. Idempotent on EMBEDDED
218            // — `add_action` dedupes same callback at same priority.
219            add_action( 'wp_enqueue_scripts', array( static::class, 'enqueue_search_page_assets' ) );
220        }
221
222        // Two-tier gate: register the editable template CPT + admin-init editor
223        // handler whenever the operator filter is on, so admins can edit the
224        // overlay template *before* opting into the blocks Overlay experience
225        // (e.g. preview the editor from the Beta card while the preact Overlay
226        // is still the active arm — without this split, the editorUrl seeded
227        // into the React initial state at page load would be null and the
228        // link would become a no-op once the user switched to the Beta card
229        // without a page refresh). The front-end render hooks stay gated on
230        // the active experience — they only paint the overlay when the user
231        // has actually committed to it.
232        if ( static::is_block_template_overlay_filter_on() ) {
233            Overlay_Template::init();
234            // The product overlay only renders on a Woo store, so its editable
235            // CPT is pointless off Woo. Init regardless of the override option
236            // (parity with `Product_Search_Template`) so admins can pre-customize
237            // before flipping it on; the front-end render path stays gated by
238            // the override option in `should_use_product_overlay()`.
239            if ( static::woocommerce_blocks_enabled() ) {
240                Product_Overlay_Template::init();
241            }
242        }
243        if ( static::is_block_template_overlay_enabled() ) {
244            add_action( 'wp_enqueue_scripts', array( static::class, 'enqueue_block_template_overlay_assets' ) );
245            add_action( 'wp_footer', array( static::class, 'print_block_template_overlay' ) );
246        }
247    }
248
249    /**
250     * Whether the Search blocks own the front-end search results for the active
251     * experience, meaning the server should run no search of its own.
252     *
253     * True for Embedded (the blocks template takes over the search page) and for
254     * the enabled blocks Overlay (a full-screen modal over the theme's search
255     * page). The Overlay arm goes through `is_block_template_overlay_enabled()`
256     * — operator filter plus saved experience — so a stale `overlay_blocks`
257     * option can't keep suppressing server search after the overlay is turned
258     * off. Drives both the Classic/Instant init suppression in
259     * `Initializer::init_search_blocks()` and the `posts_pre_query` short-circuit
260     * registered in `init()`.
261     *
262     * @return bool
263     */
264    public static function owns_search_results(): bool {
265        return Module_Control::EXPERIENCE_EMBEDDED === ( new Module_Control() )->get_experience()
266            || static::is_block_template_overlay_enabled();
267    }
268
269    /**
270     * Whether TrainTracks analytics are suppressed for this request. Mirrors
271     * instant search (Helper::get_search_options): the `?disable_tracking=1`
272     * crawler/QA param plus the `jetpack_instant_search_disable_tracking`
273     * operator filter. Gates both the `_tkq` pushes (seeded into
274     * `state.disableTracking`) and whether the Tracks consumer script loads.
275     *
276     * @return bool
277     */
278    public static function is_tracking_disabled(): bool {
279        return ( class_exists( Helper::class ) && Helper::is_tracking_disabled() )
280            || apply_filters( 'jetpack_instant_search_disable_tracking', false );
281    }
282
283    /**
284     * Short-circuit the main front-end search query when the blocks own results
285     * (see AGENTS.md § Search experiences). Registered only when
286     * `owns_search_results()` is true and off `is_admin()`.
287     *
288     * Pagination totals are set to `1` (not `0`) so `have_posts()`-gated
289     * templates still render the shell the client hydrates — WP core skips
290     * `set_found_posts()` when `posts_pre_query` returns an array.
291     *
292     * @param array|null $posts Posts to return in place of the query (null by default).
293     * @param \WP_Query  $query The WP_Query being filtered.
294     * @return array|null Empty array to short-circuit, or $posts to let it run.
295     */
296    public static function filter__posts_pre_query( $posts, $query ) {
297        if ( ! $query->is_main_query() || ! $query->is_search() ) {
298            return $posts;
299        }
300
301        $query->found_posts   = 1;
302        $query->max_num_pages = 1;
303
304        return array();
305    }
306
307    /**
308     * Whether to replace the legacy instant-search overlay with the
309     * server-rendered Search blocks template
310     * (`templates/jetpack-search-overlay.html`).
311     *
312     * Two conditions: the operator filter `is_block_template_overlay_filter_on()`
313     * is on (defaults true), AND the site owner has chosen
314     * `Module_Control::EXPERIENCE_OVERLAY_BLOCKS` in the dashboard. When both
315     * hold, the legacy `SearchApp` is bypassed via
316     * `jetpack_search_init_instant_search` in `Initializer::init_search_blocks()`.
317     *
318     * @return bool
319     */
320    public static function is_block_template_overlay_enabled(): bool {
321        if ( ! static::is_block_template_overlay_filter_on() ) {
322            return false;
323        }
324        return Module_Control::EXPERIENCE_OVERLAY_BLOCKS === ( new Module_Control() )->get_experience();
325    }
326
327    /**
328     * Whether the operator filter that exposes the blocks-powered overlay is on.
329     *
330     * Lighter than `is_block_template_overlay_enabled()` — doesn't require the
331     * user to have opted into the new overlay. Use for one-time setup that
332     * should run *before* opt-in (e.g. registering the editable template CPT
333     * so admins can preview the editor while preact Overlay is still active).
334     *
335     * @return bool
336     */
337    public static function is_block_template_overlay_filter_on(): bool {
338        /**
339         * Opt out of the experimental Search blocks overlay. Available by
340         * default; return false to hide the Beta card from the Experience
341         * Selector and disable the editable-template CPT.
342         *
343         * @param bool $enabled Default true.
344         */
345        return (bool) apply_filters( 'jetpack_search_overlay_block_template_enabled', true );
346    }
347
348    /**
349     * Memoized `Plan::is_free_plan()`. See `$is_free_plan_cache`.
350     *
351     * @return bool
352     */
353    public static function is_free_plan(): bool {
354        if ( null === self::$is_free_plan_cache ) {
355            self::$is_free_plan_cache = ( new Plan() )->is_free_plan();
356        }
357        return self::$is_free_plan_cache;
358    }
359
360    /**
361     * Reset the `is_free_plan()` memo. Tests only.
362     */
363    public static function reset_is_free_plan_cache() {
364        self::$is_free_plan_cache = null;
365    }
366
367    /**
368     * Whether the site has a paid Jetpack Search subscription. Paid-only block
369     * surfaces (AI Answer) call this on every render.
370     *
371     * Both probes are needed: `supports_instant_search()` is true on the free
372     * Search plan too ("plan supports the feature"), so it alone would let free
373     * through. `! is_free_plan()` excludes free + forced-free; `supports_instant_search()`
374     * excludes the no-plan case (which `is_free_plan()` returns false for).
375     *
376     * No `apply_filters()` wrapper by design — a filter that any plugin could
377     * flip would defeat a paid-feature gate. Tests bypass via
378     * `set_supports_paid_search_for_testing()`.
379     *
380     * @return bool
381     */
382    public static function supports_paid_search(): bool {
383        if ( null === self::$supports_paid_search_cache ) {
384            $plan                             = new Plan();
385            self::$supports_paid_search_cache = $plan->supports_instant_search() && ! $plan->is_free_plan();
386        }
387        return self::$supports_paid_search_cache;
388    }
389
390    /**
391     * Force the `supports_paid_search()` answer — tests only. Pass `null` to clear.
392     *
393     * @internal
394     * @param bool|null $value Forced answer or null to clear.
395     */
396    public static function set_supports_paid_search_for_testing( ?bool $value ): void {
397        self::$supports_paid_search_cache = $value;
398    }
399
400    /**
401     * Reset the `supports_paid_search()` memo. Tests only.
402     *
403     * @internal
404     */
405    public static function reset_supports_paid_search_cache(): void {
406        self::$supports_paid_search_cache = null;
407    }
408
409    /**
410     * Whether Jetpack Search exposes its WooCommerce-only blocks, filter
411     * variations, and render paths. See AGENTS.md § WooCommerce gating.
412     *
413     * **Load-order contract:** call at or after `plugins_loaded`. WC includes
414     * its main class during `plugins_loaded`, so an earlier call returns false
415     * on a WC site. Existing callers all fire later (`enqueue_block_editor_assets`,
416     * `template_redirect`, `wp_enqueue_scripts`, block render).
417     *
418     * @return bool
419     */
420    public static function woocommerce_blocks_enabled(): bool {
421        if ( null === self::$woocommerce_blocks_enabled_cache ) {
422            // `false` second arg: skip the autoloader on non-Woo sites — this
423            // gate is hit on every request and autoloader work would be wasted.
424            $probed = class_exists( 'WooCommerce', false ) && self::woocommerce_version_supported();
425
426            /**
427             * Whether Jetpack Search exposes its WooCommerce-only blocks,
428             * filter variations, and render paths. Default is the
429             * `class_exists( 'WooCommerce', false )` probe AND a minimum
430             * WooCommerce version check.
431             *
432             * @since 0.59.0
433             *
434             * @param bool $enabled Defaults to the WooCommerce class + version probe.
435             */
436            self::$woocommerce_blocks_enabled_cache = (bool) apply_filters(
437                'jetpack_search_woocommerce_blocks_enabled',
438                $probed
439            );
440        }
441        return self::$woocommerce_blocks_enabled_cache;
442    }
443
444    /**
445     * Whether the active WooCommerce is at `MIN_WOOCOMMERCE_VERSION` or newer.
446     * Older or absent WooCommerce reads as unsupported.
447     *
448     * @since 7.1.0
449     *
450     * @param string|null $version WooCommerce version to test; defaults to the
451     *   live `WC_VERSION` constant. Override is for tests pinning a version.
452     * @return bool
453     */
454    public static function woocommerce_version_supported( ?string $version = null ): bool {
455        // `constant()` keeps static analysis happy — WC isn't a dependency here.
456        $version ??= ( defined( 'WC_VERSION' ) ? (string) constant( 'WC_VERSION' ) : '' );
457        return '' !== $version && version_compare( $version, self::MIN_WOOCOMMERCE_VERSION, '>=' );
458    }
459
460    /**
461     * Force the `woocommerce_blocks_enabled()` answer to a specific boolean —
462     * tests only. Pass `null` to clear the override and revive the real
463     * `class_exists()` probe (also done by `reset_woocommerce_blocks_enabled_cache()`).
464     *
465     * @internal
466     *
467     * @param bool|null $value Forced answer or null to clear.
468     */
469    public static function set_woocommerce_blocks_enabled_for_testing( ?bool $value ): void {
470        self::$woocommerce_blocks_enabled_cache = $value;
471    }
472
473    /**
474     * Reset the `woocommerce_blocks_enabled()` memo. Tests only.
475     *
476     * @internal
477     */
478    public static function reset_woocommerce_blocks_enabled_cache(): void {
479        self::$woocommerce_blocks_enabled_cache = null;
480    }
481
482    /**
483     * The `jetpack_search_override_woocommerce_search_template` opt-in
484     * (default off), set from the Search dashboard.
485     *
486     * @return bool
487     */
488    public static function woocommerce_search_template_override_enabled(): bool {
489        return (bool) get_option( 'jetpack_search_override_woocommerce_search_template', false );
490    }
491
492    /**
493     * Whether the current request is a WooCommerce product search — a search
494     * query scoped to the `product` post-type archive on a Woo-enabled site.
495     *
496     * Theme-agnostic. Block-theme-only behavior (FSE hierarchy work) gates on
497     * {@see block_templates_active()} at the call site so this predicate also
498     * drives the classic-theme product shim. Public to keep the WC-gating
499     * surface (see AGENTS.md § WooCommerce gating) discoverable from outside
500     * the class; the in-class callers are `route_classic_theme_search_template()`
501     * and `route_woocommerce_product_search_template()`.
502     *
503     * @return bool
504     */
505    public static function is_woocommerce_product_search(): bool {
506        return self::woocommerce_blocks_enabled()
507            && is_search()
508            && is_post_type_archive( 'product' );
509    }
510
511    /**
512     * Canonical list of WooCommerce-only block names. Single source of truth
513     * for the WC gate across registration, helpers, and editor bundle — see
514     * AGENTS.md § WooCommerce gating. Add an entry and every gate picks it up.
515     *
516     * @return string[]
517     */
518    public static function woocommerce_only_block_names(): array {
519        return array(
520            'jetpack-search/filter-wc-attribute',
521            'jetpack-search/filter-wc-price',
522            'jetpack-search/filter-wc-rating',
523            'jetpack-search/filter-wc-stock-status',
524            'jetpack-search/filters-product',
525        );
526    }
527
528    /**
529     * Whether a block name belongs to a WooCommerce-only block. Accepts either
530     * the full namespaced name or a bare directory basename (the registration
531     * loop walks basenames; helpers and editor hold full names).
532     *
533     * @param string $block_name Full block name (`jetpack-search/filter-wc-rating`)
534     *                           or bare directory basename (`filter-wc-rating`).
535     * @return bool
536     */
537    public static function is_woocommerce_only_block( string $block_name ): bool {
538        $candidate = false === strpos( $block_name, '/' )
539            ? 'jetpack-search/' . $block_name
540            : $block_name;
541        return in_array( $candidate, self::woocommerce_only_block_names(), true );
542    }
543
544    /**
545     * Built-in taxonomies that have dedicated filter-checkbox variations.
546     * Excluded from the "Custom Taxonomy" picker so authors reach for the
547     * dedicated variation. Mirrors `BUILT_IN_TAXONOMY_SLUGS` in
548     * `filter-checkbox/edit.js` — must stay in lockstep.
549     *
550     * @var string[]
551     */
552    const BUILT_IN_CUSTOM_TAXONOMY_EXCLUSIONS = array(
553        'category',
554        'post_tag',
555        'product_cat',
556        'product_tag',
557        'product_brand',
558    );
559
560    /**
561     * Back-compat proxy for `Custom_Taxonomy_Slot_Mapping::get_map()`.
562     *
563     * @return array<string, string>
564     */
565    public static function custom_taxonomy_map(): array {
566        return Custom_Taxonomy_Slot_Mapping::get_map();
567    }
568
569    /**
570     * Back-compat proxy for `Custom_Taxonomy_Slot_Mapping::resolve_slot()`.
571     *
572     * @param string $taxonomy User-facing taxonomy slug.
573     * @return string Effective ES field slug.
574     */
575    public static function resolve_taxonomy_slot( string $taxonomy ): string {
576        return Custom_Taxonomy_Slot_Mapping::resolve_slot( $taxonomy );
577    }
578
579    /**
580     * Reset both the slot-mapping and `supported_custom_taxonomies()` memos. Tests only.
581     *
582     * @internal
583     */
584    public static function reset_custom_taxonomy_map_cache(): void {
585        Custom_Taxonomy_Slot_Mapping::reset_cache_for_testing();
586        self::$supported_custom_taxonomies_cache = null;
587    }
588
589    /**
590     * Custom-taxonomy slugs the "Custom Taxonomy" filter variation offers.
591     *
592     * Supported when registered locally AND either (a) in the Jetpack Search
593     * indexable allowlist (`Sync\Modules\Search::get_all_taxonomies()`, so
594     * aggregations actually return buckets) or (b) a key in `custom_taxonomy_map()`
595     * (queries route through a reserved slot). Built-ins with dedicated variations
596     * are stripped. The Sync `class_exists` guard is defensive — partial installs
597     * fall back to "map keys only".
598     *
599     * @return string[] Distinct, zero-indexed list of supported taxonomy slugs.
600     */
601    public static function supported_custom_taxonomies(): array {
602        if ( null !== self::$supported_custom_taxonomies_cache ) {
603            return self::$supported_custom_taxonomies_cache;
604        }
605
606        // Public taxonomies only — the editor's `core.getTaxonomies()` only returns
607        // REST-visible ones, and a private taxonomy in the Sync allowlist shouldn't surface.
608        $registered = function_exists( 'get_taxonomies' )
609            ? array_values( get_taxonomies( array( 'public' => true ), 'names' ) )
610            : array();
611
612        $indexed = class_exists( '\\Automattic\\Jetpack\\Sync\\Modules\\Search' )
613            ? \Automattic\Jetpack\Sync\Modules\Search::get_all_taxonomies()
614            : array();
615
616        $map_keys = array_keys( self::custom_taxonomy_map() );
617
618        $candidates = array_unique( array_merge( $indexed, $map_keys ) );
619        $supported  = array_values(
620            array_diff(
621                array_values( array_intersect( $registered, $candidates ) ),
622                self::BUILT_IN_CUSTOM_TAXONOMY_EXCLUSIONS
623            )
624        );
625
626        self::$supported_custom_taxonomies_cache = $supported;
627        return $supported;
628    }
629
630    /**
631     * URL param key the inline search experience uses for the current request.
632     * On the WP search route `s`; elsewhere `q` (see `NON_SEARCH_QUERY_PARAM`).
633     *
634     * Uses direct property access on `$wp_query` rather than the `is_search()`
635     * global function, because the function calls `_doing_it_wrong()` when
636     * invoked before the query has finished running (e.g. during block render).
637     *
638     * @return string
639     */
640    public static function get_search_param_name(): string {
641        global $wp_query;
642        if ( isset( $wp_query ) && ! empty( $wp_query->is_search ) ) {
643            return 's';
644        }
645        return self::NON_SEARCH_QUERY_PARAM;
646    }
647
648    /**
649     * Enqueue the client-side block registration bundle in the block editor.
650     *
651     * WP bootstraps server-side block metadata into the editor, but each block
652     * still needs a client-side `registerBlockType()` call so the editor knows
653     * how to render a preview. This script does that with ServerSideRender.
654     */
655    public static function enqueue_editor_assets() {
656        $base_path  = Package::get_installed_path() . 'build/search-blocks-editor/';
657        $asset_file = $base_path . 'register-blocks.asset.php';
658        if ( ! file_exists( $asset_file ) ) {
659            return;
660        }
661        $asset = require $asset_file;
662
663        // `plugins_url()` resolves against the nearest plugin directory, which
664        // handles the `jetpack_vendor` location Composer installs into.
665        $url = plugins_url( 'register-blocks.js', $base_path . 'register-blocks.js' );
666
667        wp_enqueue_script(
668            'jetpack-search-blocks-register',
669            $url,
670            $asset['dependencies'] ?? array(),
671            $asset['version'] ?? false,
672            true
673        );
674        wp_set_script_translations( 'jetpack-search-blocks-register', 'jetpack-search-pkg' );
675
676        // Surface PHP gates to the editor bundle so block edits and the
677        // registration loop branch consistently with server-side renders.
678        // `wp_add_inline_script` (not `wp_localize_script`) per core #25280 —
679        // the latter HTML-encodes ampersands inside nested values.
680        wp_add_inline_script(
681            'jetpack-search-blocks-register',
682            'window.JetpackSearchBlocksConfig = ' . wp_json_encode(
683                array(
684                    'isWooCommerceBlocksEnabled' => self::woocommerce_blocks_enabled(),
685                    'woocommerceOnlyBlocks'      => self::woocommerce_only_block_names(),
686                    'supportsPaidSearch'         => self::supports_paid_search(),
687                    'aiMasterEnabled'            => AI_Answers::host_allows_ai() && AI_Answers::is_master_enabled(),
688                    'supportedCustomTaxonomies'  => self::supported_custom_taxonomies(),
689                    'customTaxonomyMap'          => (object) self::custom_taxonomy_map(),
690                    // Resolved the same way `search-results/render.php` resolves the
691                    // live value, so the editor placeholder never claims a default
692                    // visitors won't actually get.
693                    'defaultResultsPerPage'      => Helper::resolve_results_per_page(),
694                    'maxResultsPerPage'          => Helper::get_max_posts_per_page(),
695                    'hideFromWidgetArea'         => self::widget_area_hiding_blocks(),
696                ),
697                JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP
698            ) . ';',
699            'before'
700        );
701    }
702
703    /**
704     * The widget area whose inserter must not offer the Search blocks, if the current screen edits widgets.
705     *
706     * The legacy Overlay's sidebar renders on `wp_footer`, after a block theme has printed the importmap, so a block's view module can't resolve `jetpack-search/store` and never hydrates.
707     *
708     * @since 8.2.0
709     *
710     * @return string|null Sidebar ID, or null when no area needs hiding.
711     */
712    public static function widget_area_hiding_blocks(): ?string {
713        if ( ! is_registered_sidebar( Instant_Search::INSTANT_SEARCH_SIDEBAR ) || ! function_exists( 'get_current_screen' ) ) {
714            return null;
715        }
716        $screen = get_current_screen();
717        if ( ! $screen || ! in_array( $screen->id, array( 'widgets', 'customize' ), true ) ) {
718            return null;
719        }
720        return Instant_Search::INSTANT_SEARCH_SIDEBAR;
721    }
722
723    /**
724     * Add a "Jetpack Search" block category so our blocks appear under that
725     * heading in the inserter instead of "Uncategorized".
726     *
727     * @param array $categories Existing block categories.
728     * @return array
729     */
730    public static function register_block_category( $categories ) {
731        foreach ( $categories as $category ) {
732            if ( 'jetpack-search' === ( $category['slug'] ?? '' ) ) {
733                return $categories;
734            }
735        }
736        $categories[] = array(
737            'slug'  => 'jetpack-search',
738            'title' => __( 'Jetpack Search', 'jetpack-search-pkg' ),
739        );
740        return $categories;
741    }
742
743    /**
744     * Register all search blocks from their block.json files.
745     */
746    public static function register_blocks() {
747        // Register block pattern category first so patterns can reference it.
748        if ( function_exists( 'register_block_pattern_category' ) ) {
749            register_block_pattern_category(
750                'jetpack-search',
751                array( 'label' => __( 'Jetpack Search', 'jetpack-search-pkg' ) )
752            );
753        }
754
755        self::register_store_script_module();
756
757        foreach ( self::block_directories() as $block_dir ) {
758            register_block_type( $block_dir );
759        }
760
761        add_filter( 'get_block_type_variations', array( static::class, 'inject_filter_checkbox_variations' ), 10, 2 );
762        static::register_patterns();
763    }
764
765    /**
766     * Register the shared store as the `jetpack-search/store` Script Module.
767     * See AGENTS.md § Shared store / bundles for why this is externalized.
768     */
769    public static function register_store_script_module() {
770        if ( ! function_exists( 'wp_register_script_module' ) ) {
771            return;
772        }
773
774        $base_path  = Package::get_installed_path() . 'build/search-blocks/store/';
775        $asset_file = $base_path . 'index.asset.php';
776        if ( ! file_exists( $asset_file ) ) {
777            return;
778        }
779        $asset = require $asset_file;
780
781        wp_register_script_module(
782            'jetpack-search/store',
783            plugins_url( 'index.js', $base_path . 'index.js' ),
784            $asset['dependencies'] ?? array(),
785            $asset['version'] ?? false
786        );
787    }
788
789    /**
790     * Relativize Jetpack Search Script Module URLs so the browser fetches them
791     * same-origin with the page.
792     *
793     * `wp_register_script_module()` resolves src via `plugins_url()`, which
794     * returns the canonical `site_url()` host. When a visitor is on a
795     * different host (Multisite mapped domains, www vs non-www without a
796     * canonical redirect, asset-offload plugins, reverse-proxy staging) the
797     * `<script type="module">` becomes cross-origin and is blocked with
798     * `MissingAllowOriginHeader` — ES modules always go through the CORS
799     * algorithm, even without a `crossorigin` attribute, and typical WP
800     * hosts don't send `Access-Control-Allow-Origin` for `wp-content/*`.
801     *
802     * Stripping scheme + host with `wp_make_link_relative()` lets the browser
803     * resolve against the page's actual origin. No `$_SERVER['HTTP_HOST']`
804     * trust — emitting an attacker-controllable host into a `<script src>`
805     * would be a cache-poisoning vector.
806     *
807     * No-op when the src host is a deliberately external host (CDN that
808     * doesn't match `home_url()`/`site_url()`); operators of those setups
809     * configure CORS on the CDN themselves.
810     *
811     * Identifier gate covers both shapes Jetpack Search ships: directly-
812     * registered modules with a slash (`jetpack-search/store`,
813     * `jetpack-search/overlay-bootstrap`) and the per-block view modules
814     * WP auto-registers from `block.json`'s `viewScriptModule`, which run
815     * `generate_block_asset_handle()` and emit hyphen-joined IDs like
816     * `jetpack-search-results-list-view-script-module`.
817     *
818     * @param string $src        Module src URL.
819     * @param string $identifier Module identifier (e.g. `jetpack-search/results-list`
820     *                           or `jetpack-search-results-list-view-script-module`).
821     * @return string Relativized src on match, original otherwise.
822     */
823    public static function same_origin_script_module_src( $src, $identifier ) {
824        if ( ! is_string( $src ) || '' === $src || ! is_string( $identifier ) ) {
825            return $src;
826        }
827        if ( 0 !== strpos( $identifier, 'jetpack-search/' ) && 0 !== strpos( $identifier, 'jetpack-search-' ) ) {
828            return $src;
829        }
830
831        $src_host = wp_parse_url( $src, PHP_URL_HOST );
832        if ( ! $src_host ) {
833            return $src;
834        }
835
836        $canonical_hosts = array_map(
837            'strtolower',
838            array_filter(
839                array(
840                    wp_parse_url( home_url(), PHP_URL_HOST ),
841                    wp_parse_url( site_url(), PHP_URL_HOST ),
842                )
843            )
844        );
845
846        if ( ! in_array( strtolower( $src_host ), $canonical_hosts, true ) ) {
847            return $src;
848        }
849
850        return wp_make_link_relative( $src );
851    }
852
853    /**
854     * Inject named block variations for the filter-checkbox block.
855     *
856     * Uses the `get_block_type_variations` filter (WP 6.5+) rather than
857     * `register_block_variation()` — the latter is JS-only and has no PHP
858     * equivalent. Variation names + default attributes mirror the
859     * instant-search overlay so both surfaces describe the same filters.
860     *
861     * @param array          $variations Variations registered on the block type.
862     * @param \WP_Block_Type $block_type Block type the filter is being applied to.
863     * @return array
864     */
865    public static function inject_filter_checkbox_variations( $variations, $block_type ) {
866        if ( ! isset( $block_type->name ) || 'jetpack-search/filter-checkbox' !== $block_type->name ) {
867            return $variations;
868        }
869
870        $additions = array(
871            array(
872                'name'        => 'category',
873                'title'       => __( 'Filter by Category', 'jetpack-search-pkg' ),
874                'description' => __( 'Show category checkboxes with live result counts.', 'jetpack-search-pkg' ),
875                'attributes'  => array(
876                    'filterType' => 'taxonomy',
877                    'taxonomy'   => 'category',
878                    'label'      => __( 'Category', 'jetpack-search-pkg' ),
879                ),
880                'isActive'    => array( 'filterType', 'taxonomy' ),
881            ),
882            array(
883                'name'        => 'post_tag',
884                'title'       => __( 'Filter by Tag', 'jetpack-search-pkg' ),
885                'description' => __( 'Show tag checkboxes with live result counts.', 'jetpack-search-pkg' ),
886                'attributes'  => array(
887                    'filterType' => 'taxonomy',
888                    'taxonomy'   => 'post_tag',
889                    'label'      => __( 'Tag', 'jetpack-search-pkg' ),
890                ),
891                'isActive'    => array( 'filterType', 'taxonomy' ),
892            ),
893            array(
894                'name'        => 'post_type',
895                'title'       => __( 'Filter by Post Type', 'jetpack-search-pkg' ),
896                'description' => __( 'Show post type checkboxes with live result counts.', 'jetpack-search-pkg' ),
897                'attributes'  => array(
898                    'filterType' => 'post_type',
899                    'label'      => __( 'Post Type', 'jetpack-search-pkg' ),
900                ),
901                'isActive'    => array( 'filterType' ),
902            ),
903            array(
904                'name'        => 'author',
905                'title'       => __( 'Filter by Author', 'jetpack-search-pkg' ),
906                'description' => __( 'Show author checkboxes with live result counts.', 'jetpack-search-pkg' ),
907                'attributes'  => array(
908                    'filterType' => 'author',
909                    'label'      => __( 'Author', 'jetpack-search-pkg' ),
910                ),
911                'isActive'    => array( 'filterType' ),
912            ),
913        );
914
915        // WC-only product-taxonomy variations. `product_brand` gets an extra
916        // `taxonomy_exists()` probe — it isn't core WC, it ships via extensions
917        // (WC Brands, Perfect Brands) or recent bundled WC versions.
918        if ( self::woocommerce_blocks_enabled() ) {
919            $additions[] = array(
920                'name'        => 'product_cat',
921                'title'       => __( 'Filter by Product Category', 'jetpack-search-pkg' ),
922                'description' => __( 'Show product category checkboxes with live result counts.', 'jetpack-search-pkg' ),
923                'attributes'  => array(
924                    'filterType' => 'taxonomy',
925                    'taxonomy'   => 'product_cat',
926                    'label'      => __( 'Product Category', 'jetpack-search-pkg' ),
927                ),
928                'isActive'    => array( 'filterType', 'taxonomy' ),
929            );
930            $additions[] = array(
931                'name'        => 'product_tag',
932                'title'       => __( 'Filter by Product Tag', 'jetpack-search-pkg' ),
933                'description' => __( 'Show product tag checkboxes with live result counts.', 'jetpack-search-pkg' ),
934                'attributes'  => array(
935                    'filterType' => 'taxonomy',
936                    'taxonomy'   => 'product_tag',
937                    'label'      => __( 'Product Tag', 'jetpack-search-pkg' ),
938                ),
939                'isActive'    => array( 'filterType', 'taxonomy' ),
940            );
941            if ( taxonomy_exists( 'product_brand' ) ) {
942                $additions[] = array(
943                    'name'        => 'product_brand',
944                    'title'       => __( 'Filter by Product Brand', 'jetpack-search-pkg' ),
945                    'description' => __( 'Show product brand checkboxes with live result counts.', 'jetpack-search-pkg' ),
946                    'attributes'  => array(
947                        'filterType' => 'taxonomy',
948                        'taxonomy'   => 'product_brand',
949                        'label'      => __( 'Product Brand', 'jetpack-search-pkg' ),
950                    ),
951                    'isActive'    => array( 'filterType', 'taxonomy' ),
952                );
953            }
954        }
955
956        $additions[] = array(
957            'name'        => 'custom_taxonomy',
958            'title'       => __( 'Filter by Custom Taxonomy', 'jetpack-search-pkg' ),
959            'description' => __( 'Show checkboxes for a custom taxonomy. Pick which taxonomy in the block settings after inserting.', 'jetpack-search-pkg' ),
960            'attributes'  => array(
961                'filterType' => 'taxonomy',
962                'taxonomy'   => '',
963                'label'      => '',
964            ),
965            // Match on filterType only so identity survives the author picking a
966            // slug. The dedicated variations pin `taxonomy` in their isActive
967            // arrays, so WP's most-specific-match resolution still routes named
968            // slugs to those; Custom Taxonomy claims every other taxonomy.
969            'isActive'    => array( 'filterType' ),
970        );
971
972        // Merge by `name` so an upstream variation (block.json or earlier filter)
973        // wins over our preset of the same name; plain `array_merge` would
974        // append duplicates and the inserter would render two cards.
975        $variations    = (array) $variations;
976        $existing_keys = array_flip( array_column( $variations, 'name' ) );
977        foreach ( $additions as $variation ) {
978            if ( ! isset( $existing_keys[ $variation['name'] ] ) ) {
979                $variations[] = $variation;
980            }
981        }
982        return $variations;
983    }
984
985    /**
986     * Register block patterns. Files prefixed `wc-` compose WooCommerce-only
987     * blocks and load only when WC is active (mirrors `filter-wc-*` blocks).
988     */
989    protected static function register_patterns() {
990        $patterns_dir = __DIR__ . '/patterns';
991        if ( ! is_dir( $patterns_dir ) ) {
992            return;
993        }
994        $pattern_files = glob( $patterns_dir . '/*.php' );
995        if ( ! $pattern_files ) {
996            return;
997        }
998        $wc_blocks_enabled = self::woocommerce_blocks_enabled();
999        foreach ( $pattern_files as $pattern_file ) {
1000            if ( ! $wc_blocks_enabled && 0 === strpos( basename( $pattern_file ), 'wc-' ) ) {
1001                continue;
1002            }
1003            require_once $pattern_file;
1004        }
1005    }
1006
1007    /**
1008     * Derive a block-pattern's content from a chrome-free layout template (the
1009     * overlay templates, which already ship without header/footer/main page
1010     * chrome), so patterns stay in sync with the template they mirror instead of
1011     * carrying a hand-copied second copy of the layout.
1012     *
1013     * @param string $template_file Template basename under `templates/`.
1014     * @return string Block markup ready for `register_block_pattern()`, or '' when unreadable.
1015     */
1016    public static function pattern_content_from_template( string $template_file ): string {
1017        $template_path = __DIR__ . '/templates/' . basename( $template_file );
1018        // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- local, bundled template file.
1019        $raw = is_readable( $template_path ) ? (string) file_get_contents( $template_path ) : '';
1020        if ( '' === $raw ) {
1021            return '';
1022        }
1023        return trim( static::substitute_template_placeholders( $raw ) );
1024    }
1025
1026    /**
1027     * Build the full search page template content.
1028     *
1029     * Markup lives in `templates/jetpack-search.html` with a `{{FILTER_HEADING}}`
1030     * placeholder so the sidebar heading still goes through `esc_html__()`.
1031     *
1032     * @return string Block markup for a complete page template.
1033     */
1034    protected static function get_search_template_content(): string {
1035        $template_path = __DIR__ . '/templates/jetpack-search.html';
1036        // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- local, bundled template file.
1037        $raw = is_readable( $template_path ) ? (string) file_get_contents( $template_path ) : '';
1038        return static::sync_filters_popover_content( static::substitute_template_placeholders( $raw ) );
1039    }
1040
1041    /**
1042     * Register the Jetpack Search page template so it surfaces in the Site
1043     * Editor and resolves via the template hierarchy. DB-stored customizations
1044     * still win automatically — the `custom` source beats `plugin`. Classic
1045     * themes are skipped: the registry is only consulted by block themes.
1046     */
1047    public static function register_search_template() {
1048        if ( ! function_exists( 'register_block_template' ) || ! static::block_templates_active() ) {
1049            return;
1050        }
1051        $content = static::get_search_template_content();
1052        // Bail on missing/unreadable file: our slug is prepended to the search
1053        // hierarchy, so registering empty content would render a blank page on
1054        // `/?s=…`. Falling through lets core resolve the theme's `search.html`.
1055        if ( '' === $content ) {
1056            return;
1057        }
1058        static::replace_block_template(
1059            static::get_parent_plugin_slug() . '//' . self::SEARCH_TEMPLATE_SLUG,
1060            array(
1061                'title'       => __( 'Jetpack Search Results', 'jetpack-search-pkg' ),
1062                'description' => __( 'Displays search results with Jetpack Search filters.', 'jetpack-search-pkg' ),
1063                'content'     => $content,
1064            )
1065        );
1066    }
1067
1068    /**
1069     * Whether the overlay should paint the WooCommerce product variant for the
1070     * current request. True only when the override option is on and the request
1071     * is a product search — mirrors the embedded/inline interception
1072     * (`is_woocommerce_product_search()` already folds in the WC probe). The
1073     * overlay opens client-side from any search box, so this only flips on the
1074     * server-rendered product-search request (deep link or product-archive
1075     * search), not on a live form intercept from a non-product page.
1076     *
1077     * @return bool
1078     */
1079    protected static function should_use_product_overlay(): bool {
1080        return static::woocommerce_search_template_override_enabled()
1081            && static::is_woocommerce_product_search();
1082    }
1083
1084    /**
1085     * Read the dedicated overlay-template markup.
1086     *
1087     * Distinct from `get_search_template_content()`: a modal isn't a page, so
1088     * the overlay markup ships without `header`/`main`/`footer` template-parts
1089     * rather than runtime-stripping them.
1090     *
1091     * Picks the product variant on a WooCommerce product search (see
1092     * `should_use_product_overlay()`). Source of truth, in order:
1093     *   1. Customized singleton CPT (`Overlay_Template` / `Product_Overlay_Template`).
1094     *   2. The bundled `jetpack-search-overlay{-product}.html`.
1095     *
1096     * @return string Block markup for the overlay body.
1097     */
1098    protected static function get_overlay_template_content(): string {
1099        $is_product = static::should_use_product_overlay();
1100        $key        = $is_product ? 'product' : 'default';
1101        if ( isset( self::$overlay_template_content_cache[ $key ] ) ) {
1102            return self::$overlay_template_content_cache[ $key ];
1103        }
1104        $cpt_class  = $is_product ? Product_Overlay_Template::class : Overlay_Template::class;
1105        $customized = $cpt_class::get_customized_content();
1106        if ( null !== $customized ) {
1107            self::$overlay_template_content_cache[ $key ] = $customized;
1108            return self::$overlay_template_content_cache[ $key ];
1109        }
1110        $file          = $is_product ? 'jetpack-search-overlay-product.html' : 'jetpack-search-overlay.html';
1111        $template_path = __DIR__ . '/templates/' . $file;
1112        // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- local, bundled template file; wp_remote_get() is for remote URLs.
1113        $raw = is_readable( $template_path ) ? (string) file_get_contents( $template_path ) : '';
1114        self::$overlay_template_content_cache[ $key ] = static::sync_filters_popover_content( $raw );
1115        return self::$overlay_template_content_cache[ $key ];
1116    }
1117
1118    /**
1119     * Reset the `get_overlay_template_content()` memo. Tests only — PHPUnit
1120     * reuses a single process, so a CPT-customized overlay saved in one test
1121     * would otherwise be pinned (or a bundled read would mask it) in the next.
1122     * Guarded against accidental production use.
1123     */
1124    public static function reset_overlay_template_content_cache(): void {
1125        if ( defined( 'ABSPATH' ) && ! defined( 'PHPUNIT_COMPOSER_INSTALL' ) ) {
1126            return;
1127        }
1128        self::$overlay_template_content_cache = array();
1129    }
1130
1131    /**
1132     * Echo the Search-blocks overlay shell into `wp_footer`. Block markup
1133     * carries `data-wp-interactive` so the IA's standard `DOMContentLoaded`
1134     * hydration picks it up — no client-side fetch needed. The caller (`init()`)
1135     * gates registration on `is_block_template_overlay_enabled()`.
1136     */
1137    public static function print_block_template_overlay() {
1138        $rendered = self::$block_template_overlay_rendered_html;
1139        if ( null === $rendered || '' === $rendered ) {
1140            return;
1141        }
1142        $config = wp_json_encode(
1143            array(
1144                'searchInputSelector'    => 'input[name="s"]:not(.jetpack-search-input__field), #searchform input.search-field, .search-form input.search-field, .searchform input.search-field',
1145                'overlayTriggerSelector' => '.jetpack-search-block-overlay-trigger, .jetpack-instant-search__open-overlay-button, header#site-header .search-toggle[data-toggle-target]',
1146            ),
1147            JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP
1148        );
1149        ?>
1150        <script id="jetpack-search-block-overlay-config">window.JetpackSearchBlockOverlay=<?php echo $config; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- wp_json_encode + JSON_HEX_* flags. ?>;</script>
1151        <?php
1152        // `<template>` keeps the region out of `document.querySelectorAll` so
1153        // the IA runtime's DOMContentLoaded walk skips it. The bootstrap clones
1154        // into the shell on first open and hydrates there.
1155        // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- do_blocks output.
1156        printf( '<template id="jetpack-search-block-overlay-template">%s</template>', $rendered );
1157        ?>
1158        <div
1159            id="jetpack-search-block-overlay"
1160            class="jetpack-search-block-overlay"
1161            role="dialog"
1162            aria-modal="true"
1163            aria-label="<?php echo esc_attr__( 'Search', 'jetpack-search-pkg' ); ?>"
1164            hidden
1165        >
1166            <div class="jetpack-search-block-overlay__card">
1167                <button
1168                    type="button"
1169                    class="jetpack-search-block-overlay__close"
1170                    aria-label="<?php echo esc_attr__( 'Close search', 'jetpack-search-pkg' ); ?>"
1171                >
1172                    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" aria-hidden="true" focusable="false">
1173                        <path d="M18.3 5.71a1 1 0 0 0-1.41 0L12 10.59 7.11 5.7A1 1 0 0 0 5.7 7.11L10.59 12 5.7 16.89a1 1 0 1 0 1.41 1.41L12 13.41l4.89 4.89a1 1 0 0 0 1.41-1.41L13.41 12l4.89-4.89a1 1 0 0 0 0-1.4z" fill="currentColor" />
1174                    </svg>
1175                </button>
1176                <div class="jetpack-search-block-overlay__content"></div>
1177            </div>
1178        </div>
1179        <?php
1180    }
1181
1182    /**
1183     * Register + enqueue the overlay-bootstrap Script Module that wires
1184     * theme-defined search triggers to the rendered shell. Inline-CSS for the
1185     * modal chrome. Config emits alongside the overlay HTML in
1186     * `print_block_template_overlay()`.
1187     */
1188    public static function enqueue_block_template_overlay_assets() {
1189        if ( ! function_exists( 'wp_register_script_module' ) ) {
1190            return;
1191        }
1192        $base_path  = Package::get_installed_path() . 'build/search-blocks/overlay-bootstrap/';
1193        $asset_file = $base_path . 'index.asset.php';
1194        if ( ! file_exists( $asset_file ) ) {
1195            return;
1196        }
1197        $asset = require $asset_file;
1198        wp_register_script_module(
1199            'jetpack-search/overlay-bootstrap',
1200            plugins_url( 'index.js', $base_path . 'index.js' ),
1201            $asset['dependencies'] ?? array(),
1202            $asset['version'] ?? false
1203        );
1204        wp_enqueue_script_module( 'jetpack-search/overlay-bootstrap' );
1205
1206        wp_register_style( 'jetpack-search-block-overlay', false, array(), $asset['version'] ?? false );
1207        wp_enqueue_style( 'jetpack-search-block-overlay' );
1208        wp_add_inline_style( 'jetpack-search-block-overlay', static::block_template_overlay_inline_css() );
1209
1210        // Shared responsive layout CSS (narrow-width sidebar collapse +
1211        // in-header popover toggle). Same rules ship to the embedded /
1212        // WC-product page templates via `enqueue_search_page_assets()`.
1213        static::enqueue_search_layout_style();
1214
1215        // Render here (during `wp_enqueue_scripts`) so view-module enqueues
1216        // from `do_blocks()` land before the importmap prints — see
1217        // AGENTS.md § Hydration & SSR seeding.
1218        self::$block_template_overlay_rendered_html = trim(
1219            No_Results::render_self_contained( static::get_overlay_template_content() )
1220        );
1221    }
1222
1223    /**
1224     * Print the body-sampler `<script>` that sets `--jp-search-page-ink` /
1225     * `--jp-search-page-surface` on `:root` from the body's resolved `color` /
1226     * `backgroundColor`. Skips writing surface when bg is transparent (the
1227     * theme paints on the browser canvas) or when bg equals ink (vintage
1228     * frame-themes like Twenty Sixteen use body as a colored border around a
1229     * lighter `.site` content wrapper). See AGENTS.md § Theme tokens.
1230     *
1231     * The `wp_body_open` hook registers unconditionally in `init()`, before
1232     * the module-active check in `Initializer::init_search_blocks()` — so the
1233     * module gate lives here instead, front-end only.
1234     */
1235    public static function print_theme_token_sampler(): void {
1236        if ( is_admin() || ! ( new Module_Control() )->is_active() ) {
1237            return;
1238        }
1239        echo "<script id='jetpack-search-theme-token-sampler'>(function(){try{var c=getComputedStyle(document.body),r=document.documentElement,ink=c.color,bg=c.backgroundColor;if(ink){r.style.setProperty('--jp-search-page-ink',ink);}if(bg&&bg!==ink&&bg!=='rgba(0, 0, 0, 0)'&&bg!=='transparent'){r.style.setProperty('--jp-search-page-surface',bg);}}catch(e){}})();</script>";
1240    }
1241
1242    /**
1243     * Inline CSS for the overlay modal chrome. Block content brings its own
1244     * theme styling; this is just the scrim, centered card, 60px header strip,
1245     * close button, mobile padding tweaks, and scroll lock. The responsive
1246     * sidebar-collapse + in-header popover rules shared with the page
1247     * templates live in `search_layout_inline_css()`.
1248     *
1249     * Surface/ink hoist `--jp-search-page-*` (with the legacy
1250     * `--wp--preset--color--*` chain as fallback — see AGENTS.md § Theme
1251     * tokens) onto two custom props so in-card surfaces share one source.
1252     * Hairlines use `color-mix(--jp-search-overlay-ink, --jp-search-overlay-surface)`.
1253     *
1254     * @return string
1255     */
1256    protected static function block_template_overlay_inline_css(): string {
1257        return <<<'CSS'
1258.jetpack-search-block-overlay {
1259    position: fixed;
1260    inset: 0;
1261    z-index: 100000;
1262    display: flex;
1263    justify-content: center;
1264    align-items: flex-start;
1265    background: rgba(31, 31, 31, 0.7);
1266    overflow-y: auto;
1267    padding: 3em 1em;
1268    transition: opacity 0.1s ease-in;
1269}
1270.jetpack-search-block-overlay[hidden] {
1271    display: none;
1272}
1273@media (prefers-reduced-motion: reduce) {
1274    .jetpack-search-block-overlay {
1275        transition: none;
1276    }
1277}
1278.jetpack-search-block-overlay__card {
1279    position: relative;
1280    width: 100%;
1281    max-width: 1080px;
1282    --jp-search-overlay-surface: var(--jp-search-page-surface, var(--wp--preset--color--base, var(--wp--preset--color--background, #fff)));
1283    --jp-search-overlay-ink: var(--jp-search-page-ink, var(--wp--preset--color--contrast, var(--wp--preset--color--foreground, #1d2327)));
1284    /* Single source for the content group's inset. The corner-join in
1285     * search_layout_inline_css() zeroes the block-start/block-end of this
1286     * padding on the group and re-adds the same tokens on the columns, so the
1287     * sidebar hairline reaches both card edges — keep them as var()s so the
1288     * two sites can't drift. */
1289    --jp-search-overlay-content-pad-block-start: 0.5em;
1290    --jp-search-overlay-content-pad-inline: 2em;
1291    --jp-search-overlay-content-pad-block-end: 2em;
1292    background: var(--jp-search-overlay-surface);
1293    color: var(--jp-search-overlay-ink);
1294    border: 1px solid rgba(128, 128, 128, 0.25);
1295    border-radius: 4px;
1296    box-shadow: 0 8px 32px rgba(0, 0, 0, 0.18);
1297    padding-top: 60px;
1298}
1299/* Token-aware card / scrim separation (SEARCH-270): tint the resolved surface
1300 * ~5% toward ink and paint the hairline border with the same ink-over-surface
1301 * mix used for the header `::before`. Both auto-invert polarity per theme, so
1302 * dark themes get a card that visibly layers above the scrim without losing
1303 * the themed surface color. The static `rgba(128,128,128,.25)` border + the
1304 * un-tinted token chain stay as the fallback for browsers without `color-mix`. */
1305@supports (background: color-mix(in sRGB, black 50%, white)) {
1306    .jetpack-search-block-overlay__card {
1307        --jp-search-overlay-surface: color-mix(in sRGB, var(--jp-search-page-ink, var(--wp--preset--color--contrast, var(--wp--preset--color--foreground, #1d2327))) 5%, var(--jp-search-page-surface, var(--wp--preset--color--base, var(--wp--preset--color--background, #fff))));
1308        border-color: color-mix(in sRGB, var(--jp-search-overlay-ink) 20%, var(--jp-search-overlay-surface));
1309        /* Ink-derived shadow inverts polarity per theme (SEARCH-289): a dark drop
1310         * shadow on light cards, a soft light halo on dark — a flat black shadow is
1311         * invisible against the dark scrim. Static black above is the fallback. */
1312        box-shadow: 0 8px 32px color-mix(in sRGB, var(--jp-search-overlay-ink) 22%, transparent);
1313    }
1314}
1315/* Single hairline over the full 60px header strip — siblings paint with a seam (SEARCH-260). */
1316.jetpack-search-block-overlay__card::before {
1317    content: "";
1318    position: absolute;
1319    top: 60px;
1320    left: 0;
1321    right: 0;
1322    height: 1px;
1323    background: transparent;
1324    pointer-events: none;
1325}
1326@supports (background: color-mix(in sRGB, black 50%, white)) {
1327    .jetpack-search-block-overlay__card::before {
1328        background: color-mix(in sRGB, var(--jp-search-overlay-ink) 15%, var(--jp-search-overlay-surface));
1329    }
1330}
1331.jetpack-search-block-overlay__close {
1332    position: absolute;
1333    top: 0;
1334    right: 0;
1335    width: 60px;
1336    height: 60px;
1337    display: flex;
1338    align-items: center;
1339    justify-content: center;
1340    background: transparent;
1341    border: 0;
1342    cursor: pointer;
1343    color: inherit;
1344}
1345/* Opaque ink-over-surface mix — `color-mix(currentColor, transparent)` collapses to full-opacity ink on Safari <16.4 and swallows the X icon. */
1346@supports (background: color-mix(in sRGB, black 50%, white)) {
1347    .jetpack-search-block-overlay__close:hover,
1348    .jetpack-search-block-overlay__close:focus-visible {
1349        background: color-mix(in sRGB, var(--jp-search-overlay-ink) 14%, var(--jp-search-overlay-surface));
1350    }
1351}
1352.jetpack-search-block-overlay__close svg {
1353    width: 24px;
1354    height: 24px;
1355}
1356/* Pin in-overlay button `color` against host-theme `button:hover|:focus` overrides
1357 * (fieldguide and similar legacy themes flip button color to a brand accent on hover).
1358 * Our block-level rules set `color: inherit` at (0,1,0); a stray `button:hover` rule
1359 * at (0,1,1) outranks it on `:hover`, and the `color-mix(currentColor X%, …)` hover
1360 * affordances on the filters-popover trigger, results-sort trigger, suggestions
1361 * options, etc. then resolve against the host's hover color (often white-on-white).
1362 * Card-scoped `:hover|:focus|[aria-expanded=true]` lands at (0,2,1) — beats the
1363 * theme rule without escalating to `!important`. */
1364.jetpack-search-block-overlay__card button:hover,
1365.jetpack-search-block-overlay__card button:focus,
1366.jetpack-search-block-overlay__card button:focus-visible,
1367.jetpack-search-block-overlay__card button[aria-expanded="true"] {
1368    color: var(--jp-search-overlay-ink);
1369}
1370/* Load More is a solid theme `core/button` on the search page, which is right
1371 * there. Inside the overlay card it sits on the resolved card surface, where the
1372 * theme's solid button background (and its accent `:hover`, e.g. Twenty Sixteen's
1373 * #007acc) reads as a heavy slab that clashes with the card's otherwise
1374 * `currentColor`-ghost controls (close, sort/filter triggers, active-filter
1375 * pills). Card-scoped (0,2,0 / 0,2,1) so it only restyles the in-overlay button
1376 * to the same ghost affordance — the page button is untouched. */
1377.jetpack-search-block-overlay__card .jetpack-search-load-more__button {
1378    background: transparent;
1379    border: 1px solid;
1380    border-color: color-mix(in sRGB, currentColor 20%, transparent);
1381    color: var(--jp-search-overlay-ink);
1382}
1383.jetpack-search-block-overlay__card .jetpack-search-load-more__button:hover:not(:disabled),
1384.jetpack-search-block-overlay__card .jetpack-search-load-more__button:focus-visible {
1385    background: color-mix(in sRGB, currentColor 8%, transparent);
1386}
1387/* Promote the first child (search-input) to a 60px header strip flush with
1388 * the close button, matching the legacy `__box` header. Suppress the input
1389 * block's own border-bottom — the card's `::before` hairline handles the
1390 * separator across the whole strip. */
1391.jetpack-search-block-overlay__card .wp-block-jetpack-search-search-input {
1392    position: absolute;
1393    top: 0;
1394    left: 0;
1395    right: 60px;
1396    height: 60px;
1397    margin: 0;
1398    padding: 0;
1399}
1400.jetpack-search-block-overlay__card .wp-block-jetpack-search-search-input .jetpack-search-input__inside-wrapper {
1401    height: 100%;
1402    display: flex;
1403    align-items: stretch;
1404    gap: 0;
1405    padding: 0;
1406    border-bottom: 0;
1407}
1408.jetpack-search-block-overlay__card .wp-block-jetpack-search-search-input .jetpack-search-input__icon {
1409    flex: 0 0 60px;
1410    width: 60px;
1411    height: 60px;
1412    padding: 18px;
1413    box-sizing: border-box;
1414    opacity: 0.5;
1415}
1416.jetpack-search-block-overlay__card .wp-block-jetpack-search-search-input .jetpack-search-input__field {
1417    flex: 1 1 auto;
1418    min-width: 0;
1419    height: 100%;
1420    font-size: 18px;
1421    line-height: 1;
1422    margin: 0;
1423    padding: 0;
1424    background: transparent;
1425}
1426.jetpack-search-block-overlay__card .wp-block-jetpack-search-search-input .jetpack-search-input__clear {
1427    flex: 0 0 60px;
1428    width: 60px;
1429    height: 60px;
1430    padding: 0;
1431    font-size: 0.875rem;
1432    font-weight: 400;
1433    line-height: 1;
1434}
1435/* Suggestions panel covers the full card width (cancel the input's `right: 60px`
1436 * offset) and sits above `results-sort` / `filters-popover` (both `z-index: 20`).
1437 * Background reads from `--jp-search-overlay-surface` so the panel tracks the
1438 * resolved card surface — a hardcoded `#fff` would re-introduce the white-on-dark
1439 * bug on legacy `--background`/`--foreground` themes. */
1440.jetpack-search-block-overlay__card .wp-block-jetpack-search-search-input .jetpack-search-input__suggestions {
1441    right: -60px;
1442    z-index: 30;
1443    background: var(--jp-search-overlay-surface, #fff);
1444}
1445/* Top padding clears the absolutely-positioned 60px header strip (SEARCH-243). */
1446.jetpack-search-block-overlay__content > .wp-block-group:first-child {
1447    padding: var(--jp-search-overlay-content-pad-block-start) var(--jp-search-overlay-content-pad-inline) var(--jp-search-overlay-content-pad-block-end);
1448}
1449@media (max-width: 781px) {
1450    .jetpack-search-block-overlay {
1451        padding: 0;
1452    }
1453    .jetpack-search-block-overlay__card {
1454        min-height: 100vh;
1455        border: 0;
1456        border-radius: 0;
1457        box-shadow: none;
1458        --jp-search-overlay-content-pad-inline: 1em;
1459        --jp-search-overlay-content-pad-block-end: 1em;
1460    }
1461}
1462/* Mirror legacy `$break-lg: 992px → $modal-max-width-lg: 95%` from `instant-search/components/search-results.scss`. */
1463@media (min-width: 992px) {
1464    .jetpack-search-block-overlay__card {
1465        max-width: 95%;
1466    }
1467}
1468/* Body-scroll lock while open. JS side stashes/restores scrollY on toggle. */
1469body.jetpack-search-block-overlay-open {
1470    position: fixed;
1471    left: 0;
1472    right: 0;
1473    width: 100%;
1474    overflow: hidden;
1475}
1476CSS;
1477    }
1478
1479    /**
1480     * Register + enqueue the shared responsive layout CSS on the embedded /
1481     * WC-product page templates (`jetpack-search.html`,
1482     * `jetpack-search-product-results.html`). Self-gates on `is_search()` so
1483     * non-search requests skip the work entirely; the overlay path enqueues
1484     * the same handle unconditionally from its own asset hook.
1485     */
1486    public static function enqueue_search_page_assets() {
1487        if ( ! is_search() ) {
1488            return;
1489        }
1490        static::enqueue_search_layout_style();
1491    }
1492
1493    /**
1494     * Register + enqueue the inline CSS that drives the shared responsive
1495     * layout pattern across all three Search Blocks templates — narrow-width
1496     * sidebar collapse and in-header popover toggle. Called from both the
1497     * overlay enqueue path and the page-template enqueue path.
1498     *
1499     * `wp_register_style` / `wp_enqueue_style` are idempotent, but
1500     * `wp_add_inline_style` is **not** — it appends to an internal array on
1501     * every call, so a second invocation would double the inline payload.
1502     * The `wp_style_is( …, 'enqueued' )` short-circuit makes the helper safe
1503     * to call from multiple sites in one request.
1504     */
1505    public static function enqueue_search_layout_style() {
1506        // No src — this handle exists only as a target for `wp_add_inline_style`.
1507        // Version tracks the package so a release bust cache-invalidates any
1508        // reusing site's inline-style cache.
1509        wp_register_style( 'jetpack-search-layout', false, array(), Package::VERSION );
1510        if ( wp_style_is( 'jetpack-search-layout', 'enqueued' ) ) {
1511            return;
1512        }
1513        wp_enqueue_style( 'jetpack-search-layout' );
1514        wp_add_inline_style( 'jetpack-search-layout', static::search_layout_inline_css() );
1515    }
1516
1517    /**
1518     * Inline CSS for the responsive search-results layout shared across the
1519     * overlay, embedded (`jetpack-search.html`), and WC product
1520     * (`jetpack-search-product-results.html`) templates.
1521     *
1522     * Below 992px the right-column filter sidebar collapses to a popover
1523     * trigger docked next to results-sort; at >= 992px the sidebar is the
1524     * sole filter UI and the in-header popover is hidden so the two don't
1525     * double up. Same breakpoint as the legacy Instant Search overlay
1526     * (`.jetpack-instant-search__search-results-secondary { display: none }`
1527     * below `$break-lg`). Lives next to `block_template_overlay_inline_css()`
1528     * (which keeps overlay-only chrome) because the rules target the
1529     * templates' outer columns + results-header, none of which any single
1530     * block owns.
1531     *
1532     * @return string
1533     */
1534    protected static function search_layout_inline_css(): string {
1535        return <<<'CSS'
1536/* The block group already carries `layout.type:flex` which makes the WordPress
1537 * block-layout system emit `display:flex` / `flex-wrap:nowrap` /
1538 * `justify-content:space-between`. Restating them is defensive (decouples us
1539 * from block-layout CSS being present); the operative net-new rule is
1540 * `align-items: center`, which centers `results-count` against the controls
1541 * cluster. */
1542.jetpack-search-layout__results-header {
1543    display: flex;
1544    flex-wrap: nowrap;
1545    justify-content: space-between;
1546    align-items: center;
1547}
1548/* Right-side controls cluster: sort + filters-popover trigger. Without this
1549 * the three `__results-header` children get spread evenly by the parent's
1550 * `space-between`; nesting sort + popover here pins them as one block on the
1551 * trailing edge. */
1552.jetpack-search-layout__results-header-controls {
1553    display: flex;
1554    flex-wrap: nowrap;
1555    align-items: center;
1556    gap: 0.75rem;
1557}
1558/* Name the columns row as the layout container so the sidebar/popover flip
1559 * tracks its inline-size. The `@media` rules below are the universal base —
1560 * they fire in every browser (including legacy ones without container-query
1561 * support) and they drive standalone usage outside the named container (no
1562 * container ancestor → only `@media` applies). The `@container` rule further
1563 * down overrides `@media` via source-order cascade at equal specificity when
1564 * the named container is in scope AND narrower than 992px. The override has
1565 * to undo `@media (min-width: 992px)`'s `popover { display: none }`
1566 * explicitly: in the "wide viewport, narrow container" case `@media
1567 * (min-width: 992px)` keeps firing on the viewport width and would otherwise
1568 * leave the visitor with no filter UI at all. `@container (min-width: 992px)`
1569 * isn't defined — container width is bounded by viewport width in practice,
1570 * so the matching `@media (min-width: 992px)` already covers the wide case. */
1571.wp-block-columns:has(> .jetpack-search-layout__filters-column) {
1572    container-type: inline-size;
1573    container-name: jetpack-search-layout;
1574}
1575/* Below 992px the right-column filter sidebar collapses to a popover trigger
1576 * docked next to results-sort. The trigger comes from the
1577 * `jetpack-search/filters-popover` block that ships in each template. The
1578 * selector is scoped to the named outer column so nested `wp-block-column`s
1579 * inside result-card templates aren't affected. */
1580@media (max-width: 991.98px) {
1581    .jetpack-search-layout__filters-column {
1582        display: none;
1583    }
1584    /* `!important` defends against the parent `wp:columns` block-layout CSS
1585     * that pins `.wp-block-column` to its inline `flex-basis` (or to an even
1586     * split when no width is set). Once the filter column is `display:none`,
1587     * the results column has to be able to claim the full row at any
1588     * specificity. */
1589    .jetpack-search-layout__results-column {
1590        flex-basis: 100% !important;
1591    }
1592}
1593/* Sidebar left divider tracks `currentColor` so the hairline stays subtle on
1594 * light themes and visible on dark themes, matching the search-input
1595 * underline. We only set color; each template's column block sets
1596 * `border-left-width: 1px` inline. Fallback to `transparent` so themes/UAs
1597 * without `color-mix` support get an invisible divider rather than a hard
1598 * grey rule. */
1599.jetpack-search-layout__filters-column {
1600    border-left-color: transparent;
1601}
1602@supports (border-color: color-mix(in sRGB, black 50%, white)) {
1603    .jetpack-search-layout__filters-column {
1604        border-left-color: color-mix(in sRGB, currentColor 15%, transparent);
1605    }
1606}
1607/* Sidebar-showing rules (>= 992px). The corner-join is structural: the
1608 * columns row is pulled flush to the search-input hairline and breathing
1609 * room re-added as internal column padding, so the filters column's
1610 * `border-left` runs the row's full height — hairline (top) to end-of-div
1611 * (bottom). Three vertical gaps are neutralised:
1612 *
1613 *   a) `margin-block-start` on the row (outer group's `spacing.blockGap` or
1614 *      the theme's default block-gap) — zeroed.
1615 *
1616 *   b) `.is-layout-flex { align-items: center }` (theme/core default), which
1617 *      centres the shorter filters column and drops its top edge. Overridden
1618 *      to `stretch` (not `flex-start`) so the column also grows to full row
1619 *      height; it's flow layout, so its content stays top-aligned regardless.
1620 *
1621 *   c) Overlay-only: SEARCH-243's content-group inset sits outside the
1622 *      columns, so the stretched column stops short of the card edges (below
1623 *      the `::before` hairline at the top, and short of the bottom). Zeroed
1624 *      on the group's block axis and re-added on the columns, both sides
1625 *      reading the same `--jp-search-overlay-content-pad-*` tokens the group
1626 *      itself uses — so the divider reaches both edges while content keeps
1627 *      its breathing room, and the two sites can't drift.
1628 *
1629 * `.is-layout-flex` bumps the columns selector to (0,3,0) to outrank
1630 * per-container `blockGap` CSS; `:has(> filters-column)` scopes it to our
1631 * rows. These target the row/group, which `@container` can't reach from
1632 * inside the named container, so they stay viewport-driven — harmless when
1633 * the sidebar collapses below 992px. (b) is also a no-op wherever WP core's
1634 * `.wp-block-columns { align-items: normal !important }` is present; see
1635 * AGENTS.md. */
1636@media (min-width: 992px) {
1637    /* Sidebar shown, popover-in-results-header hidden. The `@container
1638     * (max-width: 991.98px)` block below re-shows the popover when the
1639     * named container is narrower than the viewport. */
1640    .jetpack-search-layout__results-header .jetpack-search-filters-popover {
1641        display: none;
1642    }
1643    .wp-block-columns.is-layout-flex:has(> .jetpack-search-layout__filters-column) {
1644        align-items: stretch;
1645        margin-block-start: 0;
1646    }
1647    .jetpack-search-block-overlay__content > .wp-block-group:first-child:has(.jetpack-search-layout__filters-column) {
1648        padding-top: 0;
1649        padding-bottom: 0;
1650    }
1651    .wp-block-columns:has(> .jetpack-search-layout__filters-column) > .wp-block-column {
1652        padding-top: var(--jp-search-overlay-content-pad-block-start, 0.5em);
1653    }
1654    .jetpack-search-block-overlay__content .wp-block-columns:has(> .jetpack-search-layout__filters-column) > .wp-block-column {
1655        padding-bottom: var(--jp-search-overlay-content-pad-block-end, 2em);
1656    }
1657}
1658/* @container override: applies when the named container exists. Placed AFTER
1659 * the `@media` rules so source-order cascade lets it win over them at equal
1660 * specificity. In "wide viewport, narrow container" (the case the change is
1661 * meant to fix), `@media (max-width: 991.98px)` doesn't fire but `@media
1662 * (min-width: 992px)` does — this block undoes the latter's `popover {
1663 * display: none }` via `display: inline-block` and hides the sidebar that
1664 * the `@media (max-width)` rule wouldn't have hidden at this viewport. Same
1665 * `!important` reasoning on `flex-basis: 100%` as the @media block. */
1666@container jetpack-search-layout (max-width: 991.98px) {
1667    .jetpack-search-layout__filters-column {
1668        display: none;
1669    }
1670    .jetpack-search-layout__results-column {
1671        flex-basis: 100% !important;
1672    }
1673    .jetpack-search-layout__results-header .jetpack-search-filters-popover {
1674        display: inline-block;
1675    }
1676}
1677CSS;
1678    }
1679
1680    /**
1681     * Product-search counterpart of `get_search_template_content()`.
1682     *
1683     * @return string Block markup for the product-search template.
1684     */
1685    protected static function get_product_search_template_content(): string {
1686        $template_path = __DIR__ . '/templates/jetpack-search-product-results.html';
1687        // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- local, bundled template file.
1688        $raw = is_readable( $template_path ) ? (string) file_get_contents( $template_path ) : '';
1689        return static::sync_filters_popover_content( static::substitute_template_placeholders( $raw ) );
1690    }
1691
1692    /**
1693     * Substitute `{{FILTER_HEADING}}` / `{{HEADER_SLUG}}` / `{{FOOTER_SLUG}}` in a
1694     * bundled template. Empty input passes through.
1695     *
1696     * @param string $raw Raw template-file contents.
1697     * @return string
1698     */
1699    protected static function substitute_template_placeholders( string $raw ): string {
1700        if ( '' === $raw ) {
1701            return $raw;
1702        }
1703        $slugs = static::resolve_chrome_slugs();
1704        return str_replace(
1705            array( '{{FILTER_HEADING}}', '{{HEADER_SLUG}}', '{{FOOTER_SLUG}}' ),
1706            array(
1707                esc_html__( 'Filter options', 'jetpack-search-pkg' ),
1708                $slugs['header'],
1709                $slugs['footer'],
1710            ),
1711            $raw
1712        );
1713    }
1714
1715    /**
1716     * Active theme's chrome slugs. Test seam; resolver lives on
1717     * `Theme_Chrome_Slug_Resolver`.
1718     *
1719     * @return array{header:string,footer:string}
1720     */
1721    protected static function resolve_chrome_slugs(): array {
1722        return Theme_Chrome_Slug_Resolver::resolve();
1723    }
1724
1725    /**
1726     * Names of the "source of truth" filter-composition blocks — whichever is
1727     * present in a template supplies the canonical filter config that
1728     * `jetpack-search/filters-popover` mirrors. See {@see sync_filters_popover_content()}.
1729     */
1730    const FILTERS_SOURCE_BLOCK_NAMES = array( 'jetpack-search/filters', 'jetpack-search/filters-product' );
1731
1732    /**
1733     * `jetpack-search/filters-popover` (the collapsible/mobile filter panel) and
1734     * `jetpack-search/filters` / `jetpack-search/filters-product` (the wide-viewport
1735     * sidebar) are two independently-serialized copies of the same filter
1736     * configuration, shown one-or-the-other via a CSS breakpoint. Nothing keeps
1737     * them in sync, so editing one silently leaves the other stale (SEARCH-307).
1738     *
1739     * Rather than a two-way sync, the sidebar block is treated as the single
1740     * source of truth: every time template content is read — for rendering or
1741     * for editing — the popover's inner blocks are recomputed to mirror
1742     * whatever the sidebar currently contains. A direct edit to the popover's
1743     * own inner blocks still saves, but is overwritten back to match the
1744     * sidebar on the next read; self-healing, no migration needed for content
1745     * that already diverged before this existed.
1746     *
1747     * @param string $content Block markup, e.g. a full template or singleton-CPT post_content.
1748     * @return string Block markup with the popover's inner blocks synced to the sidebar's, unchanged if either block is absent.
1749     */
1750    public static function sync_filters_popover_content( string $content ): string {
1751        if ( '' === $content || false === strpos( $content, 'jetpack-search/filters-popover' ) ) {
1752            return $content;
1753        }
1754        $blocks = parse_blocks( $content );
1755        $source = static::find_block_by_name( $blocks, self::FILTERS_SOURCE_BLOCK_NAMES );
1756        if ( null === $source ) {
1757            return $content;
1758        }
1759        $replaced = static::replace_block_inner_content( $blocks, 'jetpack-search/filters-popover', $source );
1760        return $replaced ? serialize_blocks( $blocks ) : $content;
1761    }
1762
1763    /**
1764     * Depth-first search for the first block matching one of `$names`.
1765     *
1766     * @param array<int,array<string,mixed>> $blocks Parsed blocks (`parse_blocks()` shape).
1767     * @param string[]                       $names  Block names to match.
1768     * @return array<string,mixed>|null
1769     */
1770    protected static function find_block_by_name( array $blocks, array $names ): ?array {
1771        foreach ( $blocks as $block ) {
1772            if ( in_array( $block['blockName'], $names, true ) ) {
1773                return $block;
1774            }
1775            if ( ! empty( $block['innerBlocks'] ) ) {
1776                $found = static::find_block_by_name( $block['innerBlocks'], $names );
1777                if ( null !== $found ) {
1778                    return $found;
1779                }
1780            }
1781        }
1782        return null;
1783    }
1784
1785    /**
1786     * Depth-first search that overwrites the first block named `$name` with
1787     * `$source`'s inner blocks. `innerBlocks`/`innerContent`/`innerHTML` are
1788     * copied together from `$source` so the null-placeholder bookkeeping in
1789     * `innerContent` stays internally consistent regardless of how many
1790     * filters `$source` has.
1791     *
1792     * @param array<int,array<string,mixed>> $blocks Parsed blocks, modified in place.
1793     * @param string                         $name   Block name to replace.
1794     * @param array<string,mixed>            $source Block whose inner content is cloned onto the match.
1795     * @return bool Whether a match was found and replaced.
1796     */
1797    protected static function replace_block_inner_content( array &$blocks, string $name, array $source ): bool {
1798        foreach ( $blocks as &$block ) {
1799            if ( $block['blockName'] === $name ) {
1800                $block['innerBlocks']  = $source['innerBlocks'];
1801                $block['innerContent'] = $source['innerContent'];
1802                $block['innerHTML']    = $source['innerHTML'];
1803                return true;
1804            }
1805            if ( ! empty( $block['innerBlocks'] ) && static::replace_block_inner_content( $block['innerBlocks'], $name, $source ) ) {
1806                return true;
1807            }
1808        }
1809        return false;
1810    }
1811
1812    /**
1813     * Idempotent wrapper around `register_block_template`. Unregisters first so
1814     * a stale entry from a prior init (long-lived PHP-FPM worker) is replaced
1815     * rather than triggering `doing_it_wrong`.
1816     *
1817     * @param string              $name Fully-qualified template name.
1818     * @param array<string,mixed> $args Args for register_block_template().
1819     */
1820    protected static function replace_block_template( string $name, array $args ) {
1821        if ( class_exists( '\WP_Block_Templates_Registry' ) ) {
1822            $registry = \WP_Block_Templates_Registry::get_instance();
1823            if ( $registry->is_registered( $name ) ) {
1824                $registry->unregister( $name );
1825            }
1826        }
1827        register_block_template( $name, $args );
1828    }
1829
1830    /**
1831     * Counterpart of `register_search_template()` for product search.
1832     */
1833    public static function register_product_search_template() {
1834        if ( ! function_exists( 'register_block_template' ) || ! static::block_templates_active() ) {
1835            return;
1836        }
1837        $content = static::get_product_search_template_content();
1838        if ( '' === $content ) {
1839            return;
1840        }
1841        static::replace_block_template(
1842            static::get_parent_plugin_slug() . '//' . self::PRODUCT_SEARCH_TEMPLATE_SLUG,
1843            array(
1844                'title'       => __( 'Jetpack Search Product Results', 'jetpack-search-pkg' ),
1845                'description' => __( 'Displays WooCommerce product search results with Jetpack Search filters.', 'jetpack-search-pkg' ),
1846                'content'     => $content,
1847            )
1848        );
1849    }
1850
1851    /**
1852     * Directory slug of the plugin that owns the template in the Site Editor UI.
1853     * Picked by preference so the more-specific "Jetpack Search" label wins
1854     * when both the standalone plugin and the Jetpack monolith are active:
1855     * `jetpack-search` → `jetpack` → `jetpack-search` fallback.
1856     *
1857     * @return string
1858     */
1859    protected static function get_parent_plugin_slug(): string {
1860        $active    = Helper::get_active_plugins();
1861        $preferred = array(
1862            'jetpack-search' => 'jetpack-search/jetpack-search.php',
1863            'jetpack'        => 'jetpack/jetpack.php',
1864        );
1865        foreach ( $preferred as $slug => $plugin_file ) {
1866            if ( in_array( $plugin_file, $active, true ) ) {
1867                return $slug;
1868            }
1869        }
1870        return 'jetpack-search';
1871    }
1872
1873    /**
1874     * Prepend the Jetpack Search slug to the search template hierarchy on
1875     * block-theme search requests. Existing occurrences are stripped first
1876     * so a second init pass / another filter on the same hook can't dup.
1877     *
1878     * WooCommerce product-search carve-out: override off → leave to WC's
1879     * prepend; override on → fall through here, then
1880     * `route_woocommerce_product_search_template()` swaps WC's slug for ours.
1881     *
1882     * @param string[] $templates Template hierarchy slugs.
1883     * @return string[]
1884     */
1885    public static function prepend_search_template( $templates ) {
1886        if ( ! is_search() || ! static::block_templates_active() ) {
1887            return $templates;
1888        }
1889        if ( ! static::woocommerce_search_template_override_enabled() && static::is_woocommerce_product_search() ) {
1890            return $templates;
1891        }
1892        $templates = array_values(
1893            array_filter(
1894                (array) $templates,
1895                static function ( $slug ) {
1896                    return self::SEARCH_TEMPLATE_SLUG !== $slug;
1897                }
1898            )
1899        );
1900        array_unshift( $templates, self::SEARCH_TEMPLATE_SLUG );
1901        return $templates;
1902    }
1903
1904    /**
1905     * Classic-theme counterpart to `prepend_search_template()`. Block-theme
1906     * hierarchy filters are a no-op on classic themes — `locate_template()`
1907     * walks slugs as `{slug}.php` and a classic theme doesn't ship one for
1908     * our slug. So let the hierarchy resolve normally, then swap the path
1909     * via `template_include` to our bundled PHP shim, which renders the same
1910     * block markup inside the theme's `get_header()`/`get_footer()`.
1911     *
1912     * @param string $template Resolved template path.
1913     * @return string
1914     */
1915    public static function route_classic_theme_search_template( $template ) {
1916        if ( ! is_search() ) {
1917            return $template;
1918        }
1919        $is_product_search = static::is_woocommerce_product_search();
1920        // Override off: leave product search to WooCommerce / the theme's own
1921        // archive routing — we don't impose the product shim without opt-in.
1922        if ( ! static::woocommerce_search_template_override_enabled() && $is_product_search ) {
1923            return $template;
1924        }
1925        // Override on + product search: route to the product-results shim.
1926        // Bail back to the theme's template if neither a customization nor a
1927        // bundled body is available — rendering header/footer around an empty
1928        // body looks broken.
1929        if ( $is_product_search ) {
1930            if ( null === Product_Search_Template::get_customized_content() && '' === static::get_classic_theme_product_search_body() ) {
1931                return $template;
1932            }
1933            return __DIR__ . '/templates/classic-theme-product-search.php';
1934        }
1935        // Regular (non-product) search: only Embedded takes over the whole search
1936        // page. Inline registers this router too (for the product shim above) but
1937        // leaves regular searches to the theme, so bail here unless Embedded.
1938        if ( Module_Control::EXPERIENCE_EMBEDDED !== ( new Module_Control() )->get_experience() ) {
1939            return $template;
1940        }
1941        // Same empty-body bail-out for the generic shim. A saved empty
1942        // customization ('' vs null) is honored as intentional.
1943        if ( null === Search_Template::get_customized_content() && '' === static::get_classic_theme_search_body() ) {
1944            return $template;
1945        }
1946        return __DIR__ . '/templates/classic-theme-search.php';
1947    }
1948
1949    /**
1950     * Classic-theme search body — same markup as the block-theme path with
1951     * top-level `core/template-part` references stripped so the theme's
1952     * `get_header()` / `get_footer()` drive the chrome.
1953     *
1954     * Source of truth: customized `Search_Template` CPT → bundled `jetpack-search.html`.
1955     * Public because `templates/classic-theme-search.php` calls it from outside the class.
1956     *
1957     * @return string Block markup, no template-part wrappers.
1958     */
1959    public static function get_classic_theme_search_body(): string {
1960        $customized = Search_Template::get_customized_content();
1961        if ( null !== $customized ) {
1962            return $customized;
1963        }
1964        return static::strip_top_level_template_parts( static::get_search_template_content() );
1965    }
1966
1967    /**
1968     * Product-search counterpart to {@see get_classic_theme_search_body()} —
1969     * source of truth for the classic-theme product-results shim. Customized
1970     * `Product_Search_Template` CPT → bundled `jetpack-search-product-results.html`.
1971     * Public because `templates/classic-theme-product-search.php` calls it from
1972     * outside the class.
1973     *
1974     * @return string Block markup, no template-part wrappers.
1975     */
1976    public static function get_classic_theme_product_search_body(): string {
1977        $customized = Product_Search_Template::get_customized_content();
1978        if ( null !== $customized ) {
1979            return $customized;
1980        }
1981        return static::strip_top_level_template_parts( static::get_product_search_template_content() );
1982    }
1983
1984    /**
1985     * Strip top-level `core/template-part` self-closing comments — classic
1986     * themes can't resolve their slugs. Non-greedy `.*?` capped by `-->` keeps
1987     * matching cleanly across template revisions and across nested attribute
1988     * payloads.
1989     *
1990     * @param string $content Block markup, possibly empty.
1991     * @return string
1992     */
1993    protected static function strip_top_level_template_parts( string $content ): string {
1994        if ( '' === $content ) {
1995            return '';
1996        }
1997        return (string) preg_replace( '#<!--\s*wp:template-part\s+.*?/-->\s*#s', '', $content );
1998    }
1999
2000    /**
2001     * Inline layout `<style>` block the classic-theme shims emit before the
2002     * bundled block markup. Classic themes don't emit core's block-supports
2003     * layout CSS, so two traits the bundled templates rely on collapse on
2004     * classic themes: the inner group's 1.5rem `blockGap` vanishes (search
2005     * input runs straight into the results row), and `alignwide` has no
2006     * effect (content stretches edge-to-edge because `template_include`
2007     * bypasses the theme's own content wrapper). Reapplying both, scoped to
2008     * `<main class="wp-block-group">`, restores parity without leaking
2009     * outside the shim. Shared by both shims so a future layout tweak
2010     * touches one place. The `<style>` `id` is unique per render — routing
2011     * ensures only one shim runs per request, so duplicate IDs can't occur.
2012     *
2013     * Public because both `templates/classic-theme-search.php` and
2014     * `templates/classic-theme-product-search.php` call it from outside the
2015     * class.
2016     *
2017     * @return string Inline `<style>` element ready to echo.
2018     */
2019    public static function get_classic_theme_layout_style(): string {
2020        return <<<'HTML'
2021<style id="jetpack-search-classic-theme-layout">
2022main.wp-block-group {
2023    max-width: var(--wp--style--global--wide-size, 1280px);
2024    margin-inline: auto;
2025    padding-inline: clamp(1rem, 4vw, 2rem);
2026}
2027main.wp-block-group .is-layout-flow > * + * {
2028    margin-block-start: var(--wp--style--block-gap, 1.5rem);
2029}
2030</style>
2031HTML;
2032    }
2033
2034    /**
2035     * Test override for `block_templates_active()`. Null = read the live state.
2036     *
2037     * @var bool|null
2038     */
2039    private static $block_templates_active_for_testing = null;
2040
2041    /**
2042     * Test seam. Set true/false to force `block_templates_active()`, or null to clear.
2043     *
2044     * @param bool|null $active Forced value, or null to clear.
2045     */
2046    public static function set_block_templates_active_for_testing( ?bool $active ): void {
2047        self::$block_templates_active_for_testing = $active;
2048    }
2049
2050    /**
2051     * Whether the theme resolves block templates. Overridable seam over
2052     * `wp_is_block_theme()` for tests.
2053     *
2054     * @return bool
2055     */
2056    protected static function block_templates_active(): bool {
2057        if ( null !== self::$block_templates_active_for_testing ) {
2058            return self::$block_templates_active_for_testing;
2059        }
2060        return wp_is_block_theme();
2061    }
2062
2063    /**
2064     * Front the `jetpack-search-product-results` template for WC product
2065     * search. Drops WC's `product-search-results` and unshifts ours so it
2066     * resolves before any `jetpack-search` prepend for the generic route.
2067     *
2068     * @param string[] $templates Template hierarchy slugs.
2069     * @return string[]
2070     */
2071    public static function route_woocommerce_product_search_template( $templates ) {
2072        // FSE-hierarchy work — classic themes resolve template slugs as `{slug}.php`
2073        // and there's no `jetpack-search-product-results.php`. The classic-theme
2074        // equivalent runs through `route_classic_theme_search_template()` instead.
2075        if ( ! static::block_templates_active() || ! static::is_woocommerce_product_search() ) {
2076            return $templates;
2077        }
2078        $templates = array_values(
2079            array_filter(
2080                (array) $templates,
2081                static function ( $slug ) {
2082                    return self::WC_PRODUCT_SEARCH_TEMPLATE_SLUG !== $slug
2083                        && self::PRODUCT_SEARCH_TEMPLATE_SLUG !== $slug;
2084                }
2085            )
2086        );
2087        array_unshift( $templates, self::PRODUCT_SEARCH_TEMPLATE_SLUG );
2088        return $templates;
2089    }
2090
2091    /**
2092     * Seed the Interactivity API store with initial state. Per-block render
2093     * callbacks deep-merge their own entries on top (e.g. filter-checkbox
2094     * writes its filterConfig). See AGENTS.md § Hydration & SSR seeding.
2095     */
2096    public static function seed_interactivity_state() {
2097        if ( ! function_exists( 'wp_interactivity_state' ) ) {
2098            return;
2099        }
2100        wp_interactivity_state(
2101            'jetpack-search',
2102            static::build_seed_state( static::collect_filter_configs_from_post() )
2103        );
2104    }
2105
2106    /**
2107     * Compose the final seeded state for `wp_interactivity_state()`.
2108     *
2109     * @param array<string, array<string, mixed>> $filter_configs Map of filter configs.
2110     * @return array<string, mixed>
2111     */
2112    public static function build_seed_state( array $filter_configs ): array {
2113        $state                  = static::build_initial_state();
2114        $state['filterConfigs'] = $filter_configs;
2115        return $state;
2116    }
2117
2118    /**
2119     * Walk the current post's block tree for filter blocks and build the
2120     * filterConfigs map. Template-part scans are not performed — a filter
2121     * inside a template part still works, but its config isn't available to
2122     * the search-results SSR until hydration.
2123     *
2124     * @return array<string, array<string, mixed>>
2125     */
2126    protected static function collect_filter_configs_from_post(): array {
2127        if ( ! function_exists( 'get_post' ) || ! function_exists( 'parse_blocks' ) ) {
2128            return array();
2129        }
2130        // Bail if any helper is missing — half-loaded feature would ship inconsistent filterConfigs.
2131        $helpers = static::filter_block_helpers();
2132        foreach ( $helpers as $helper ) {
2133            if ( ! class_exists( $helper ) ) {
2134                return array();
2135            }
2136        }
2137        $post = get_post();
2138        if ( ! $post || empty( $post->post_content ) ) {
2139            return array();
2140        }
2141        if ( ! static::post_content_has_filter_block( $post, array_keys( $helpers ) ) ) {
2142            return array();
2143        }
2144        $configs = array();
2145        static::walk_blocks_for_filter_configs( parse_blocks( $post->post_content ), $configs );
2146        return $configs;
2147    }
2148
2149    /**
2150     * Does the post contain any of the given block names? SEARCH-295: a
2151     * has_block() scan to gate parse_blocks() on large, filter-less posts.
2152     *
2153     * @param \WP_Post $post        Post to scan.
2154     * @param string[] $block_names Block names to scan for.
2155     * @return bool
2156     */
2157    protected static function post_content_has_filter_block( \WP_Post $post, array $block_names ): bool {
2158        foreach ( $block_names as $block_name ) {
2159            if ( has_block( $block_name, $post ) ) {
2160                return true;
2161            }
2162        }
2163        return false;
2164    }
2165
2166    /**
2167     * Map of filter block name → helper class. Add a new filter block type
2168     * by appending one entry here.
2169     *
2170     * @return array<string, class-string>
2171     */
2172    protected static function filter_block_helpers(): array {
2173        $helpers = array(
2174            'jetpack-search/filter-checkbox'        => Filter_Checkbox::class,
2175            'jetpack-search/filter-date'            => Filter_Date::class,
2176            'jetpack-search/filter-wc-rating'       => Filter_Wc_Rating::class,
2177            'jetpack-search/filter-wc-attribute'    => Filter_Wc_Attribute::class,
2178            'jetpack-search/filter-wc-stock-status' => Search_Product_Filter_Status::class,
2179        );
2180        if ( self::woocommerce_blocks_enabled() ) {
2181            return $helpers;
2182        }
2183        // Non-Woo sites: drop WC-only entries so the filter-config walk stays
2184        // symmetric with what `register_blocks()` actually registered.
2185        foreach ( array_keys( $helpers ) as $name ) {
2186            if ( self::is_woocommerce_only_block( $name ) ) {
2187                unset( $helpers[ $name ] );
2188            }
2189        }
2190        return $helpers;
2191    }
2192
2193    /**
2194     * Recursively walk a parsed block tree, pushing each filter block's
2195     * config into `$configs` by reference.
2196     *
2197     * @param array $blocks  Parsed block tree from parse_blocks().
2198     * @param array $configs Accumulator map keyed by filterKey.
2199     * @return void
2200     */
2201    protected static function walk_blocks_for_filter_configs( array $blocks, array &$configs ): void {
2202        $helpers = static::filter_block_helpers();
2203        foreach ( $blocks as $block ) {
2204            if ( ! is_array( $block ) ) {
2205                continue;
2206            }
2207            $block_name = (string) ( $block['blockName'] ?? '' );
2208            if ( isset( $helpers[ $block_name ] ) ) {
2209                $helper = $helpers[ $block_name ];
2210                $attrs  = (array) ( $block['attrs'] ?? array() );
2211                $key    = $helper::derive_filter_key( $attrs );
2212                if ( '' !== $key ) {
2213                    $configs[ $key ] = $helper::build_config( $attrs, $key );
2214                }
2215            }
2216
2217            if ( ! empty( $block['innerBlocks'] ) && is_array( $block['innerBlocks'] ) ) {
2218                static::walk_blocks_for_filter_configs( $block['innerBlocks'], $configs );
2219            }
2220        }
2221    }
2222
2223    /**
2224     * Build the initial state array for the jetpack-search Interactivity API store.
2225     *
2226     * @return array<string, mixed>
2227     */
2228    public static function build_initial_state() {
2229        $is_private                = class_exists( Status::class ) ? ( new Status() )->is_private_site() : false;
2230        $is_wpcom                  = class_exists( Helper::class ) ? Helper::is_wpcom() : false;
2231        $site_id                   = class_exists( Helper::class ) ? Helper::get_wpcom_site_id() : 0;
2232        $is_jetpack_photon_enabled = method_exists( 'Jetpack', 'is_module_active' ) && \Jetpack::is_module_active( 'photon' );
2233        $search_query              = static::parse_url_search_query();
2234        $active_filters            = static::parse_url_filters();
2235        $filter_logic              = static::parse_url_filter_logic( $active_filters );
2236        $price_range               = static::parse_url_price_range();
2237        $is_initial_loading        = static::is_initial_loading();
2238        $searching_text            = function_exists( '__' ) ? __( 'Searching…', 'jetpack-search-pkg' ) : 'Searching…';
2239        $query_options             = static::get_instant_search_query_options();
2240
2241        return array(
2242            // Connection / routing config.
2243            'siteId'                     => $site_id,
2244            'apiRoot'                    => function_exists( 'rest_url' ) ? esc_url_raw( rest_url() ) : '',
2245            'nonce'                      => function_exists( 'wp_create_nonce' ) ? wp_create_nonce( 'wp_rest' ) : '',
2246            'isPrivateSite'              => $is_private,
2247            'isWpcom'                    => $is_wpcom,
2248            'isPhotonEnabled'            => ( $is_wpcom || $is_jetpack_photon_enabled ) && ! $is_private,
2249            // TrainTracks gate, mirroring instant search's `disableTracking`
2250            // (Helper::get_search_options): suppresses `_tkq` pushes for
2251            // `?disable_tracking=1` crawlers/QA and the filter override.
2252            'disableTracking'            => static::is_tracking_disabled(),
2253            // Threaded through url-state so `?orderby=price_asc` round-trips on Woo only.
2254            'isWooCommerceBlocksEnabled' => self::woocommerce_blocks_enabled(),
2255            'homeUrl'                    => function_exists( 'home_url' ) ? home_url() : '',
2256            // Blog locale (not viewer's profile locale) for consistent
2257            // logged-out formatting. BCP47-ish (`en-US`).
2258            'locale'                     => function_exists( 'get_locale' )
2259                ? str_replace( '_', '-', get_locale() )
2260                : 'en-US',
2261            // PHP-style token string parsed client-side by `wp-date-format.js`
2262            // (IA view bundle can't import `@wordpress/date`). Empty → Intl fallback.
2263            'dateFormat'                 => function_exists( 'get_option' )
2264                ? (string) get_option( 'date_format', '' )
2265                : '',
2266
2267            // URL-seeded so deep links render on first paint.
2268            'searchQuery'                => $search_query,
2269            // `?s=` (empty value) must still fire the initial fetch; `searchQuery`
2270            // alone collapses present-but-empty and missing to `''`.
2271            'hasSearchParam'             => static::has_search_param(),
2272            'searchParamName'            => static::get_search_param_name(),
2273            'sortOrder'                  => static::parse_url_sort(),
2274            'activeFilters'              => $active_filters,
2275            'filterLogic'                => $filter_logic,
2276            'priceRange'                 => $price_range,
2277            // Scalar `?filter_id=value`; seeded as `{}` so JS readers see a defined shape.
2278            'staticFilterSelections'     => (object) array(),
2279
2280            // Each filter block's render.php deep-merges its entry. Shape:
2281            // `{ [key]: { filterKey, filterType, taxonomy, effectiveSlug, label, showCount, maxItems } }`.
2282            'filterConfigs'              => array(),
2283
2284            // JS hydration fills these. `aggregations` is stdClass so JS sees `{}`.
2285            'results'                    => array(),
2286            'aggregations'               => (object) array(),
2287            // See AGENTS.md § Filter bucket lifecycle.
2288            'retainedFilterOptions'      => (object) array(),
2289            'totalResults'               => 0,
2290            'pageHandle'                 => null,
2291
2292            // `isLoading` true on deep links keeps the empty-state hidden until
2293            // JS fires the initial fetch (otherwise "No results found" flashes).
2294            'isLoading'                  => $is_initial_loading,
2295            'isLoadingMore'              => false,
2296            'hasError'                   => false,
2297
2298            // Seeded so SSR resolves `data-wp-text` on first paint.
2299            'resultsCountText'           => $is_initial_loading ? $searching_text : '',
2300
2301            'strings'                    => static::build_initial_strings(),
2302            'priceCurrencySymbol'        => '$',
2303
2304            // Top-level (not under `strings`) — keeps Phan's `array<string,string>`
2305            // contract on `strings` intact.
2306            'aiExtendedLoadingHints'     => static::build_ai_extended_loading_hints(),
2307
2308            'wcStockStatusLabels'        => static::build_stock_status_labels(),
2309
2310            // Query customization from `jetpack_instant_search_options` — same
2311            // keys Instant Search / Inline Search honor, so Embedded and the
2312            // blocks Overlay stay compatible with those filters.
2313            'highlightPhraseOnly'        => $query_options['highlightPhraseOnly'],
2314            'highlightFilterStopwords'   => $query_options['highlightFilterStopwords'],
2315            'highlightFields'            => $query_options['highlightFields'],
2316            'additionalBlogIds'          => $query_options['additionalBlogIds'],
2317            'adminQueryFilter'           => $query_options['adminQueryFilter'],
2318            'customResults'              => $query_options['customResults'],
2319        );
2320    }
2321
2322    /**
2323     * Read Instant Search query-customization options for the blocks store.
2324     *
2325     * @since 7.4.0
2326     *
2327     * @return array Query options with keys:
2328     *               `highlightPhraseOnly`, `highlightFilterStopwords`, `highlightFields`,
2329     *               `additionalBlogIds`, `adminQueryFilter`, and `customResults`.
2330     */
2331    public static function get_instant_search_query_options(): array {
2332        return Helper::get_instant_search_query_options();
2333    }
2334
2335    /**
2336     * Slug → display-label map for `wc_stock_status` selections, used by the
2337     * active-filters block for product-aware chips. RSM-1932 will swap this
2338     * for WC's translated labels (`wc_get_product_stock_status_options()`)
2339     * without changing the shape. Empty when the status helper isn't loaded.
2340     *
2341     * @return array<string, string>
2342     */
2343    protected static function build_stock_status_labels(): array {
2344        if ( ! class_exists( Search_Product_Filter_Status::class ) ) {
2345            return array();
2346        }
2347        $labels = array();
2348        foreach ( Search_Product_Filter_Status::get_options() as $option ) {
2349            $value = (string) ( $option['value'] ?? '' );
2350            if ( '' === $value ) {
2351                continue;
2352            }
2353            $labels[ $value ] = (string) ( $option['label'] ?? $value );
2354        }
2355        return $labels;
2356    }
2357
2358    /**
2359     * Every block directory to register, parents first then their children.
2360     *
2361     * A block directory may nest child blocks that only ever render inside it
2362     * (`no-results/slot`). They live there rather than beside their parent so
2363     * the relationship is obvious in the tree, and they inherit the parent's
2364     * WooCommerce gating for free — a skipped parent is never descended into.
2365     *
2366     * @internal Public only so the registration walk can be asserted directly.
2367     *
2368     * @return string[] Absolute directory paths, each holding a `block.json`.
2369     */
2370    public static function block_directories(): array {
2371        $block_dirs = glob( __DIR__ . '/blocks/*', GLOB_ONLYDIR );
2372        if ( ! $block_dirs ) {
2373            return array();
2374        }
2375
2376        $wc_blocks_enabled = self::woocommerce_blocks_enabled();
2377        $directories       = array();
2378        foreach ( $block_dirs as $block_dir ) {
2379            if ( ! file_exists( $block_dir . '/block.json' ) ) {
2380                continue;
2381            }
2382            if ( ! $wc_blocks_enabled && self::is_woocommerce_only_block( basename( $block_dir ) ) ) {
2383                continue;
2384            }
2385            $directories[] = $block_dir;
2386
2387            foreach ( (array) glob( $block_dir . '/*', GLOB_ONLYDIR ) as $child_dir ) {
2388                if ( file_exists( $child_dir . '/block.json' ) ) {
2389                    $directories[] = $child_dir;
2390                }
2391            }
2392        }
2393
2394        return $directories;
2395    }
2396
2397    /**
2398     * Whether the URL carries a search query, filter, or price range — i.e.
2399     * the JS store will fire an initial fetch on hydration. Render callbacks
2400     * use this to emit pre-hydration affordances (skeleton, "Searching…").
2401     *
2402     * URL-derived rather than read back from `wp_interactivity_state()`
2403     * because FSE pre-resolves block attributes before `wp_enqueue_scripts`
2404     * fires, so a state-read would silently return false on the very pages
2405     * this is meant to flag. Mirrors the `isLoading` seed exactly.
2406     *
2407     * @return bool
2408     */
2409    public static function is_initial_loading(): bool {
2410        if ( null !== self::$is_initial_loading_cache ) {
2411            return self::$is_initial_loading_cache;
2412        }
2413        // `has_search_param()` not `parse_url_search_query() !== ''` — an
2414        // explicit `?s=` (empty value) still means "visitor landed on a
2415        // search page" and should fire an unfiltered initial fetch.
2416        if ( static::has_search_param() ) {
2417            self::$is_initial_loading_cache = true;
2418            return true;
2419        }
2420        if ( ! empty( static::parse_url_filters() ) ) {
2421            self::$is_initial_loading_cache = true;
2422            return true;
2423        }
2424        self::$is_initial_loading_cache = null !== static::parse_url_price_range();
2425        return self::$is_initial_loading_cache;
2426    }
2427
2428    /**
2429     * Reset the `is_initial_loading()` memo. Tests only — PHPUnit reuses a
2430     * single process so `$_GET` from an earlier test would pin the value.
2431     * Guarded against accidental production use.
2432     */
2433    public static function reset_initial_loading_cache(): void {
2434        if ( defined( 'ABSPATH' ) && ! defined( 'PHPUNIT_COMPOSER_INSTALL' ) ) {
2435            return;
2436        }
2437        self::$is_initial_loading_cache = null;
2438    }
2439
2440    /**
2441     * Pre-hydration view state for a filter block's wrapper. Centralizes the
2442     * seeded-state read shared by filter-checkbox and filter-date so each
2443     * render.php branches on a single struct rather than re-deriving the
2444     * same flags inline.
2445     *
2446     * @param string $filter_key The filter key (e.g. `category`, `post_type`).
2447     * @return array{has_buckets:bool,is_initial_loading:bool,show_wrapper:bool}
2448     */
2449    public static function pre_hydration_filter_view( string $filter_key ): array {
2450        if ( ! function_exists( 'wp_interactivity_state' ) ) {
2451            return array(
2452                'has_buckets'        => false,
2453                'is_initial_loading' => false,
2454                'show_wrapper'       => false,
2455            );
2456        }
2457        // `aggregations` is seeded as `stdClass` when empty (so JS sees `{}`,
2458        // not `[]`); cast before subscripting so the read works in either shape.
2459        $state              = wp_interactivity_state( 'jetpack-search' );
2460        $aggs               = (array) ( $state['aggregations'] ?? array() );
2461        $has_buckets        = ! empty( $aggs[ $filter_key ]['buckets'] ?? array() );
2462        $is_initial_loading = static::is_initial_loading();
2463        return array(
2464            'has_buckets'        => $has_buckets,
2465            'is_initial_loading' => $is_initial_loading,
2466            'show_wrapper'       => $has_buckets || $is_initial_loading,
2467        );
2468    }
2469
2470    /**
2471     * Emit the `data-wp-context` attribute for a filter block's wrapper. The
2472     * seeded `wrapperHidden` value is what the IA SSR pass evaluates
2473     * `data-wp-bind--hidden="context.wrapperHidden"` against, and what the
2474     * `syncFilterWrapperVisibility` callback updates after hydration.
2475     *
2476     * @param string $filter_key   The filter key.
2477     * @param bool   $show_wrapper Whether the wrapper should be visible on first paint.
2478     */
2479    public static function emit_filter_wrapper_context( string $filter_key, bool $show_wrapper ): void {
2480        if ( ! function_exists( 'wp_interactivity_data_wp_context' ) ) {
2481            return;
2482        }
2483        echo wp_kses_data(
2484            wp_interactivity_data_wp_context(
2485                array(
2486                    'filterKey'     => $filter_key,
2487                    'wrapperHidden' => ! $show_wrapper,
2488                )
2489            )
2490        );
2491    }
2492
2493    /**
2494     * Normalize the shared `displayStyle` attribute to one of the two CSS
2495     * variants. `filter-wc-stock-status` and `filter-wc-rating` deliberately
2496     * don't ship a chip variant and don't call this helper.
2497     *
2498     * @param mixed $value Raw attribute value.
2499     * @return string Either 'checkbox-list' or 'chips'.
2500     */
2501    public static function normalize_display_style( $value ): string {
2502        return 'chips' === $value ? 'chips' : 'checkbox-list';
2503    }
2504
2505    /**
2506     * Seed translated view-bundle strings for the Interactivity API store.
2507     *
2508     * @return array<string, string>
2509     */
2510    protected static function build_initial_strings(): array {
2511        if ( ! function_exists( '__' ) || ! function_exists( '_n' ) ) {
2512            return array(
2513                'searching'               => 'Searching…',
2514                'resultsCountSingle'      => 'Found %d result',
2515                'resultsCountPlural'      => 'Found %d results',
2516                'removeFilter'            => 'Remove %s',
2517                'ratingStarsTop'          => '5 stars',
2518                'ratingStarsAndUpSingle'  => '%d star and up',
2519                'ratingStarsAndUpPlural'  => '%d stars and up',
2520                'priceRangeFromTo'        => '%1$s – %2$s',
2521                'priceRangeFrom'          => '%s+',
2522                'priceRangeUpTo'          => 'Under %s',
2523                'priceLabel'              => 'Price',
2524                'suggestionLabelQuery'    => 'Suggestions',
2525                'suggestionLabelTaxonomy' => 'Popular Filters',
2526                'suggestionLabelPost'     => 'Articles',
2527                'aiErrorMessage'          => 'Sorry, an error occurred while generating an answer.',
2528                'aiErrorCode'             => 'Error code: %s',
2529            );
2530        }
2531        return array(
2532            'searching'               => __( 'Searching…', 'jetpack-search-pkg' ),
2533            /* translators: %d: number of results. */
2534            'resultsCountSingle'      => _n( 'Found %d result', 'Found %d results', 1, 'jetpack-search-pkg' ),
2535            /* translators: %d: number of results. */
2536            'resultsCountPlural'      => _n( 'Found %d result', 'Found %d results', 2, 'jetpack-search-pkg' ),
2537            /* translators: %s: filter label (e.g. "Category: News"). Announced by screen readers when focus lands on a filter pill's remove button. */
2538            'removeFilter'            => __( 'Remove %s', 'jetpack-search-pkg' ),
2539            /* translators: Active-filter chip label for the 5-star row. The 5-star row is "exactly 5 stars" — no "& up" affordance — because there is no higher rating. Mirrors the row's aria-label in filter-wc-rating/render.php. */
2540            'ratingStarsTop'          => __( '5 stars', 'jetpack-search-pkg' ),
2541            /* translators: %d: rating threshold (singular form, i.e. 1). Active-filter chip label for the "1 star and up" threshold row. Mirrors the row's aria-label in filter-wc-rating/render.php. */
2542            'ratingStarsAndUpSingle'  => _n( '%d star and up', '%d stars and up', 1, 'jetpack-search-pkg' ),
2543            /* translators: %d: rating threshold (plural form, i.e. 2-4). Active-filter chip label for the "X stars and up" threshold rows. Mirrors the row's aria-label in filter-wc-rating/render.php. */
2544            'ratingStarsAndUpPlural'  => _n( '%d star and up', '%d stars and up', 2, 'jetpack-search-pkg' ),
2545            /* translators: 1: minimum price (already includes the currency symbol). 2: maximum price (already includes the currency symbol). Renders an active "Price: $10 – $50" filter pill. */
2546            'priceRangeFromTo'        => __( '%1$s – %2$s', 'jetpack-search-pkg' ),
2547            /* translators: %s: minimum price (already includes the currency symbol). Renders an active "Price: $10+" filter pill (no upper bound) — compact "and above" form aligned with mainstream e-commerce filter chips. */
2548            'priceRangeFrom'          => __( '%s+', 'jetpack-search-pkg' ),
2549            /* translators: %s: maximum price (already includes the currency symbol). Renders an active "Price: Under $50" filter pill (no lower bound) — mirrors Amazon/eBay/Walmart's "Under $X" convention. */
2550            'priceRangeUpTo'          => __( 'Under %s', 'jetpack-search-pkg' ),
2551            /* translators: Group label for the price filter pill ("Price: $10 – $50"). Mirrors the price block's default heading; falls back to this when no price block is on the page. */
2552            'priceLabel'              => __( 'Price', 'jetpack-search-pkg' ),
2553            /* translators: Group label for the typed-query suggestions section of the Search Input autocomplete dropdown. */
2554            'suggestionLabelQuery'    => __( 'Suggestions', 'jetpack-search-pkg' ),
2555            /* translators: Group label for the taxonomy (category / tag) section of the Search Input autocomplete dropdown. */
2556            'suggestionLabelTaxonomy' => __( 'Popular Filters', 'jetpack-search-pkg' ),
2557            /* translators: Group label for the post-title section of the Search Input autocomplete dropdown. */
2558            'suggestionLabelPost'     => __( 'Articles', 'jetpack-search-pkg' ),
2559            /* translators: Heading shown on the AI Answer panel when the agent endpoint returns an error. The technical message + HTTP/JSON-RPC code render below this string. */
2560            'aiErrorMessage'          => __( 'Sorry, an error occurred while generating an answer.', 'jetpack-search-pkg' ),
2561            /* translators: %s: numeric error code. Surfaces the HTTP / JSON-RPC code that came back with the AI Answer failure, under the technical message. */
2562            'aiErrorCode'             => __( 'Error code: %s', 'jetpack-search-pkg' ),
2563        );
2564    }
2565
2566    /**
2567     * Rotating loading hints for the "Show more" extended AI answer.
2568     * Mirrors the overlay verbatim so visitors switching surfaces see
2569     * the same copy.
2570     *
2571     * @return array<int, string>
2572     */
2573    protected static function build_ai_extended_loading_hints(): array {
2574        // Strings omit trailing `…` — render.php appends an animated ellipsis,
2575        // so a static one would double up. Overlay does the same.
2576        if ( ! function_exists( '__' ) ) {
2577            return array(
2578                'Searching harder',
2579                'Looking deeper into this',
2580                'Finding a more complete answer',
2581                'Analyzing additional sources',
2582                'Gathering more details',
2583                'Pulling in more context',
2584                'Expanding the search',
2585                'Rolling up my virtual sleeves',
2586                'Digging through the archives',
2587                'Putting on my reading glasses',
2588                'Checking under the digital couch cushions',
2589                'Consulting the oracle',
2590                'Asking a smarter algorithm',
2591                'Brewing a fresh batch of insights',
2592                'Unleashing the full power of search',
2593            );
2594        }
2595        return array(
2596            __( 'Searching harder', 'jetpack-search-pkg' ),
2597            __( 'Looking deeper into this', 'jetpack-search-pkg' ),
2598            __( 'Finding a more complete answer', 'jetpack-search-pkg' ),
2599            __( 'Analyzing additional sources', 'jetpack-search-pkg' ),
2600            __( 'Gathering more details', 'jetpack-search-pkg' ),
2601            __( 'Pulling in more context', 'jetpack-search-pkg' ),
2602            __( 'Expanding the search', 'jetpack-search-pkg' ),
2603            __( 'Rolling up my virtual sleeves', 'jetpack-search-pkg' ),
2604            __( 'Digging through the archives', 'jetpack-search-pkg' ),
2605            __( 'Putting on my reading glasses', 'jetpack-search-pkg' ),
2606            __( 'Checking under the digital couch cushions', 'jetpack-search-pkg' ),
2607            __( 'Consulting the oracle', 'jetpack-search-pkg' ),
2608            __( 'Asking a smarter algorithm', 'jetpack-search-pkg' ),
2609            __( 'Brewing a fresh batch of insights', 'jetpack-search-pkg' ),
2610            __( 'Unleashing the full power of search', 'jetpack-search-pkg' ),
2611        );
2612    }
2613
2614    /**
2615     * Parse the search query from the URL using whichever key
2616     * `get_search_param_name()` returns (`s` on search routes, `q` elsewhere).
2617     * Public so render templates can seed their input from the same source.
2618     *
2619     * @return string
2620     */
2621    public static function parse_url_search_query(): string {
2622        $key = self::get_search_param_name();
2623        // phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized,WordPress.Security.ValidatedSanitizedInput.MissingUnslash -- read-only URL state; coerced to string + sanitize_text_field( wp_unslash( ... ) ) on the next line.
2624        $raw = $_GET[ $key ] ?? '';
2625        if ( ! is_scalar( $raw ) ) {
2626            return '';
2627        }
2628        return trim( sanitize_text_field( wp_unslash( (string) $raw ) ) );
2629    }
2630
2631    /**
2632     * Whether the search-query key is present in `$_GET` (any value).
2633     * Distinguishes `?s=` (blank search) from a URL that omits the key —
2634     * `parse_url_search_query()` collapses both to `''`. Array-shaped
2635     * `?s[]=foo` reads as "not present" to stay in lockstep.
2636     *
2637     * @return bool
2638     */
2639    public static function has_search_param(): bool {
2640        $key = self::get_search_param_name();
2641        // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- read-only URL presence check; the value is never read here.
2642        return isset( $_GET[ $key ] ) && is_scalar( $_GET[ $key ] );
2643    }
2644
2645    /**
2646     * Parse the sort order from the URL, defaulting to 'relevance'. Allowed
2647     * values track `Results_Sort::get_all_option_keys()` — on non-Woo sites
2648     * a `?orderby=price_asc` deep link collapses to `relevance` (mirrors
2649     * `store/url-state.js`).
2650     *
2651     * @return string
2652     */
2653    protected static function parse_url_sort(): string {
2654        // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- read-only URL state.
2655        $orderby = isset( $_GET['orderby'] ) ? sanitize_key( wp_unslash( $_GET['orderby'] ) ) : '';
2656        $allowed = array_values(
2657            array_filter(
2658                Results_Sort::get_all_option_keys(),
2659                static function ( $key ) {
2660                    return 'relevance' !== $key;
2661                }
2662            )
2663        );
2664        return in_array( $orderby, $allowed, true ) ? $orderby : 'relevance';
2665    }
2666
2667    /**
2668     * Parse the price range from the URL. Mirrors `store/url-state.js`.
2669     * Either bound may be null for a half-open range; non-numeric or
2670     * negative values null out. Returns null entirely on non-Woo sites —
2671     * `min_price`/`max_price` are WC-only and a stray param shouldn't drive
2672     * the API into a `range` clause for a field the index doesn't have.
2673     *
2674     * @return array{min: float|null, max: float|null}|null
2675     */
2676    protected static function parse_url_price_range(): ?array {
2677        if ( ! self::woocommerce_blocks_enabled() ) {
2678            return null;
2679        }
2680        // phpcs:disable WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized,WordPress.Security.ValidatedSanitizedInput.MissingUnslash -- coerced to float in parse_price_bound().
2681        $min = self::parse_price_bound( $_GET['min_price'] ?? null );
2682        $max = self::parse_price_bound( $_GET['max_price'] ?? null );
2683        // phpcs:enable
2684
2685        if ( null === $min && null === $max ) {
2686            return null;
2687        }
2688        // Inverted bounds → empty ES `range` clause / zero results silently.
2689        // Treat as garbage and bail so the page falls back to unfiltered search.
2690        if ( null !== $min && null !== $max && $min > $max ) {
2691            return null;
2692        }
2693        return array(
2694            'min' => $min,
2695            'max' => $max,
2696        );
2697    }
2698
2699    /**
2700     * Coerce a single price-range URL value into a finite, non-negative float.
2701     *
2702     * @param mixed $raw Raw value pulled from $_GET.
2703     * @return float|null
2704     */
2705    private static function parse_price_bound( $raw ): ?float {
2706        if ( null === $raw || '' === $raw || ! is_scalar( $raw ) ) {
2707            return null;
2708        }
2709        // `is_numeric` keeps PHP in lockstep with JS's `Number()`: rejects
2710        // partially-numeric strings ("1.5.3") that `(float)` would silently
2711        // extract as `1.5` while `Number()` returns `NaN`.
2712        $raw = wp_unslash( $raw );
2713        if ( ! is_numeric( $raw ) ) {
2714            return null;
2715        }
2716        $num = (float) $raw;
2717        if ( ! is_finite( $num ) || $num < 0 ) {
2718            return null;
2719        }
2720        return $num;
2721    }
2722
2723    /**
2724     * Parse `?<filterKey>[]=<value>` URL params into `{ [filterKey]: string[] }`.
2725     * Mirrors the shape `store/url-state.js` writes (see AGENTS.md § URL format).
2726     * No registered-key filtering here — `filterConfigs` aren't available until
2727     * blocks render. The JS layer gates on hydration.
2728     *
2729     * Scalar `?post_type=<slug>` is also accepted as a shortcut for
2730     * `?post_types[]=<slug>` — matches WP/WC's own URL convention. Merged into
2731     * any existing array selections so `?post_type=foo&post_types[]=bar` reads
2732     * as `[foo, bar]`. Singular-form-on-an-array-key keeps its existing
2733     * "ignored noise" behaviour for every other filter.
2734     *
2735     * @return array<string, string[]>
2736     */
2737    protected static function parse_url_filters(): array {
2738        // phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- read-only URL state; sanitized per-value below.
2739        $raw = wp_unslash( $_GET );
2740        if ( ! is_array( $raw ) ) {
2741            return array();
2742        }
2743
2744        $out = array();
2745        foreach ( $raw as $key => $values ) {
2746            $filter_key = sanitize_key( (string) $key );
2747            if ( '' === $filter_key || in_array( $filter_key, self::RESERVED_QUERY_PARAMS, true ) ) {
2748                continue;
2749            }
2750            if ( 'post_type' === $filter_key ) {
2751                // `is_string` (not `is_scalar`) keeps the gate consistent with
2752                // `parse_url_filter_logic`'s value check — `$_GET` only ever
2753                // carries strings or arrays, and the array case takes the
2754                // `is_array( $values )` branch immediately below.
2755                if ( ! is_string( $values ) ) {
2756                    continue;
2757                }
2758                // `sanitize_key`, not `sanitize_text_field` — post-type slugs are
2759                // always lowercase + `[a-z0-9_-]`; the lowercase pass keeps a
2760                // `?post_type=Product` URL from reaching ES with the wrong case
2761                // and silently returning zero results.
2762                $slug = sanitize_key( $values );
2763                if ( '' === $slug ) {
2764                    continue;
2765                }
2766                $existing          = $out['post_types'] ?? array();
2767                $out['post_types'] = array_values( array_unique( array_merge( $existing, array( $slug ) ) ) );
2768                continue;
2769            }
2770            if ( ! is_array( $values ) ) {
2771                continue;
2772            }
2773            $clean = array_values(
2774                array_filter(
2775                    array_map( 'sanitize_text_field', $values ),
2776                    static function ( $v ) {
2777                        return '' !== $v;
2778                    }
2779                )
2780            );
2781            if ( $clean ) {
2782                $existing           = $out[ $filter_key ] ?? array();
2783                $out[ $filter_key ] = array_values( array_unique( array_merge( $existing, $clean ) ) );
2784            }
2785        }
2786        return $out;
2787    }
2788
2789    /**
2790     * Parse `?query_type_<key>=and` overrides into `{ [filterKey]: 'and' }`.
2791     * Only literal `'and'` is honoured — anything else is dropped so it
2792     * can't round-trip back through `pushStateToUrl`. Mirrors
2793     * `store/url-state.js`.
2794     *
2795     * @param array<string, string[]> $active_filters Result of parse_url_filters().
2796     * @return array<string, string>
2797     */
2798    protected static function parse_url_filter_logic( array $active_filters ): array {
2799        // phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- read-only URL state; sanitized per-value below.
2800        $raw = wp_unslash( $_GET );
2801        if ( ! is_array( $raw ) ) {
2802            return array();
2803        }
2804
2805        $out = array();
2806        foreach ( $raw as $key => $value ) {
2807            if ( ! is_string( $key ) || 0 !== strpos( $key, 'query_type_' ) ) {
2808                continue;
2809            }
2810            if ( ! is_string( $value ) || 'and' !== $value ) {
2811                continue;
2812            }
2813            $filter_key = sanitize_key( substr( $key, strlen( 'query_type_' ) ) );
2814            if ( '' === $filter_key || in_array( $filter_key, self::RESERVED_QUERY_PARAMS, true ) ) {
2815                continue;
2816            }
2817            if ( empty( $active_filters[ $filter_key ] ) ) {
2818                continue;
2819            }
2820            $out[ $filter_key ] = 'and';
2821        }
2822        return $out;
2823    }
2824}