Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
72.86%
596 / 818
57.50%
46 / 80
 CRAP
0.00%
0 / 1
Search_Blocks
72.86%
596 / 818
57.50%
46 / 80
 1871.63
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
0.00%
0 / 1
0.00%
0 / 1
 2
 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
83.33%
15 / 18
0.00%
0 / 1
 4.07
 get_search_param_name
100.00%
1 / 1
100.00%
1 / 1
 3
 enqueue_editor_assets
0.00%
0 / 29
0.00%
0 / 1
 6
 register_block_category
0.00%
0 / 8
0.00%
0 / 1
 12
 register_blocks
0.00%
0 / 19
0.00%
0 / 1
 56
 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
0.00%
0 / 3
0.00%
0 / 1
 6
 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
0.00%
0 / 11
0.00%
0 / 1
 56
 filter_block_helpers
100.00%
13 / 13
100.00%
1 / 1
 4
 walk_blocks_for_filter_configs
0.00%
0 / 13
0.00%
0 / 1
 56
 build_initial_state
100.00%
47 / 47
100.00%
1 / 1
 11
 build_stock_status_labels
77.78%
7 / 9
0.00%
0 / 1
 4.18
 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 = $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     * @return string
635     */
636    public static function get_search_param_name(): string {
637        return function_exists( 'is_search' ) && is_search() ? 's' : self::NON_SEARCH_QUERY_PARAM;
638    }
639
640    /**
641     * Enqueue the client-side block registration bundle in the block editor.
642     *
643     * WP bootstraps server-side block metadata into the editor, but each block
644     * still needs a client-side `registerBlockType()` call so the editor knows
645     * how to render a preview. This script does that with ServerSideRender.
646     */
647    public static function enqueue_editor_assets() {
648        $base_path  = Package::get_installed_path() . 'build/search-blocks-editor/';
649        $asset_file = $base_path . 'register-blocks.asset.php';
650        if ( ! file_exists( $asset_file ) ) {
651            return;
652        }
653        $asset = require $asset_file;
654
655        // `plugins_url()` resolves against the nearest plugin directory, which
656        // handles the `jetpack_vendor` location Composer installs into.
657        $url = plugins_url( 'register-blocks.js', $base_path . 'register-blocks.js' );
658
659        wp_enqueue_script(
660            'jetpack-search-blocks-register',
661            $url,
662            $asset['dependencies'] ?? array(),
663            $asset['version'] ?? false,
664            true
665        );
666
667        // Surface PHP gates to the editor bundle so block edits and the
668        // registration loop branch consistently with server-side renders.
669        // `wp_add_inline_script` (not `wp_localize_script`) per core #25280 —
670        // the latter HTML-encodes ampersands inside nested values.
671        wp_add_inline_script(
672            'jetpack-search-blocks-register',
673            'window.JetpackSearchBlocksConfig = ' . wp_json_encode(
674                array(
675                    'isWooCommerceBlocksEnabled' => self::woocommerce_blocks_enabled(),
676                    'woocommerceOnlyBlocks'      => self::woocommerce_only_block_names(),
677                    'supportsPaidSearch'         => self::supports_paid_search(),
678                    'supportedCustomTaxonomies'  => self::supported_custom_taxonomies(),
679                    'customTaxonomyMap'          => (object) self::custom_taxonomy_map(),
680                    // Resolved the same way `search-results/render.php` resolves the
681                    // live value, so the editor placeholder never claims a default
682                    // visitors won't actually get.
683                    'defaultResultsPerPage'      => Helper::resolve_results_per_page(),
684                    'maxResultsPerPage'          => Helper::get_max_posts_per_page(),
685                ),
686                JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP
687            ) . ';',
688            'before'
689        );
690    }
691
692    /**
693     * Add a "Jetpack Search" block category so our blocks appear under that
694     * heading in the inserter instead of "Uncategorized".
695     *
696     * @param array $categories Existing block categories.
697     * @return array
698     */
699    public static function register_block_category( $categories ) {
700        foreach ( $categories as $category ) {
701            if ( 'jetpack-search' === ( $category['slug'] ?? '' ) ) {
702                return $categories;
703            }
704        }
705        $categories[] = array(
706            'slug'  => 'jetpack-search',
707            'title' => __( 'Jetpack Search', 'jetpack-search-pkg' ),
708        );
709        return $categories;
710    }
711
712    /**
713     * Register all search blocks from their block.json files.
714     */
715    public static function register_blocks() {
716        // Register block pattern category first so patterns can reference it.
717        if ( function_exists( 'register_block_pattern_category' ) ) {
718            register_block_pattern_category(
719                'jetpack-search',
720                array( 'label' => __( 'Jetpack Search', 'jetpack-search-pkg' ) )
721            );
722        }
723
724        self::register_store_script_module();
725
726        $blocks_dir = __DIR__ . '/blocks';
727        $block_dirs = glob( $blocks_dir . '/*', GLOB_ONLYDIR );
728
729        if ( ! $block_dirs ) {
730            return;
731        }
732
733        $wc_blocks_enabled = self::woocommerce_blocks_enabled();
734        foreach ( $block_dirs as $block_dir ) {
735            if ( ! file_exists( $block_dir . '/block.json' ) ) {
736                continue;
737            }
738            if ( ! $wc_blocks_enabled && self::is_woocommerce_only_block( basename( $block_dir ) ) ) {
739                continue;
740            }
741            register_block_type( $block_dir );
742        }
743
744        add_filter( 'get_block_type_variations', array( static::class, 'inject_filter_checkbox_variations' ), 10, 2 );
745        static::register_patterns();
746    }
747
748    /**
749     * Register the shared store as the `jetpack-search/store` Script Module.
750     * See AGENTS.md § Shared store / bundles for why this is externalized.
751     */
752    public static function register_store_script_module() {
753        if ( ! function_exists( 'wp_register_script_module' ) ) {
754            return;
755        }
756
757        $base_path  = Package::get_installed_path() . 'build/search-blocks/store/';
758        $asset_file = $base_path . 'index.asset.php';
759        if ( ! file_exists( $asset_file ) ) {
760            return;
761        }
762        $asset = require $asset_file;
763
764        wp_register_script_module(
765            'jetpack-search/store',
766            plugins_url( 'index.js', $base_path . 'index.js' ),
767            $asset['dependencies'] ?? array(),
768            $asset['version'] ?? false
769        );
770    }
771
772    /**
773     * Relativize Jetpack Search Script Module URLs so the browser fetches them
774     * same-origin with the page.
775     *
776     * `wp_register_script_module()` resolves src via `plugins_url()`, which
777     * returns the canonical `site_url()` host. When a visitor is on a
778     * different host (Multisite mapped domains, www vs non-www without a
779     * canonical redirect, asset-offload plugins, reverse-proxy staging) the
780     * `<script type="module">` becomes cross-origin and is blocked with
781     * `MissingAllowOriginHeader` — ES modules always go through the CORS
782     * algorithm, even without a `crossorigin` attribute, and typical WP
783     * hosts don't send `Access-Control-Allow-Origin` for `wp-content/*`.
784     *
785     * Stripping scheme + host with `wp_make_link_relative()` lets the browser
786     * resolve against the page's actual origin. No `$_SERVER['HTTP_HOST']`
787     * trust — emitting an attacker-controllable host into a `<script src>`
788     * would be a cache-poisoning vector.
789     *
790     * No-op when the src host is a deliberately external host (CDN that
791     * doesn't match `home_url()`/`site_url()`); operators of those setups
792     * configure CORS on the CDN themselves.
793     *
794     * Identifier gate covers both shapes Jetpack Search ships: directly-
795     * registered modules with a slash (`jetpack-search/store`,
796     * `jetpack-search/overlay-bootstrap`) and the per-block view modules
797     * WP auto-registers from `block.json`'s `viewScriptModule`, which run
798     * `generate_block_asset_handle()` and emit hyphen-joined IDs like
799     * `jetpack-search-results-list-view-script-module`.
800     *
801     * @param string $src        Module src URL.
802     * @param string $identifier Module identifier (e.g. `jetpack-search/results-list`
803     *                           or `jetpack-search-results-list-view-script-module`).
804     * @return string Relativized src on match, original otherwise.
805     */
806    public static function same_origin_script_module_src( $src, $identifier ) {
807        if ( ! is_string( $src ) || '' === $src || ! is_string( $identifier ) ) {
808            return $src;
809        }
810        if ( 0 !== strpos( $identifier, 'jetpack-search/' ) && 0 !== strpos( $identifier, 'jetpack-search-' ) ) {
811            return $src;
812        }
813
814        $src_host = wp_parse_url( $src, PHP_URL_HOST );
815        if ( ! $src_host ) {
816            return $src;
817        }
818
819        $canonical_hosts = array_map(
820            'strtolower',
821            array_filter(
822                array(
823                    wp_parse_url( home_url(), PHP_URL_HOST ),
824                    wp_parse_url( site_url(), PHP_URL_HOST ),
825                )
826            )
827        );
828
829        if ( ! in_array( strtolower( $src_host ), $canonical_hosts, true ) ) {
830            return $src;
831        }
832
833        return wp_make_link_relative( $src );
834    }
835
836    /**
837     * Inject named block variations for the filter-checkbox block.
838     *
839     * Uses the `get_block_type_variations` filter (WP 6.5+) rather than
840     * `register_block_variation()` — the latter is JS-only and has no PHP
841     * equivalent. Variation names + default attributes mirror the
842     * instant-search overlay so both surfaces describe the same filters.
843     *
844     * @param array          $variations Variations registered on the block type.
845     * @param \WP_Block_Type $block_type Block type the filter is being applied to.
846     * @return array
847     */
848    public static function inject_filter_checkbox_variations( $variations, $block_type ) {
849        if ( ! isset( $block_type->name ) || 'jetpack-search/filter-checkbox' !== $block_type->name ) {
850            return $variations;
851        }
852
853        $additions = array(
854            array(
855                'name'        => 'category',
856                'title'       => __( 'Filter by Category', 'jetpack-search-pkg' ),
857                'description' => __( 'Show category checkboxes with live result counts.', 'jetpack-search-pkg' ),
858                'attributes'  => array(
859                    'filterType' => 'taxonomy',
860                    'taxonomy'   => 'category',
861                    'label'      => __( 'Category', 'jetpack-search-pkg' ),
862                ),
863                'isActive'    => array( 'filterType', 'taxonomy' ),
864            ),
865            array(
866                'name'        => 'post_tag',
867                'title'       => __( 'Filter by Tag', 'jetpack-search-pkg' ),
868                'description' => __( 'Show tag checkboxes with live result counts.', 'jetpack-search-pkg' ),
869                'attributes'  => array(
870                    'filterType' => 'taxonomy',
871                    'taxonomy'   => 'post_tag',
872                    'label'      => __( 'Tag', 'jetpack-search-pkg' ),
873                ),
874                'isActive'    => array( 'filterType', 'taxonomy' ),
875            ),
876            array(
877                'name'        => 'post_type',
878                'title'       => __( 'Filter by Post Type', 'jetpack-search-pkg' ),
879                'description' => __( 'Show post type checkboxes with live result counts.', 'jetpack-search-pkg' ),
880                'attributes'  => array(
881                    'filterType' => 'post_type',
882                    'label'      => __( 'Post Type', 'jetpack-search-pkg' ),
883                ),
884                'isActive'    => array( 'filterType' ),
885            ),
886            array(
887                'name'        => 'author',
888                'title'       => __( 'Filter by Author', 'jetpack-search-pkg' ),
889                'description' => __( 'Show author checkboxes with live result counts.', 'jetpack-search-pkg' ),
890                'attributes'  => array(
891                    'filterType' => 'author',
892                    'label'      => __( 'Author', 'jetpack-search-pkg' ),
893                ),
894                'isActive'    => array( 'filterType' ),
895            ),
896        );
897
898        // WC-only product-taxonomy variations. `product_brand` gets an extra
899        // `taxonomy_exists()` probe — it isn't core WC, it ships via extensions
900        // (WC Brands, Perfect Brands) or recent bundled WC versions.
901        if ( self::woocommerce_blocks_enabled() ) {
902            $additions[] = array(
903                'name'        => 'product_cat',
904                'title'       => __( 'Filter by Product Category', 'jetpack-search-pkg' ),
905                'description' => __( 'Show product category checkboxes with live result counts.', 'jetpack-search-pkg' ),
906                'attributes'  => array(
907                    'filterType' => 'taxonomy',
908                    'taxonomy'   => 'product_cat',
909                    'label'      => __( 'Product Category', 'jetpack-search-pkg' ),
910                ),
911                'isActive'    => array( 'filterType', 'taxonomy' ),
912            );
913            $additions[] = array(
914                'name'        => 'product_tag',
915                'title'       => __( 'Filter by Product Tag', 'jetpack-search-pkg' ),
916                'description' => __( 'Show product tag checkboxes with live result counts.', 'jetpack-search-pkg' ),
917                'attributes'  => array(
918                    'filterType' => 'taxonomy',
919                    'taxonomy'   => 'product_tag',
920                    'label'      => __( 'Product Tag', 'jetpack-search-pkg' ),
921                ),
922                'isActive'    => array( 'filterType', 'taxonomy' ),
923            );
924            if ( taxonomy_exists( 'product_brand' ) ) {
925                $additions[] = array(
926                    'name'        => 'product_brand',
927                    'title'       => __( 'Filter by Product Brand', 'jetpack-search-pkg' ),
928                    'description' => __( 'Show product brand checkboxes with live result counts.', 'jetpack-search-pkg' ),
929                    'attributes'  => array(
930                        'filterType' => 'taxonomy',
931                        'taxonomy'   => 'product_brand',
932                        'label'      => __( 'Product Brand', 'jetpack-search-pkg' ),
933                    ),
934                    'isActive'    => array( 'filterType', 'taxonomy' ),
935                );
936            }
937        }
938
939        $additions[] = array(
940            'name'        => 'custom_taxonomy',
941            'title'       => __( 'Filter by Custom Taxonomy', 'jetpack-search-pkg' ),
942            'description' => __( 'Show checkboxes for a custom taxonomy. Pick which taxonomy in the block settings after inserting.', 'jetpack-search-pkg' ),
943            'attributes'  => array(
944                'filterType' => 'taxonomy',
945                'taxonomy'   => '',
946                'label'      => '',
947            ),
948            // Match on filterType only so identity survives the author picking a
949            // slug. The dedicated variations pin `taxonomy` in their isActive
950            // arrays, so WP's most-specific-match resolution still routes named
951            // slugs to those; Custom Taxonomy claims every other taxonomy.
952            'isActive'    => array( 'filterType' ),
953        );
954
955        // Merge by `name` so an upstream variation (block.json or earlier filter)
956        // wins over our preset of the same name; plain `array_merge` would
957        // append duplicates and the inserter would render two cards.
958        $variations    = (array) $variations;
959        $existing_keys = array_flip( array_column( $variations, 'name' ) );
960        foreach ( $additions as $variation ) {
961            if ( ! isset( $existing_keys[ $variation['name'] ] ) ) {
962                $variations[] = $variation;
963            }
964        }
965        return $variations;
966    }
967
968    /**
969     * Register block patterns. Files prefixed `wc-` compose WooCommerce-only
970     * blocks and load only when WC is active (mirrors `filter-wc-*` blocks).
971     */
972    protected static function register_patterns() {
973        $patterns_dir = __DIR__ . '/patterns';
974        if ( ! is_dir( $patterns_dir ) ) {
975            return;
976        }
977        $pattern_files = glob( $patterns_dir . '/*.php' );
978        if ( ! $pattern_files ) {
979            return;
980        }
981        $wc_blocks_enabled = self::woocommerce_blocks_enabled();
982        foreach ( $pattern_files as $pattern_file ) {
983            if ( ! $wc_blocks_enabled && 0 === strpos( basename( $pattern_file ), 'wc-' ) ) {
984                continue;
985            }
986            require_once $pattern_file;
987        }
988    }
989
990    /**
991     * Derive a block-pattern's content from a chrome-free layout template (the
992     * overlay templates, which already ship without header/footer/main page
993     * chrome), so patterns stay in sync with the template they mirror instead of
994     * carrying a hand-copied second copy of the layout.
995     *
996     * @param string $template_file Template basename under `templates/`.
997     * @return string Block markup ready for `register_block_pattern()`, or '' when unreadable.
998     */
999    public static function pattern_content_from_template( string $template_file ): string {
1000        $template_path = __DIR__ . '/templates/' . basename( $template_file );
1001        // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- local, bundled template file.
1002        $raw = is_readable( $template_path ) ? (string) file_get_contents( $template_path ) : '';
1003        if ( '' === $raw ) {
1004            return '';
1005        }
1006        return trim( static::substitute_template_placeholders( $raw ) );
1007    }
1008
1009    /**
1010     * Build the full search page template content.
1011     *
1012     * Markup lives in `templates/jetpack-search.html` with a `{{FILTER_HEADING}}`
1013     * placeholder so the sidebar heading still goes through `esc_html__()`.
1014     *
1015     * @return string Block markup for a complete page template.
1016     */
1017    protected static function get_search_template_content(): string {
1018        $template_path = __DIR__ . '/templates/jetpack-search.html';
1019        // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- local, bundled template file.
1020        $raw = is_readable( $template_path ) ? (string) file_get_contents( $template_path ) : '';
1021        return static::sync_filters_popover_content( static::substitute_template_placeholders( $raw ) );
1022    }
1023
1024    /**
1025     * Register the Jetpack Search page template so it surfaces in the Site
1026     * Editor and resolves via the template hierarchy. DB-stored customizations
1027     * still win automatically — the `custom` source beats `plugin`. Classic
1028     * themes are skipped: the registry is only consulted by block themes.
1029     */
1030    public static function register_search_template() {
1031        if ( ! function_exists( 'register_block_template' ) || ! static::block_templates_active() ) {
1032            return;
1033        }
1034        $content = static::get_search_template_content();
1035        // Bail on missing/unreadable file: our slug is prepended to the search
1036        // hierarchy, so registering empty content would render a blank page on
1037        // `/?s=…`. Falling through lets core resolve the theme's `search.html`.
1038        if ( '' === $content ) {
1039            return;
1040        }
1041        static::replace_block_template(
1042            static::get_parent_plugin_slug() . '//' . self::SEARCH_TEMPLATE_SLUG,
1043            array(
1044                'title'       => __( 'Jetpack Search Results', 'jetpack-search-pkg' ),
1045                'description' => __( 'Displays search results with Jetpack Search filters.', 'jetpack-search-pkg' ),
1046                'content'     => $content,
1047            )
1048        );
1049    }
1050
1051    /**
1052     * Whether the overlay should paint the WooCommerce product variant for the
1053     * current request. True only when the override option is on and the request
1054     * is a product search — mirrors the embedded/inline interception
1055     * (`is_woocommerce_product_search()` already folds in the WC probe). The
1056     * overlay opens client-side from any search box, so this only flips on the
1057     * server-rendered product-search request (deep link or product-archive
1058     * search), not on a live form intercept from a non-product page.
1059     *
1060     * @return bool
1061     */
1062    protected static function should_use_product_overlay(): bool {
1063        return static::woocommerce_search_template_override_enabled()
1064            && static::is_woocommerce_product_search();
1065    }
1066
1067    /**
1068     * Read the dedicated overlay-template markup.
1069     *
1070     * Distinct from `get_search_template_content()`: a modal isn't a page, so
1071     * the overlay markup ships without `header`/`main`/`footer` template-parts
1072     * rather than runtime-stripping them.
1073     *
1074     * Picks the product variant on a WooCommerce product search (see
1075     * `should_use_product_overlay()`). Source of truth, in order:
1076     *   1. Customized singleton CPT (`Overlay_Template` / `Product_Overlay_Template`).
1077     *   2. The bundled `jetpack-search-overlay{-product}.html`.
1078     *
1079     * @return string Block markup for the overlay body.
1080     */
1081    protected static function get_overlay_template_content(): string {
1082        $is_product = static::should_use_product_overlay();
1083        $key        = $is_product ? 'product' : 'default';
1084        if ( isset( self::$overlay_template_content_cache[ $key ] ) ) {
1085            return self::$overlay_template_content_cache[ $key ];
1086        }
1087        $cpt_class  = $is_product ? Product_Overlay_Template::class : Overlay_Template::class;
1088        $customized = $cpt_class::get_customized_content();
1089        if ( null !== $customized ) {
1090            self::$overlay_template_content_cache[ $key ] = $customized;
1091            return self::$overlay_template_content_cache[ $key ];
1092        }
1093        $file          = $is_product ? 'jetpack-search-overlay-product.html' : 'jetpack-search-overlay.html';
1094        $template_path = __DIR__ . '/templates/' . $file;
1095        // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- local, bundled template file; wp_remote_get() is for remote URLs.
1096        $raw = is_readable( $template_path ) ? (string) file_get_contents( $template_path ) : '';
1097        self::$overlay_template_content_cache[ $key ] = static::sync_filters_popover_content( $raw );
1098        return self::$overlay_template_content_cache[ $key ];
1099    }
1100
1101    /**
1102     * Reset the `get_overlay_template_content()` memo. Tests only — PHPUnit
1103     * reuses a single process, so a CPT-customized overlay saved in one test
1104     * would otherwise be pinned (or a bundled read would mask it) in the next.
1105     * Guarded against accidental production use.
1106     */
1107    public static function reset_overlay_template_content_cache(): void {
1108        if ( defined( 'ABSPATH' ) && ! defined( 'PHPUNIT_COMPOSER_INSTALL' ) ) {
1109            return;
1110        }
1111        self::$overlay_template_content_cache = array();
1112    }
1113
1114    /**
1115     * Echo the Search-blocks overlay shell into `wp_footer`. Block markup
1116     * carries `data-wp-interactive` so the IA's standard `DOMContentLoaded`
1117     * hydration picks it up — no client-side fetch needed. The caller (`init()`)
1118     * gates registration on `is_block_template_overlay_enabled()`.
1119     */
1120    public static function print_block_template_overlay() {
1121        $rendered = self::$block_template_overlay_rendered_html;
1122        if ( null === $rendered || '' === $rendered ) {
1123            return;
1124        }
1125        $config = wp_json_encode(
1126            array(
1127                'searchInputSelector'    => 'input[name="s"]:not(.jetpack-search-input__field), #searchform input.search-field, .search-form input.search-field, .searchform input.search-field',
1128                'overlayTriggerSelector' => '.jetpack-search-block-overlay-trigger, .jetpack-instant-search__open-overlay-button, header#site-header .search-toggle[data-toggle-target]',
1129            ),
1130            JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP
1131        );
1132        ?>
1133        <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>
1134        <?php
1135        // `<template>` keeps the region out of `document.querySelectorAll` so
1136        // the IA runtime's DOMContentLoaded walk skips it. The bootstrap clones
1137        // into the shell on first open and hydrates there.
1138        // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- do_blocks output.
1139        printf( '<template id="jetpack-search-block-overlay-template">%s</template>', $rendered );
1140        ?>
1141        <div
1142            id="jetpack-search-block-overlay"
1143            class="jetpack-search-block-overlay"
1144            role="dialog"
1145            aria-modal="true"
1146            aria-label="<?php echo esc_attr__( 'Search', 'jetpack-search-pkg' ); ?>"
1147            hidden
1148        >
1149            <div class="jetpack-search-block-overlay__card">
1150                <button
1151                    type="button"
1152                    class="jetpack-search-block-overlay__close"
1153                    aria-label="<?php echo esc_attr__( 'Close search', 'jetpack-search-pkg' ); ?>"
1154                >
1155                    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" aria-hidden="true" focusable="false">
1156                        <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" />
1157                    </svg>
1158                </button>
1159                <div class="jetpack-search-block-overlay__content"></div>
1160            </div>
1161        </div>
1162        <?php
1163    }
1164
1165    /**
1166     * Register + enqueue the overlay-bootstrap Script Module that wires
1167     * theme-defined search triggers to the rendered shell. Inline-CSS for the
1168     * modal chrome. Config emits alongside the overlay HTML in
1169     * `print_block_template_overlay()`.
1170     */
1171    public static function enqueue_block_template_overlay_assets() {
1172        if ( ! function_exists( 'wp_register_script_module' ) ) {
1173            return;
1174        }
1175        $base_path  = Package::get_installed_path() . 'build/search-blocks/overlay-bootstrap/';
1176        $asset_file = $base_path . 'index.asset.php';
1177        if ( ! file_exists( $asset_file ) ) {
1178            return;
1179        }
1180        $asset = require $asset_file;
1181        wp_register_script_module(
1182            'jetpack-search/overlay-bootstrap',
1183            plugins_url( 'index.js', $base_path . 'index.js' ),
1184            $asset['dependencies'] ?? array(),
1185            $asset['version'] ?? false
1186        );
1187        wp_enqueue_script_module( 'jetpack-search/overlay-bootstrap' );
1188
1189        wp_register_style( 'jetpack-search-block-overlay', false, array(), $asset['version'] ?? false );
1190        wp_enqueue_style( 'jetpack-search-block-overlay' );
1191        wp_add_inline_style( 'jetpack-search-block-overlay', static::block_template_overlay_inline_css() );
1192
1193        // Shared responsive layout CSS (narrow-width sidebar collapse +
1194        // in-header popover toggle). Same rules ship to the embedded /
1195        // WC-product page templates via `enqueue_search_page_assets()`.
1196        static::enqueue_search_layout_style();
1197
1198        // Render here (during `wp_enqueue_scripts`) so view-module enqueues
1199        // from `do_blocks()` land before the importmap prints — see
1200        // AGENTS.md § Hydration & SSR seeding.
1201        self::$block_template_overlay_rendered_html = trim(
1202            do_blocks( static::get_overlay_template_content() )
1203        );
1204    }
1205
1206    /**
1207     * Print the body-sampler `<script>` that sets `--jp-search-page-ink` /
1208     * `--jp-search-page-surface` on `:root` from the body's resolved `color` /
1209     * `backgroundColor`. Skips writing surface when bg is transparent (the
1210     * theme paints on the browser canvas) or when bg equals ink (vintage
1211     * frame-themes like Twenty Sixteen use body as a colored border around a
1212     * lighter `.site` content wrapper). See AGENTS.md § Theme tokens.
1213     */
1214    public static function print_theme_token_sampler(): void {
1215        if ( is_admin() ) {
1216            return;
1217        }
1218        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>";
1219    }
1220
1221    /**
1222     * Inline CSS for the overlay modal chrome. Block content brings its own
1223     * theme styling; this is just the scrim, centered card, 60px header strip,
1224     * close button, mobile padding tweaks, and scroll lock. The responsive
1225     * sidebar-collapse + in-header popover rules shared with the page
1226     * templates live in `search_layout_inline_css()`.
1227     *
1228     * Surface/ink hoist `--jp-search-page-*` (with the legacy
1229     * `--wp--preset--color--*` chain as fallback — see AGENTS.md § Theme
1230     * tokens) onto two custom props so in-card surfaces share one source.
1231     * Hairlines use `color-mix(--jp-search-overlay-ink, --jp-search-overlay-surface)`.
1232     *
1233     * @return string
1234     */
1235    protected static function block_template_overlay_inline_css(): string {
1236        return <<<'CSS'
1237.jetpack-search-block-overlay {
1238    position: fixed;
1239    inset: 0;
1240    z-index: 100000;
1241    display: flex;
1242    justify-content: center;
1243    align-items: flex-start;
1244    background: rgba(31, 31, 31, 0.7);
1245    overflow-y: auto;
1246    padding: 3em 1em;
1247    transition: opacity 0.1s ease-in;
1248}
1249.jetpack-search-block-overlay[hidden] {
1250    display: none;
1251}
1252@media (prefers-reduced-motion: reduce) {
1253    .jetpack-search-block-overlay {
1254        transition: none;
1255    }
1256}
1257.jetpack-search-block-overlay__card {
1258    position: relative;
1259    width: 100%;
1260    max-width: 1080px;
1261    --jp-search-overlay-surface: var(--jp-search-page-surface, var(--wp--preset--color--base, var(--wp--preset--color--background, #fff)));
1262    --jp-search-overlay-ink: var(--jp-search-page-ink, var(--wp--preset--color--contrast, var(--wp--preset--color--foreground, #1d2327)));
1263    /* Single source for the content group's inset. The corner-join in
1264     * search_layout_inline_css() zeroes the block-start/block-end of this
1265     * padding on the group and re-adds the same tokens on the columns, so the
1266     * sidebar hairline reaches both card edges — keep them as var()s so the
1267     * two sites can't drift. */
1268    --jp-search-overlay-content-pad-block-start: 0.5em;
1269    --jp-search-overlay-content-pad-inline: 2em;
1270    --jp-search-overlay-content-pad-block-end: 2em;
1271    background: var(--jp-search-overlay-surface);
1272    color: var(--jp-search-overlay-ink);
1273    border: 1px solid rgba(128, 128, 128, 0.25);
1274    border-radius: 4px;
1275    box-shadow: 0 8px 32px rgba(0, 0, 0, 0.18);
1276    padding-top: 60px;
1277}
1278/* Token-aware card / scrim separation (SEARCH-270): tint the resolved surface
1279 * ~5% toward ink and paint the hairline border with the same ink-over-surface
1280 * mix used for the header `::before`. Both auto-invert polarity per theme, so
1281 * dark themes get a card that visibly layers above the scrim without losing
1282 * the themed surface color. The static `rgba(128,128,128,.25)` border + the
1283 * un-tinted token chain stay as the fallback for browsers without `color-mix`. */
1284@supports (background: color-mix(in sRGB, black 50%, white)) {
1285    .jetpack-search-block-overlay__card {
1286        --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))));
1287        border-color: color-mix(in sRGB, var(--jp-search-overlay-ink) 20%, var(--jp-search-overlay-surface));
1288        /* Ink-derived shadow inverts polarity per theme (SEARCH-289): a dark drop
1289         * shadow on light cards, a soft light halo on dark — a flat black shadow is
1290         * invisible against the dark scrim. Static black above is the fallback. */
1291        box-shadow: 0 8px 32px color-mix(in sRGB, var(--jp-search-overlay-ink) 22%, transparent);
1292    }
1293}
1294/* Single hairline over the full 60px header strip — siblings paint with a seam (SEARCH-260). */
1295.jetpack-search-block-overlay__card::before {
1296    content: "";
1297    position: absolute;
1298    top: 60px;
1299    left: 0;
1300    right: 0;
1301    height: 1px;
1302    background: transparent;
1303    pointer-events: none;
1304}
1305@supports (background: color-mix(in sRGB, black 50%, white)) {
1306    .jetpack-search-block-overlay__card::before {
1307        background: color-mix(in sRGB, var(--jp-search-overlay-ink) 15%, var(--jp-search-overlay-surface));
1308    }
1309}
1310.jetpack-search-block-overlay__close {
1311    position: absolute;
1312    top: 0;
1313    right: 0;
1314    width: 60px;
1315    height: 60px;
1316    display: flex;
1317    align-items: center;
1318    justify-content: center;
1319    background: transparent;
1320    border: 0;
1321    cursor: pointer;
1322    color: inherit;
1323}
1324/* Opaque ink-over-surface mix — `color-mix(currentColor, transparent)` collapses to full-opacity ink on Safari <16.4 and swallows the X icon. */
1325@supports (background: color-mix(in sRGB, black 50%, white)) {
1326    .jetpack-search-block-overlay__close:hover,
1327    .jetpack-search-block-overlay__close:focus-visible {
1328        background: color-mix(in sRGB, var(--jp-search-overlay-ink) 14%, var(--jp-search-overlay-surface));
1329    }
1330}
1331.jetpack-search-block-overlay__close svg {
1332    width: 24px;
1333    height: 24px;
1334}
1335/* Pin in-overlay button `color` against host-theme `button:hover|:focus` overrides
1336 * (fieldguide and similar legacy themes flip button color to a brand accent on hover).
1337 * Our block-level rules set `color: inherit` at (0,1,0); a stray `button:hover` rule
1338 * at (0,1,1) outranks it on `:hover`, and the `color-mix(currentColor X%, …)` hover
1339 * affordances on the filters-popover trigger, results-sort trigger, suggestions
1340 * options, etc. then resolve against the host's hover color (often white-on-white).
1341 * Card-scoped `:hover|:focus|[aria-expanded=true]` lands at (0,2,1) — beats the
1342 * theme rule without escalating to `!important`. */
1343.jetpack-search-block-overlay__card button:hover,
1344.jetpack-search-block-overlay__card button:focus,
1345.jetpack-search-block-overlay__card button:focus-visible,
1346.jetpack-search-block-overlay__card button[aria-expanded="true"] {
1347    color: var(--jp-search-overlay-ink);
1348}
1349/* Load More is a solid theme `core/button` on the search page, which is right
1350 * there. Inside the overlay card it sits on the resolved card surface, where the
1351 * theme's solid button background (and its accent `:hover`, e.g. Twenty Sixteen's
1352 * #007acc) reads as a heavy slab that clashes with the card's otherwise
1353 * `currentColor`-ghost controls (close, sort/filter triggers, active-filter
1354 * pills). Card-scoped (0,2,0 / 0,2,1) so it only restyles the in-overlay button
1355 * to the same ghost affordance — the page button is untouched. */
1356.jetpack-search-block-overlay__card .jetpack-search-load-more__button {
1357    background: transparent;
1358    border: 1px solid;
1359    border-color: color-mix(in sRGB, currentColor 20%, transparent);
1360    color: var(--jp-search-overlay-ink);
1361}
1362.jetpack-search-block-overlay__card .jetpack-search-load-more__button:hover:not(:disabled),
1363.jetpack-search-block-overlay__card .jetpack-search-load-more__button:focus-visible {
1364    background: color-mix(in sRGB, currentColor 8%, transparent);
1365}
1366/* Promote the first child (search-input) to a 60px header strip flush with
1367 * the close button, matching the legacy `__box` header. Suppress the input
1368 * block's own border-bottom — the card's `::before` hairline handles the
1369 * separator across the whole strip. */
1370.jetpack-search-block-overlay__card .wp-block-jetpack-search-search-input {
1371    position: absolute;
1372    top: 0;
1373    left: 0;
1374    right: 60px;
1375    height: 60px;
1376    margin: 0;
1377    padding: 0;
1378}
1379.jetpack-search-block-overlay__card .wp-block-jetpack-search-search-input .jetpack-search-input__inside-wrapper {
1380    height: 100%;
1381    display: flex;
1382    align-items: stretch;
1383    gap: 0;
1384    padding: 0;
1385    border-bottom: 0;
1386}
1387.jetpack-search-block-overlay__card .wp-block-jetpack-search-search-input .jetpack-search-input__icon {
1388    flex: 0 0 60px;
1389    width: 60px;
1390    height: 60px;
1391    padding: 18px;
1392    box-sizing: border-box;
1393    opacity: 0.5;
1394}
1395.jetpack-search-block-overlay__card .wp-block-jetpack-search-search-input .jetpack-search-input__field {
1396    flex: 1 1 auto;
1397    min-width: 0;
1398    height: 100%;
1399    font-size: 18px;
1400    line-height: 1;
1401    margin: 0;
1402    padding: 0;
1403    background: transparent;
1404}
1405.jetpack-search-block-overlay__card .wp-block-jetpack-search-search-input .jetpack-search-input__clear {
1406    flex: 0 0 60px;
1407    width: 60px;
1408    height: 60px;
1409    padding: 0;
1410    font-size: 0.875rem;
1411    font-weight: 400;
1412    line-height: 1;
1413}
1414/* Suggestions panel covers the full card width (cancel the input's `right: 60px`
1415 * offset) and sits above `results-sort` / `filters-popover` (both `z-index: 20`).
1416 * Background reads from `--jp-search-overlay-surface` so the panel tracks the
1417 * resolved card surface — a hardcoded `#fff` would re-introduce the white-on-dark
1418 * bug on legacy `--background`/`--foreground` themes. */
1419.jetpack-search-block-overlay__card .wp-block-jetpack-search-search-input .jetpack-search-input__suggestions {
1420    right: -60px;
1421    z-index: 30;
1422    background: var(--jp-search-overlay-surface, #fff);
1423}
1424/* Top padding clears the absolutely-positioned 60px header strip (SEARCH-243). */
1425.jetpack-search-block-overlay__content > .wp-block-group:first-child {
1426    padding: var(--jp-search-overlay-content-pad-block-start) var(--jp-search-overlay-content-pad-inline) var(--jp-search-overlay-content-pad-block-end);
1427}
1428@media (max-width: 781px) {
1429    .jetpack-search-block-overlay {
1430        padding: 0;
1431    }
1432    .jetpack-search-block-overlay__card {
1433        min-height: 100vh;
1434        border: 0;
1435        border-radius: 0;
1436        box-shadow: none;
1437        --jp-search-overlay-content-pad-inline: 1em;
1438        --jp-search-overlay-content-pad-block-end: 1em;
1439    }
1440}
1441/* Mirror legacy `$break-lg: 992px → $modal-max-width-lg: 95%` from `instant-search/components/search-results.scss`. */
1442@media (min-width: 992px) {
1443    .jetpack-search-block-overlay__card {
1444        max-width: 95%;
1445    }
1446}
1447/* Body-scroll lock while open. JS side stashes/restores scrollY on toggle. */
1448body.jetpack-search-block-overlay-open {
1449    position: fixed;
1450    left: 0;
1451    right: 0;
1452    width: 100%;
1453    overflow: hidden;
1454}
1455CSS;
1456    }
1457
1458    /**
1459     * Register + enqueue the shared responsive layout CSS on the embedded /
1460     * WC-product page templates (`jetpack-search.html`,
1461     * `jetpack-search-product-results.html`). Self-gates on `is_search()` so
1462     * non-search requests skip the work entirely; the overlay path enqueues
1463     * the same handle unconditionally from its own asset hook.
1464     */
1465    public static function enqueue_search_page_assets() {
1466        if ( ! is_search() ) {
1467            return;
1468        }
1469        static::enqueue_search_layout_style();
1470    }
1471
1472    /**
1473     * Register + enqueue the inline CSS that drives the shared responsive
1474     * layout pattern across all three Search Blocks templates — narrow-width
1475     * sidebar collapse and in-header popover toggle. Called from both the
1476     * overlay enqueue path and the page-template enqueue path.
1477     *
1478     * `wp_register_style` / `wp_enqueue_style` are idempotent, but
1479     * `wp_add_inline_style` is **not** — it appends to an internal array on
1480     * every call, so a second invocation would double the inline payload.
1481     * The `wp_style_is( …, 'enqueued' )` short-circuit makes the helper safe
1482     * to call from multiple sites in one request.
1483     */
1484    public static function enqueue_search_layout_style() {
1485        // No src — this handle exists only as a target for `wp_add_inline_style`.
1486        // Version tracks the package so a release bust cache-invalidates any
1487        // reusing site's inline-style cache.
1488        wp_register_style( 'jetpack-search-layout', false, array(), Package::VERSION );
1489        if ( wp_style_is( 'jetpack-search-layout', 'enqueued' ) ) {
1490            return;
1491        }
1492        wp_enqueue_style( 'jetpack-search-layout' );
1493        wp_add_inline_style( 'jetpack-search-layout', static::search_layout_inline_css() );
1494    }
1495
1496    /**
1497     * Inline CSS for the responsive search-results layout shared across the
1498     * overlay, embedded (`jetpack-search.html`), and WC product
1499     * (`jetpack-search-product-results.html`) templates.
1500     *
1501     * Below 992px the right-column filter sidebar collapses to a popover
1502     * trigger docked next to results-sort; at >= 992px the sidebar is the
1503     * sole filter UI and the in-header popover is hidden so the two don't
1504     * double up. Same breakpoint as the legacy Instant Search overlay
1505     * (`.jetpack-instant-search__search-results-secondary { display: none }`
1506     * below `$break-lg`). Lives next to `block_template_overlay_inline_css()`
1507     * (which keeps overlay-only chrome) because the rules target the
1508     * templates' outer columns + results-header, none of which any single
1509     * block owns.
1510     *
1511     * @return string
1512     */
1513    protected static function search_layout_inline_css(): string {
1514        return <<<'CSS'
1515/* The block group already carries `layout.type:flex` which makes the WordPress
1516 * block-layout system emit `display:flex` / `flex-wrap:nowrap` /
1517 * `justify-content:space-between`. Restating them is defensive (decouples us
1518 * from block-layout CSS being present); the operative net-new rule is
1519 * `align-items: center`, which centers `results-count` against the controls
1520 * cluster. */
1521.jetpack-search-layout__results-header {
1522    display: flex;
1523    flex-wrap: nowrap;
1524    justify-content: space-between;
1525    align-items: center;
1526}
1527/* Right-side controls cluster: sort + filters-popover trigger. Without this
1528 * the three `__results-header` children get spread evenly by the parent's
1529 * `space-between`; nesting sort + popover here pins them as one block on the
1530 * trailing edge. */
1531.jetpack-search-layout__results-header-controls {
1532    display: flex;
1533    flex-wrap: nowrap;
1534    align-items: center;
1535    gap: 0.75rem;
1536}
1537/* Name the columns row as the layout container so the sidebar/popover flip
1538 * tracks its inline-size. The `@media` rules below are the universal base —
1539 * they fire in every browser (including legacy ones without container-query
1540 * support) and they drive standalone usage outside the named container (no
1541 * container ancestor → only `@media` applies). The `@container` rule further
1542 * down overrides `@media` via source-order cascade at equal specificity when
1543 * the named container is in scope AND narrower than 992px. The override has
1544 * to undo `@media (min-width: 992px)`'s `popover { display: none }`
1545 * explicitly: in the "wide viewport, narrow container" case `@media
1546 * (min-width: 992px)` keeps firing on the viewport width and would otherwise
1547 * leave the visitor with no filter UI at all. `@container (min-width: 992px)`
1548 * isn't defined — container width is bounded by viewport width in practice,
1549 * so the matching `@media (min-width: 992px)` already covers the wide case. */
1550.wp-block-columns:has(> .jetpack-search-layout__filters-column) {
1551    container-type: inline-size;
1552    container-name: jetpack-search-layout;
1553}
1554/* Below 992px the right-column filter sidebar collapses to a popover trigger
1555 * docked next to results-sort. The trigger comes from the
1556 * `jetpack-search/filters-popover` block that ships in each template. The
1557 * selector is scoped to the named outer column so nested `wp-block-column`s
1558 * inside result-card templates aren't affected. */
1559@media (max-width: 991.98px) {
1560    .jetpack-search-layout__filters-column {
1561        display: none;
1562    }
1563    /* `!important` defends against the parent `wp:columns` block-layout CSS
1564     * that pins `.wp-block-column` to its inline `flex-basis` (or to an even
1565     * split when no width is set). Once the filter column is `display:none`,
1566     * the results column has to be able to claim the full row at any
1567     * specificity. */
1568    .jetpack-search-layout__results-column {
1569        flex-basis: 100% !important;
1570    }
1571}
1572/* Sidebar left divider tracks `currentColor` so the hairline stays subtle on
1573 * light themes and visible on dark themes, matching the search-input
1574 * underline. We only set color; each template's column block sets
1575 * `border-left-width: 1px` inline. Fallback to `transparent` so themes/UAs
1576 * without `color-mix` support get an invisible divider rather than a hard
1577 * grey rule. */
1578.jetpack-search-layout__filters-column {
1579    border-left-color: transparent;
1580}
1581@supports (border-color: color-mix(in sRGB, black 50%, white)) {
1582    .jetpack-search-layout__filters-column {
1583        border-left-color: color-mix(in sRGB, currentColor 15%, transparent);
1584    }
1585}
1586/* Sidebar-showing rules (>= 992px). The corner-join is structural: the
1587 * columns row is pulled flush to the search-input hairline and breathing
1588 * room re-added as internal column padding, so the filters column's
1589 * `border-left` runs the row's full height — hairline (top) to end-of-div
1590 * (bottom). Three vertical gaps are neutralised:
1591 *
1592 *   a) `margin-block-start` on the row (outer group's `spacing.blockGap` or
1593 *      the theme's default block-gap) — zeroed.
1594 *
1595 *   b) `.is-layout-flex { align-items: center }` (theme/core default), which
1596 *      centres the shorter filters column and drops its top edge. Overridden
1597 *      to `stretch` (not `flex-start`) so the column also grows to full row
1598 *      height; it's flow layout, so its content stays top-aligned regardless.
1599 *
1600 *   c) Overlay-only: SEARCH-243's content-group inset sits outside the
1601 *      columns, so the stretched column stops short of the card edges (below
1602 *      the `::before` hairline at the top, and short of the bottom). Zeroed
1603 *      on the group's block axis and re-added on the columns, both sides
1604 *      reading the same `--jp-search-overlay-content-pad-*` tokens the group
1605 *      itself uses — so the divider reaches both edges while content keeps
1606 *      its breathing room, and the two sites can't drift.
1607 *
1608 * `.is-layout-flex` bumps the columns selector to (0,3,0) to outrank
1609 * per-container `blockGap` CSS; `:has(> filters-column)` scopes it to our
1610 * rows. These target the row/group, which `@container` can't reach from
1611 * inside the named container, so they stay viewport-driven — harmless when
1612 * the sidebar collapses below 992px. (b) is also a no-op wherever WP core's
1613 * `.wp-block-columns { align-items: normal !important }` is present; see
1614 * AGENTS.md. */
1615@media (min-width: 992px) {
1616    /* Sidebar shown, popover-in-results-header hidden. The `@container
1617     * (max-width: 991.98px)` block below re-shows the popover when the
1618     * named container is narrower than the viewport. */
1619    .jetpack-search-layout__results-header .jetpack-search-filters-popover {
1620        display: none;
1621    }
1622    .wp-block-columns.is-layout-flex:has(> .jetpack-search-layout__filters-column) {
1623        align-items: stretch;
1624        margin-block-start: 0;
1625    }
1626    .jetpack-search-block-overlay__content > .wp-block-group:first-child:has(.jetpack-search-layout__filters-column) {
1627        padding-top: 0;
1628        padding-bottom: 0;
1629    }
1630    .wp-block-columns:has(> .jetpack-search-layout__filters-column) > .wp-block-column {
1631        padding-top: var(--jp-search-overlay-content-pad-block-start, 0.5em);
1632    }
1633    .jetpack-search-block-overlay__content .wp-block-columns:has(> .jetpack-search-layout__filters-column) > .wp-block-column {
1634        padding-bottom: var(--jp-search-overlay-content-pad-block-end, 2em);
1635    }
1636}
1637/* @container override: applies when the named container exists. Placed AFTER
1638 * the `@media` rules so source-order cascade lets it win over them at equal
1639 * specificity. In "wide viewport, narrow container" (the case the change is
1640 * meant to fix), `@media (max-width: 991.98px)` doesn't fire but `@media
1641 * (min-width: 992px)` does — this block undoes the latter's `popover {
1642 * display: none }` via `display: inline-block` and hides the sidebar that
1643 * the `@media (max-width)` rule wouldn't have hidden at this viewport. Same
1644 * `!important` reasoning on `flex-basis: 100%` as the @media block. */
1645@container jetpack-search-layout (max-width: 991.98px) {
1646    .jetpack-search-layout__filters-column {
1647        display: none;
1648    }
1649    .jetpack-search-layout__results-column {
1650        flex-basis: 100% !important;
1651    }
1652    .jetpack-search-layout__results-header .jetpack-search-filters-popover {
1653        display: inline-block;
1654    }
1655}
1656CSS;
1657    }
1658
1659    /**
1660     * Product-search counterpart of `get_search_template_content()`.
1661     *
1662     * @return string Block markup for the product-search template.
1663     */
1664    protected static function get_product_search_template_content(): string {
1665        $template_path = __DIR__ . '/templates/jetpack-search-product-results.html';
1666        // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- local, bundled template file.
1667        $raw = is_readable( $template_path ) ? (string) file_get_contents( $template_path ) : '';
1668        return static::sync_filters_popover_content( static::substitute_template_placeholders( $raw ) );
1669    }
1670
1671    /**
1672     * Substitute `{{FILTER_HEADING}}` / `{{HEADER_SLUG}}` / `{{FOOTER_SLUG}}` in a
1673     * bundled template. Empty input passes through.
1674     *
1675     * @param string $raw Raw template-file contents.
1676     * @return string
1677     */
1678    protected static function substitute_template_placeholders( string $raw ): string {
1679        if ( '' === $raw ) {
1680            return $raw;
1681        }
1682        $slugs = static::resolve_chrome_slugs();
1683        return str_replace(
1684            array( '{{FILTER_HEADING}}', '{{HEADER_SLUG}}', '{{FOOTER_SLUG}}' ),
1685            array(
1686                esc_html__( 'Filter options', 'jetpack-search-pkg' ),
1687                $slugs['header'],
1688                $slugs['footer'],
1689            ),
1690            $raw
1691        );
1692    }
1693
1694    /**
1695     * Active theme's chrome slugs. Test seam; resolver lives on
1696     * `Theme_Chrome_Slug_Resolver`.
1697     *
1698     * @return array{header:string,footer:string}
1699     */
1700    protected static function resolve_chrome_slugs(): array {
1701        return Theme_Chrome_Slug_Resolver::resolve();
1702    }
1703
1704    /**
1705     * Names of the "source of truth" filter-composition blocks — whichever is
1706     * present in a template supplies the canonical filter config that
1707     * `jetpack-search/filters-popover` mirrors. See {@see sync_filters_popover_content()}.
1708     */
1709    const FILTERS_SOURCE_BLOCK_NAMES = array( 'jetpack-search/filters', 'jetpack-search/filters-product' );
1710
1711    /**
1712     * `jetpack-search/filters-popover` (the collapsible/mobile filter panel) and
1713     * `jetpack-search/filters` / `jetpack-search/filters-product` (the wide-viewport
1714     * sidebar) are two independently-serialized copies of the same filter
1715     * configuration, shown one-or-the-other via a CSS breakpoint. Nothing keeps
1716     * them in sync, so editing one silently leaves the other stale (SEARCH-307).
1717     *
1718     * Rather than a two-way sync, the sidebar block is treated as the single
1719     * source of truth: every time template content is read — for rendering or
1720     * for editing — the popover's inner blocks are recomputed to mirror
1721     * whatever the sidebar currently contains. A direct edit to the popover's
1722     * own inner blocks still saves, but is overwritten back to match the
1723     * sidebar on the next read; self-healing, no migration needed for content
1724     * that already diverged before this existed.
1725     *
1726     * @param string $content Block markup, e.g. a full template or singleton-CPT post_content.
1727     * @return string Block markup with the popover's inner blocks synced to the sidebar's, unchanged if either block is absent.
1728     */
1729    public static function sync_filters_popover_content( string $content ): string {
1730        if ( '' === $content || false === strpos( $content, 'jetpack-search/filters-popover' ) ) {
1731            return $content;
1732        }
1733        $blocks = parse_blocks( $content );
1734        $source = static::find_block_by_name( $blocks, self::FILTERS_SOURCE_BLOCK_NAMES );
1735        if ( null === $source ) {
1736            return $content;
1737        }
1738        $replaced = static::replace_block_inner_content( $blocks, 'jetpack-search/filters-popover', $source );
1739        return $replaced ? serialize_blocks( $blocks ) : $content;
1740    }
1741
1742    /**
1743     * Depth-first search for the first block matching one of `$names`.
1744     *
1745     * @param array<int,array<string,mixed>> $blocks Parsed blocks (`parse_blocks()` shape).
1746     * @param string[]                       $names  Block names to match.
1747     * @return array<string,mixed>|null
1748     */
1749    protected static function find_block_by_name( array $blocks, array $names ): ?array {
1750        foreach ( $blocks as $block ) {
1751            if ( in_array( $block['blockName'], $names, true ) ) {
1752                return $block;
1753            }
1754            if ( ! empty( $block['innerBlocks'] ) ) {
1755                $found = static::find_block_by_name( $block['innerBlocks'], $names );
1756                if ( null !== $found ) {
1757                    return $found;
1758                }
1759            }
1760        }
1761        return null;
1762    }
1763
1764    /**
1765     * Depth-first search that overwrites the first block named `$name` with
1766     * `$source`'s inner blocks. `innerBlocks`/`innerContent`/`innerHTML` are
1767     * copied together from `$source` so the null-placeholder bookkeeping in
1768     * `innerContent` stays internally consistent regardless of how many
1769     * filters `$source` has.
1770     *
1771     * @param array<int,array<string,mixed>> $blocks Parsed blocks, modified in place.
1772     * @param string                         $name   Block name to replace.
1773     * @param array<string,mixed>            $source Block whose inner content is cloned onto the match.
1774     * @return bool Whether a match was found and replaced.
1775     */
1776    protected static function replace_block_inner_content( array &$blocks, string $name, array $source ): bool {
1777        foreach ( $blocks as &$block ) {
1778            if ( $block['blockName'] === $name ) {
1779                $block['innerBlocks']  = $source['innerBlocks'];
1780                $block['innerContent'] = $source['innerContent'];
1781                $block['innerHTML']    = $source['innerHTML'];
1782                return true;
1783            }
1784            if ( ! empty( $block['innerBlocks'] ) && static::replace_block_inner_content( $block['innerBlocks'], $name, $source ) ) {
1785                return true;
1786            }
1787        }
1788        return false;
1789    }
1790
1791    /**
1792     * Idempotent wrapper around `register_block_template`. Unregisters first so
1793     * a stale entry from a prior init (long-lived PHP-FPM worker) is replaced
1794     * rather than triggering `doing_it_wrong`.
1795     *
1796     * @param string              $name Fully-qualified template name.
1797     * @param array<string,mixed> $args Args for register_block_template().
1798     */
1799    protected static function replace_block_template( string $name, array $args ) {
1800        if ( class_exists( '\WP_Block_Templates_Registry' ) ) {
1801            $registry = \WP_Block_Templates_Registry::get_instance();
1802            if ( $registry->is_registered( $name ) ) {
1803                $registry->unregister( $name );
1804            }
1805        }
1806        register_block_template( $name, $args );
1807    }
1808
1809    /**
1810     * Counterpart of `register_search_template()` for product search.
1811     */
1812    public static function register_product_search_template() {
1813        if ( ! function_exists( 'register_block_template' ) || ! static::block_templates_active() ) {
1814            return;
1815        }
1816        $content = static::get_product_search_template_content();
1817        if ( '' === $content ) {
1818            return;
1819        }
1820        static::replace_block_template(
1821            static::get_parent_plugin_slug() . '//' . self::PRODUCT_SEARCH_TEMPLATE_SLUG,
1822            array(
1823                'title'       => __( 'Jetpack Search Product Results', 'jetpack-search-pkg' ),
1824                'description' => __( 'Displays WooCommerce product search results with Jetpack Search filters.', 'jetpack-search-pkg' ),
1825                'content'     => $content,
1826            )
1827        );
1828    }
1829
1830    /**
1831     * Directory slug of the plugin that owns the template in the Site Editor UI.
1832     * Picked by preference so the more-specific "Jetpack Search" label wins
1833     * when both the standalone plugin and the Jetpack monolith are active:
1834     * `jetpack-search` → `jetpack` → `jetpack-search` fallback.
1835     *
1836     * @return string
1837     */
1838    protected static function get_parent_plugin_slug(): string {
1839        $active    = Helper::get_active_plugins();
1840        $preferred = array(
1841            'jetpack-search' => 'jetpack-search/jetpack-search.php',
1842            'jetpack'        => 'jetpack/jetpack.php',
1843        );
1844        foreach ( $preferred as $slug => $plugin_file ) {
1845            if ( in_array( $plugin_file, $active, true ) ) {
1846                return $slug;
1847            }
1848        }
1849        return 'jetpack-search';
1850    }
1851
1852    /**
1853     * Prepend the Jetpack Search slug to the search template hierarchy on
1854     * block-theme search requests. Existing occurrences are stripped first
1855     * so a second init pass / another filter on the same hook can't dup.
1856     *
1857     * WooCommerce product-search carve-out: override off → leave to WC's
1858     * prepend; override on → fall through here, then
1859     * `route_woocommerce_product_search_template()` swaps WC's slug for ours.
1860     *
1861     * @param string[] $templates Template hierarchy slugs.
1862     * @return string[]
1863     */
1864    public static function prepend_search_template( $templates ) {
1865        if ( ! is_search() || ! static::block_templates_active() ) {
1866            return $templates;
1867        }
1868        if ( ! static::woocommerce_search_template_override_enabled() && static::is_woocommerce_product_search() ) {
1869            return $templates;
1870        }
1871        $templates = array_values(
1872            array_filter(
1873                (array) $templates,
1874                static function ( $slug ) {
1875                    return self::SEARCH_TEMPLATE_SLUG !== $slug;
1876                }
1877            )
1878        );
1879        array_unshift( $templates, self::SEARCH_TEMPLATE_SLUG );
1880        return $templates;
1881    }
1882
1883    /**
1884     * Classic-theme counterpart to `prepend_search_template()`. Block-theme
1885     * hierarchy filters are a no-op on classic themes — `locate_template()`
1886     * walks slugs as `{slug}.php` and a classic theme doesn't ship one for
1887     * our slug. So let the hierarchy resolve normally, then swap the path
1888     * via `template_include` to our bundled PHP shim, which renders the same
1889     * block markup inside the theme's `get_header()`/`get_footer()`.
1890     *
1891     * @param string $template Resolved template path.
1892     * @return string
1893     */
1894    public static function route_classic_theme_search_template( $template ) {
1895        if ( ! is_search() ) {
1896            return $template;
1897        }
1898        $is_product_search = static::is_woocommerce_product_search();
1899        // Override off: leave product search to WooCommerce / the theme's own
1900        // archive routing — we don't impose the product shim without opt-in.
1901        if ( ! static::woocommerce_search_template_override_enabled() && $is_product_search ) {
1902            return $template;
1903        }
1904        // Override on + product search: route to the product-results shim.
1905        // Bail back to the theme's template if neither a customization nor a
1906        // bundled body is available — rendering header/footer around an empty
1907        // body looks broken.
1908        if ( $is_product_search ) {
1909            if ( null === Product_Search_Template::get_customized_content() && '' === static::get_classic_theme_product_search_body() ) {
1910                return $template;
1911            }
1912            return __DIR__ . '/templates/classic-theme-product-search.php';
1913        }
1914        // Regular (non-product) search: only Embedded takes over the whole search
1915        // page. Inline registers this router too (for the product shim above) but
1916        // leaves regular searches to the theme, so bail here unless Embedded.
1917        if ( Module_Control::EXPERIENCE_EMBEDDED !== ( new Module_Control() )->get_experience() ) {
1918            return $template;
1919        }
1920        // Same empty-body bail-out for the generic shim. A saved empty
1921        // customization ('' vs null) is honored as intentional.
1922        if ( null === Search_Template::get_customized_content() && '' === static::get_classic_theme_search_body() ) {
1923            return $template;
1924        }
1925        return __DIR__ . '/templates/classic-theme-search.php';
1926    }
1927
1928    /**
1929     * Classic-theme search body — same markup as the block-theme path with
1930     * top-level `core/template-part` references stripped so the theme's
1931     * `get_header()` / `get_footer()` drive the chrome.
1932     *
1933     * Source of truth: customized `Search_Template` CPT → bundled `jetpack-search.html`.
1934     * Public because `templates/classic-theme-search.php` calls it from outside the class.
1935     *
1936     * @return string Block markup, no template-part wrappers.
1937     */
1938    public static function get_classic_theme_search_body(): string {
1939        $customized = Search_Template::get_customized_content();
1940        if ( null !== $customized ) {
1941            return $customized;
1942        }
1943        return static::strip_top_level_template_parts( static::get_search_template_content() );
1944    }
1945
1946    /**
1947     * Product-search counterpart to {@see get_classic_theme_search_body()} —
1948     * source of truth for the classic-theme product-results shim. Customized
1949     * `Product_Search_Template` CPT → bundled `jetpack-search-product-results.html`.
1950     * Public because `templates/classic-theme-product-search.php` calls it from
1951     * outside the class.
1952     *
1953     * @return string Block markup, no template-part wrappers.
1954     */
1955    public static function get_classic_theme_product_search_body(): string {
1956        $customized = Product_Search_Template::get_customized_content();
1957        if ( null !== $customized ) {
1958            return $customized;
1959        }
1960        return static::strip_top_level_template_parts( static::get_product_search_template_content() );
1961    }
1962
1963    /**
1964     * Strip top-level `core/template-part` self-closing comments — classic
1965     * themes can't resolve their slugs. Non-greedy `.*?` capped by `-->` keeps
1966     * matching cleanly across template revisions and across nested attribute
1967     * payloads.
1968     *
1969     * @param string $content Block markup, possibly empty.
1970     * @return string
1971     */
1972    protected static function strip_top_level_template_parts( string $content ): string {
1973        if ( '' === $content ) {
1974            return '';
1975        }
1976        return (string) preg_replace( '#<!--\s*wp:template-part\s+.*?/-->\s*#s', '', $content );
1977    }
1978
1979    /**
1980     * Inline layout `<style>` block the classic-theme shims emit before the
1981     * bundled block markup. Classic themes don't emit core's block-supports
1982     * layout CSS, so two traits the bundled templates rely on collapse on
1983     * classic themes: the inner group's 1.5rem `blockGap` vanishes (search
1984     * input runs straight into the results row), and `alignwide` has no
1985     * effect (content stretches edge-to-edge because `template_include`
1986     * bypasses the theme's own content wrapper). Reapplying both, scoped to
1987     * `<main class="wp-block-group">`, restores parity without leaking
1988     * outside the shim. Shared by both shims so a future layout tweak
1989     * touches one place. The `<style>` `id` is unique per render — routing
1990     * ensures only one shim runs per request, so duplicate IDs can't occur.
1991     *
1992     * Public because both `templates/classic-theme-search.php` and
1993     * `templates/classic-theme-product-search.php` call it from outside the
1994     * class.
1995     *
1996     * @return string Inline `<style>` element ready to echo.
1997     */
1998    public static function get_classic_theme_layout_style(): string {
1999        return <<<'HTML'
2000<style id="jetpack-search-classic-theme-layout">
2001main.wp-block-group {
2002    max-width: var(--wp--style--global--wide-size, 1280px);
2003    margin-inline: auto;
2004    padding-inline: clamp(1rem, 4vw, 2rem);
2005}
2006main.wp-block-group .is-layout-flow > * + * {
2007    margin-block-start: var(--wp--style--block-gap, 1.5rem);
2008}
2009</style>
2010HTML;
2011    }
2012
2013    /**
2014     * Test override for `block_templates_active()`. Null = read the live state.
2015     *
2016     * @var bool|null
2017     */
2018    private static $block_templates_active_for_testing = null;
2019
2020    /**
2021     * Test seam. Set true/false to force `block_templates_active()`, or null to clear.
2022     *
2023     * @param bool|null $active Forced value, or null to clear.
2024     */
2025    public static function set_block_templates_active_for_testing( ?bool $active ): void {
2026        self::$block_templates_active_for_testing = $active;
2027    }
2028
2029    /**
2030     * Whether the theme resolves block templates. Overridable seam over
2031     * `wp_is_block_theme()` for tests.
2032     *
2033     * @return bool
2034     */
2035    protected static function block_templates_active(): bool {
2036        if ( null !== self::$block_templates_active_for_testing ) {
2037            return self::$block_templates_active_for_testing;
2038        }
2039        return wp_is_block_theme();
2040    }
2041
2042    /**
2043     * Front the `jetpack-search-product-results` template for WC product
2044     * search. Drops WC's `product-search-results` and unshifts ours so it
2045     * resolves before any `jetpack-search` prepend for the generic route.
2046     *
2047     * @param string[] $templates Template hierarchy slugs.
2048     * @return string[]
2049     */
2050    public static function route_woocommerce_product_search_template( $templates ) {
2051        // FSE-hierarchy work — classic themes resolve template slugs as `{slug}.php`
2052        // and there's no `jetpack-search-product-results.php`. The classic-theme
2053        // equivalent runs through `route_classic_theme_search_template()` instead.
2054        if ( ! static::block_templates_active() || ! static::is_woocommerce_product_search() ) {
2055            return $templates;
2056        }
2057        $templates = array_values(
2058            array_filter(
2059                (array) $templates,
2060                static function ( $slug ) {
2061                    return self::WC_PRODUCT_SEARCH_TEMPLATE_SLUG !== $slug
2062                        && self::PRODUCT_SEARCH_TEMPLATE_SLUG !== $slug;
2063                }
2064            )
2065        );
2066        array_unshift( $templates, self::PRODUCT_SEARCH_TEMPLATE_SLUG );
2067        return $templates;
2068    }
2069
2070    /**
2071     * Seed the Interactivity API store with initial state. Per-block render
2072     * callbacks deep-merge their own entries on top (e.g. filter-checkbox
2073     * writes its filterConfig). See AGENTS.md § Hydration & SSR seeding.
2074     */
2075    public static function seed_interactivity_state() {
2076        if ( ! function_exists( 'wp_interactivity_state' ) ) {
2077            return;
2078        }
2079        wp_interactivity_state(
2080            'jetpack-search',
2081            static::build_seed_state( static::collect_filter_configs_from_post() )
2082        );
2083    }
2084
2085    /**
2086     * Compose the final seeded state for `wp_interactivity_state()`.
2087     *
2088     * @param array<string, array<string, mixed>> $filter_configs Map of filter configs.
2089     * @return array<string, mixed>
2090     */
2091    public static function build_seed_state( array $filter_configs ): array {
2092        $state                  = static::build_initial_state();
2093        $state['filterConfigs'] = $filter_configs;
2094        return $state;
2095    }
2096
2097    /**
2098     * Walk the current post's block tree for filter blocks and build the
2099     * filterConfigs map. Template-part scans are not performed — a filter
2100     * inside a template part still works, but its config isn't available to
2101     * the search-results SSR until hydration.
2102     *
2103     * @return array<string, array<string, mixed>>
2104     */
2105    protected static function collect_filter_configs_from_post(): array {
2106        if ( ! function_exists( 'get_post' ) || ! function_exists( 'parse_blocks' ) ) {
2107            return array();
2108        }
2109        // Bail if any helper is missing — half-loaded feature would ship inconsistent filterConfigs.
2110        foreach ( static::filter_block_helpers() as $helper ) {
2111            if ( ! class_exists( $helper ) ) {
2112                return array();
2113            }
2114        }
2115        $post = get_post();
2116        if ( ! $post || empty( $post->post_content ) ) {
2117            return array();
2118        }
2119        $configs = array();
2120        static::walk_blocks_for_filter_configs( parse_blocks( $post->post_content ), $configs );
2121        return $configs;
2122    }
2123
2124    /**
2125     * Map of filter block name → helper class. Add a new filter block type
2126     * by appending one entry here.
2127     *
2128     * @return array<string, class-string>
2129     */
2130    protected static function filter_block_helpers(): array {
2131        $helpers = array(
2132            'jetpack-search/filter-checkbox'        => Filter_Checkbox::class,
2133            'jetpack-search/filter-date'            => Filter_Date::class,
2134            'jetpack-search/filter-wc-rating'       => Filter_Wc_Rating::class,
2135            'jetpack-search/filter-wc-attribute'    => Filter_Wc_Attribute::class,
2136            'jetpack-search/filter-wc-stock-status' => Search_Product_Filter_Status::class,
2137        );
2138        if ( self::woocommerce_blocks_enabled() ) {
2139            return $helpers;
2140        }
2141        // Non-Woo sites: drop WC-only entries so the filter-config walk stays
2142        // symmetric with what `register_blocks()` actually registered.
2143        foreach ( array_keys( $helpers ) as $name ) {
2144            if ( self::is_woocommerce_only_block( $name ) ) {
2145                unset( $helpers[ $name ] );
2146            }
2147        }
2148        return $helpers;
2149    }
2150
2151    /**
2152     * Recursively walk a parsed block tree, pushing each filter block's
2153     * config into `$configs` by reference.
2154     *
2155     * @param array $blocks  Parsed block tree from parse_blocks().
2156     * @param array $configs Accumulator map keyed by filterKey.
2157     * @return void
2158     */
2159    protected static function walk_blocks_for_filter_configs( array $blocks, array &$configs ): void {
2160        $helpers = static::filter_block_helpers();
2161        foreach ( $blocks as $block ) {
2162            if ( ! is_array( $block ) ) {
2163                continue;
2164            }
2165            $block_name = (string) ( $block['blockName'] ?? '' );
2166            if ( isset( $helpers[ $block_name ] ) ) {
2167                $helper = $helpers[ $block_name ];
2168                $attrs  = (array) ( $block['attrs'] ?? array() );
2169                $key    = $helper::derive_filter_key( $attrs );
2170                if ( '' !== $key ) {
2171                    $configs[ $key ] = $helper::build_config( $attrs, $key );
2172                }
2173            }
2174
2175            if ( ! empty( $block['innerBlocks'] ) && is_array( $block['innerBlocks'] ) ) {
2176                static::walk_blocks_for_filter_configs( $block['innerBlocks'], $configs );
2177            }
2178        }
2179    }
2180
2181    /**
2182     * Build the initial state array for the jetpack-search Interactivity API store.
2183     *
2184     * @return array<string, mixed>
2185     */
2186    public static function build_initial_state() {
2187        $is_private         = class_exists( Status::class ) ? ( new Status() )->is_private_site() : false;
2188        $is_wpcom           = class_exists( Helper::class ) ? Helper::is_wpcom() : false;
2189        $site_id            = class_exists( Helper::class ) ? Helper::get_wpcom_site_id() : 0;
2190        $search_query       = static::parse_url_search_query();
2191        $active_filters     = static::parse_url_filters();
2192        $filter_logic       = static::parse_url_filter_logic( $active_filters );
2193        $price_range        = static::parse_url_price_range();
2194        $is_initial_loading = static::is_initial_loading();
2195        $searching_text     = function_exists( '__' ) ? __( 'Searching…', 'jetpack-search-pkg' ) : 'Searching…';
2196
2197        return array(
2198            // Connection / routing config.
2199            'siteId'                     => $site_id,
2200            'apiRoot'                    => function_exists( 'rest_url' ) ? esc_url_raw( rest_url() ) : '',
2201            'nonce'                      => function_exists( 'wp_create_nonce' ) ? wp_create_nonce( 'wp_rest' ) : '',
2202            'isPrivateSite'              => $is_private,
2203            'isWpcom'                    => $is_wpcom,
2204            // TrainTracks gate, mirroring instant search's `disableTracking`
2205            // (Helper::get_search_options): suppresses `_tkq` pushes for
2206            // `?disable_tracking=1` crawlers/QA and the filter override.
2207            'disableTracking'            => static::is_tracking_disabled(),
2208            // Threaded through url-state so `?orderby=price_asc` round-trips on Woo only.
2209            'isWooCommerceBlocksEnabled' => self::woocommerce_blocks_enabled(),
2210            'homeUrl'                    => function_exists( 'home_url' ) ? home_url() : '',
2211            // Blog locale (not viewer's profile locale) for consistent
2212            // logged-out formatting. BCP47-ish (`en-US`).
2213            'locale'                     => function_exists( 'get_locale' )
2214                ? str_replace( '_', '-', get_locale() )
2215                : 'en-US',
2216            // PHP-style token string parsed client-side by `wp-date-format.js`
2217            // (IA view bundle can't import `@wordpress/date`). Empty → Intl fallback.
2218            'dateFormat'                 => function_exists( 'get_option' )
2219                ? (string) get_option( 'date_format', '' )
2220                : '',
2221
2222            // URL-seeded so deep links render on first paint.
2223            'searchQuery'                => $search_query,
2224            // `?s=` (empty value) must still fire the initial fetch; `searchQuery`
2225            // alone collapses present-but-empty and missing to `''`.
2226            'hasSearchParam'             => static::has_search_param(),
2227            'searchParamName'            => static::get_search_param_name(),
2228            'sortOrder'                  => static::parse_url_sort(),
2229            'activeFilters'              => $active_filters,
2230            'filterLogic'                => $filter_logic,
2231            'priceRange'                 => $price_range,
2232            // Scalar `?filter_id=value`; seeded as `{}` so JS readers see a defined shape.
2233            'staticFilterSelections'     => (object) array(),
2234
2235            // Each filter block's render.php deep-merges its entry. Shape:
2236            // `{ [key]: { filterKey, filterType, taxonomy, effectiveSlug, label, showCount, maxItems } }`.
2237            'filterConfigs'              => array(),
2238
2239            // JS hydration fills these. `aggregations` is stdClass so JS sees `{}`.
2240            'results'                    => array(),
2241            'aggregations'               => (object) array(),
2242            // See AGENTS.md § Filter bucket lifecycle.
2243            'retainedFilterOptions'      => (object) array(),
2244            'totalResults'               => 0,
2245            'pageHandle'                 => null,
2246
2247            // `isLoading` true on deep links keeps the empty-state hidden until
2248            // JS fires the initial fetch (otherwise "No results found" flashes).
2249            'isLoading'                  => $is_initial_loading,
2250            'isLoadingMore'              => false,
2251            'hasError'                   => false,
2252
2253            // Seeded so SSR resolves `data-wp-text` on first paint.
2254            'resultsCountText'           => $is_initial_loading ? $searching_text : '',
2255
2256            'strings'                    => static::build_initial_strings(),
2257            'priceCurrencySymbol'        => '$',
2258
2259            // Top-level (not under `strings`) — keeps Phan's `array<string,string>`
2260            // contract on `strings` intact.
2261            'aiExtendedLoadingHints'     => static::build_ai_extended_loading_hints(),
2262
2263            'wcStockStatusLabels'        => static::build_stock_status_labels(),
2264        );
2265    }
2266
2267    /**
2268     * Slug → display-label map for `wc_stock_status` selections, used by the
2269     * active-filters block for product-aware chips. RSM-1932 will swap this
2270     * for WC's translated labels (`wc_get_product_stock_status_options()`)
2271     * without changing the shape. Empty when the status helper isn't loaded.
2272     *
2273     * @return array<string, string>
2274     */
2275    protected static function build_stock_status_labels(): array {
2276        if ( ! class_exists( Search_Product_Filter_Status::class ) ) {
2277            return array();
2278        }
2279        $labels = array();
2280        foreach ( Search_Product_Filter_Status::get_options() as $option ) {
2281            $value = (string) ( $option['value'] ?? '' );
2282            if ( '' === $value ) {
2283                continue;
2284            }
2285            $labels[ $value ] = (string) ( $option['label'] ?? $value );
2286        }
2287        return $labels;
2288    }
2289
2290    /**
2291     * Whether the URL carries a search query, filter, or price range — i.e.
2292     * the JS store will fire an initial fetch on hydration. Render callbacks
2293     * use this to emit pre-hydration affordances (skeleton, "Searching…").
2294     *
2295     * URL-derived rather than read back from `wp_interactivity_state()`
2296     * because FSE pre-resolves block attributes before `wp_enqueue_scripts`
2297     * fires, so a state-read would silently return false on the very pages
2298     * this is meant to flag. Mirrors the `isLoading` seed exactly.
2299     *
2300     * @return bool
2301     */
2302    public static function is_initial_loading(): bool {
2303        if ( null !== self::$is_initial_loading_cache ) {
2304            return self::$is_initial_loading_cache;
2305        }
2306        // `has_search_param()` not `parse_url_search_query() !== ''` — an
2307        // explicit `?s=` (empty value) still means "visitor landed on a
2308        // search page" and should fire an unfiltered initial fetch.
2309        if ( static::has_search_param() ) {
2310            self::$is_initial_loading_cache = true;
2311            return true;
2312        }
2313        if ( ! empty( static::parse_url_filters() ) ) {
2314            self::$is_initial_loading_cache = true;
2315            return true;
2316        }
2317        self::$is_initial_loading_cache = null !== static::parse_url_price_range();
2318        return self::$is_initial_loading_cache;
2319    }
2320
2321    /**
2322     * Reset the `is_initial_loading()` memo. Tests only — PHPUnit reuses a
2323     * single process so `$_GET` from an earlier test would pin the value.
2324     * Guarded against accidental production use.
2325     */
2326    public static function reset_initial_loading_cache(): void {
2327        if ( defined( 'ABSPATH' ) && ! defined( 'PHPUNIT_COMPOSER_INSTALL' ) ) {
2328            return;
2329        }
2330        self::$is_initial_loading_cache = null;
2331    }
2332
2333    /**
2334     * Pre-hydration view state for a filter block's wrapper. Centralizes the
2335     * seeded-state read shared by filter-checkbox and filter-date so each
2336     * render.php branches on a single struct rather than re-deriving the
2337     * same flags inline.
2338     *
2339     * @param string $filter_key The filter key (e.g. `category`, `post_type`).
2340     * @return array{has_buckets:bool,is_initial_loading:bool,show_wrapper:bool}
2341     */
2342    public static function pre_hydration_filter_view( string $filter_key ): array {
2343        if ( ! function_exists( 'wp_interactivity_state' ) ) {
2344            return array(
2345                'has_buckets'        => false,
2346                'is_initial_loading' => false,
2347                'show_wrapper'       => false,
2348            );
2349        }
2350        // `aggregations` is seeded as `stdClass` when empty (so JS sees `{}`,
2351        // not `[]`); cast before subscripting so the read works in either shape.
2352        $state              = wp_interactivity_state( 'jetpack-search' );
2353        $aggs               = (array) ( $state['aggregations'] ?? array() );
2354        $has_buckets        = ! empty( $aggs[ $filter_key ]['buckets'] ?? array() );
2355        $is_initial_loading = static::is_initial_loading();
2356        return array(
2357            'has_buckets'        => $has_buckets,
2358            'is_initial_loading' => $is_initial_loading,
2359            'show_wrapper'       => $has_buckets || $is_initial_loading,
2360        );
2361    }
2362
2363    /**
2364     * Emit the `data-wp-context` attribute for a filter block's wrapper. The
2365     * seeded `wrapperHidden` value is what the IA SSR pass evaluates
2366     * `data-wp-bind--hidden="context.wrapperHidden"` against, and what the
2367     * `syncFilterWrapperVisibility` callback updates after hydration.
2368     *
2369     * @param string $filter_key   The filter key.
2370     * @param bool   $show_wrapper Whether the wrapper should be visible on first paint.
2371     */
2372    public static function emit_filter_wrapper_context( string $filter_key, bool $show_wrapper ): void {
2373        if ( ! function_exists( 'wp_interactivity_data_wp_context' ) ) {
2374            return;
2375        }
2376        echo wp_kses_data(
2377            wp_interactivity_data_wp_context(
2378                array(
2379                    'filterKey'     => $filter_key,
2380                    'wrapperHidden' => ! $show_wrapper,
2381                )
2382            )
2383        );
2384    }
2385
2386    /**
2387     * Normalize the shared `displayStyle` attribute to one of the two CSS
2388     * variants. `filter-wc-stock-status` and `filter-wc-rating` deliberately
2389     * don't ship a chip variant and don't call this helper.
2390     *
2391     * @param mixed $value Raw attribute value.
2392     * @return string Either 'checkbox-list' or 'chips'.
2393     */
2394    public static function normalize_display_style( $value ): string {
2395        return 'chips' === $value ? 'chips' : 'checkbox-list';
2396    }
2397
2398    /**
2399     * Seed translated view-bundle strings for the Interactivity API store.
2400     *
2401     * @return array<string, string>
2402     */
2403    protected static function build_initial_strings(): array {
2404        if ( ! function_exists( '__' ) || ! function_exists( '_n' ) ) {
2405            return array(
2406                'searching'               => 'Searching…',
2407                'resultsCountSingle'      => 'Found %d result',
2408                'resultsCountPlural'      => 'Found %d results',
2409                'removeFilter'            => 'Remove %s',
2410                'ratingStarsTop'          => '5 stars',
2411                'ratingStarsAndUpSingle'  => '%d star and up',
2412                'ratingStarsAndUpPlural'  => '%d stars and up',
2413                'priceRangeFromTo'        => '%1$s – %2$s',
2414                'priceRangeFrom'          => '%s+',
2415                'priceRangeUpTo'          => 'Under %s',
2416                'priceLabel'              => 'Price',
2417                'suggestionLabelQuery'    => 'Suggestions',
2418                'suggestionLabelTaxonomy' => 'Popular Filters',
2419                'suggestionLabelPost'     => 'Articles',
2420                'aiErrorMessage'          => 'Sorry, an error occurred while generating an answer.',
2421                'aiErrorCode'             => 'Error code: %s',
2422            );
2423        }
2424        return array(
2425            'searching'               => __( 'Searching…', 'jetpack-search-pkg' ),
2426            /* translators: %d: number of results. */
2427            'resultsCountSingle'      => _n( 'Found %d result', 'Found %d results', 1, 'jetpack-search-pkg' ),
2428            /* translators: %d: number of results. */
2429            'resultsCountPlural'      => _n( 'Found %d result', 'Found %d results', 2, 'jetpack-search-pkg' ),
2430            /* translators: %s: filter label (e.g. "Category: News"). Announced by screen readers when focus lands on a filter pill's remove button. */
2431            'removeFilter'            => __( 'Remove %s', 'jetpack-search-pkg' ),
2432            /* 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. */
2433            'ratingStarsTop'          => __( '5 stars', 'jetpack-search-pkg' ),
2434            /* 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. */
2435            'ratingStarsAndUpSingle'  => _n( '%d star and up', '%d stars and up', 1, 'jetpack-search-pkg' ),
2436            /* 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. */
2437            'ratingStarsAndUpPlural'  => _n( '%d star and up', '%d stars and up', 2, 'jetpack-search-pkg' ),
2438            /* 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. */
2439            'priceRangeFromTo'        => __( '%1$s – %2$s', 'jetpack-search-pkg' ),
2440            /* 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. */
2441            'priceRangeFrom'          => __( '%s+', 'jetpack-search-pkg' ),
2442            /* 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. */
2443            'priceRangeUpTo'          => __( 'Under %s', 'jetpack-search-pkg' ),
2444            /* 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. */
2445            'priceLabel'              => __( 'Price', 'jetpack-search-pkg' ),
2446            /* translators: Group label for the typed-query suggestions section of the Search Input autocomplete dropdown. */
2447            'suggestionLabelQuery'    => __( 'Suggestions', 'jetpack-search-pkg' ),
2448            /* translators: Group label for the taxonomy (category / tag) section of the Search Input autocomplete dropdown. */
2449            'suggestionLabelTaxonomy' => __( 'Popular Filters', 'jetpack-search-pkg' ),
2450            /* translators: Group label for the post-title section of the Search Input autocomplete dropdown. */
2451            'suggestionLabelPost'     => __( 'Articles', 'jetpack-search-pkg' ),
2452            /* 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. */
2453            'aiErrorMessage'          => __( 'Sorry, an error occurred while generating an answer.', 'jetpack-search-pkg' ),
2454            /* translators: %s: numeric error code. Surfaces the HTTP / JSON-RPC code that came back with the AI Answer failure, under the technical message. */
2455            'aiErrorCode'             => __( 'Error code: %s', 'jetpack-search-pkg' ),
2456        );
2457    }
2458
2459    /**
2460     * Rotating loading hints for the "Show more" extended AI answer.
2461     * Mirrors the overlay verbatim so visitors switching surfaces see
2462     * the same copy.
2463     *
2464     * @return array<int, string>
2465     */
2466    protected static function build_ai_extended_loading_hints(): array {
2467        // Strings omit trailing `…` — render.php appends an animated ellipsis,
2468        // so a static one would double up. Overlay does the same.
2469        if ( ! function_exists( '__' ) ) {
2470            return array(
2471                'Searching harder',
2472                'Looking deeper into this',
2473                'Finding a more complete answer',
2474                'Analyzing additional sources',
2475                'Gathering more details',
2476                'Pulling in more context',
2477                'Expanding the search',
2478                'Rolling up my virtual sleeves',
2479                'Digging through the archives',
2480                'Putting on my reading glasses',
2481                'Checking under the digital couch cushions',
2482                'Consulting the oracle',
2483                'Asking a smarter algorithm',
2484                'Brewing a fresh batch of insights',
2485                'Unleashing the full power of search',
2486            );
2487        }
2488        return array(
2489            __( 'Searching harder', 'jetpack-search-pkg' ),
2490            __( 'Looking deeper into this', 'jetpack-search-pkg' ),
2491            __( 'Finding a more complete answer', 'jetpack-search-pkg' ),
2492            __( 'Analyzing additional sources', 'jetpack-search-pkg' ),
2493            __( 'Gathering more details', 'jetpack-search-pkg' ),
2494            __( 'Pulling in more context', 'jetpack-search-pkg' ),
2495            __( 'Expanding the search', 'jetpack-search-pkg' ),
2496            __( 'Rolling up my virtual sleeves', 'jetpack-search-pkg' ),
2497            __( 'Digging through the archives', 'jetpack-search-pkg' ),
2498            __( 'Putting on my reading glasses', 'jetpack-search-pkg' ),
2499            __( 'Checking under the digital couch cushions', 'jetpack-search-pkg' ),
2500            __( 'Consulting the oracle', 'jetpack-search-pkg' ),
2501            __( 'Asking a smarter algorithm', 'jetpack-search-pkg' ),
2502            __( 'Brewing a fresh batch of insights', 'jetpack-search-pkg' ),
2503            __( 'Unleashing the full power of search', 'jetpack-search-pkg' ),
2504        );
2505    }
2506
2507    /**
2508     * Parse the search query from the URL using whichever key
2509     * `get_search_param_name()` returns (`s` on search routes, `q` elsewhere).
2510     * Public so render templates can seed their input from the same source.
2511     *
2512     * @return string
2513     */
2514    public static function parse_url_search_query(): string {
2515        $key = self::get_search_param_name();
2516        // 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.
2517        $raw = $_GET[ $key ] ?? '';
2518        if ( ! is_scalar( $raw ) ) {
2519            return '';
2520        }
2521        return trim( sanitize_text_field( wp_unslash( (string) $raw ) ) );
2522    }
2523
2524    /**
2525     * Whether the search-query key is present in `$_GET` (any value).
2526     * Distinguishes `?s=` (blank search) from a URL that omits the key —
2527     * `parse_url_search_query()` collapses both to `''`. Array-shaped
2528     * `?s[]=foo` reads as "not present" to stay in lockstep.
2529     *
2530     * @return bool
2531     */
2532    public static function has_search_param(): bool {
2533        $key = self::get_search_param_name();
2534        // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- read-only URL presence check; the value is never read here.
2535        return isset( $_GET[ $key ] ) && is_scalar( $_GET[ $key ] );
2536    }
2537
2538    /**
2539     * Parse the sort order from the URL, defaulting to 'relevance'. Allowed
2540     * values track `Results_Sort::get_all_option_keys()` — on non-Woo sites
2541     * a `?orderby=price_asc` deep link collapses to `relevance` (mirrors
2542     * `store/url-state.js`).
2543     *
2544     * @return string
2545     */
2546    protected static function parse_url_sort(): string {
2547        // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- read-only URL state.
2548        $orderby = isset( $_GET['orderby'] ) ? sanitize_key( wp_unslash( $_GET['orderby'] ) ) : '';
2549        $allowed = array_values(
2550            array_filter(
2551                Results_Sort::get_all_option_keys(),
2552                static function ( $key ) {
2553                    return 'relevance' !== $key;
2554                }
2555            )
2556        );
2557        return in_array( $orderby, $allowed, true ) ? $orderby : 'relevance';
2558    }
2559
2560    /**
2561     * Parse the price range from the URL. Mirrors `store/url-state.js`.
2562     * Either bound may be null for a half-open range; non-numeric or
2563     * negative values null out. Returns null entirely on non-Woo sites —
2564     * `min_price`/`max_price` are WC-only and a stray param shouldn't drive
2565     * the API into a `range` clause for a field the index doesn't have.
2566     *
2567     * @return array{min: float|null, max: float|null}|null
2568     */
2569    protected static function parse_url_price_range(): ?array {
2570        if ( ! self::woocommerce_blocks_enabled() ) {
2571            return null;
2572        }
2573        // phpcs:disable WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized,WordPress.Security.ValidatedSanitizedInput.MissingUnslash -- coerced to float in parse_price_bound().
2574        $min = self::parse_price_bound( $_GET['min_price'] ?? null );
2575        $max = self::parse_price_bound( $_GET['max_price'] ?? null );
2576        // phpcs:enable
2577
2578        if ( null === $min && null === $max ) {
2579            return null;
2580        }
2581        // Inverted bounds → empty ES `range` clause / zero results silently.
2582        // Treat as garbage and bail so the page falls back to unfiltered search.
2583        if ( null !== $min && null !== $max && $min > $max ) {
2584            return null;
2585        }
2586        return array(
2587            'min' => $min,
2588            'max' => $max,
2589        );
2590    }
2591
2592    /**
2593     * Coerce a single price-range URL value into a finite, non-negative float.
2594     *
2595     * @param mixed $raw Raw value pulled from $_GET.
2596     * @return float|null
2597     */
2598    private static function parse_price_bound( $raw ): ?float {
2599        if ( null === $raw || '' === $raw || ! is_scalar( $raw ) ) {
2600            return null;
2601        }
2602        // `is_numeric` keeps PHP in lockstep with JS's `Number()`: rejects
2603        // partially-numeric strings ("1.5.3") that `(float)` would silently
2604        // extract as `1.5` while `Number()` returns `NaN`.
2605        $raw = wp_unslash( $raw );
2606        if ( ! is_numeric( $raw ) ) {
2607            return null;
2608        }
2609        $num = (float) $raw;
2610        if ( ! is_finite( $num ) || $num < 0 ) {
2611            return null;
2612        }
2613        return $num;
2614    }
2615
2616    /**
2617     * Parse `?<filterKey>[]=<value>` URL params into `{ [filterKey]: string[] }`.
2618     * Mirrors the shape `store/url-state.js` writes (see AGENTS.md § URL format).
2619     * No registered-key filtering here — `filterConfigs` aren't available until
2620     * blocks render. The JS layer gates on hydration.
2621     *
2622     * Scalar `?post_type=<slug>` is also accepted as a shortcut for
2623     * `?post_types[]=<slug>` — matches WP/WC's own URL convention. Merged into
2624     * any existing array selections so `?post_type=foo&post_types[]=bar` reads
2625     * as `[foo, bar]`. Singular-form-on-an-array-key keeps its existing
2626     * "ignored noise" behaviour for every other filter.
2627     *
2628     * @return array<string, string[]>
2629     */
2630    protected static function parse_url_filters(): array {
2631        // phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- read-only URL state; sanitized per-value below.
2632        $raw = wp_unslash( $_GET );
2633        if ( ! is_array( $raw ) ) {
2634            return array();
2635        }
2636
2637        $out = array();
2638        foreach ( $raw as $key => $values ) {
2639            $filter_key = sanitize_key( (string) $key );
2640            if ( '' === $filter_key || in_array( $filter_key, self::RESERVED_QUERY_PARAMS, true ) ) {
2641                continue;
2642            }
2643            if ( 'post_type' === $filter_key ) {
2644                // `is_string` (not `is_scalar`) keeps the gate consistent with
2645                // `parse_url_filter_logic`'s value check — `$_GET` only ever
2646                // carries strings or arrays, and the array case takes the
2647                // `is_array( $values )` branch immediately below.
2648                if ( ! is_string( $values ) ) {
2649                    continue;
2650                }
2651                // `sanitize_key`, not `sanitize_text_field` — post-type slugs are
2652                // always lowercase + `[a-z0-9_-]`; the lowercase pass keeps a
2653                // `?post_type=Product` URL from reaching ES with the wrong case
2654                // and silently returning zero results.
2655                $slug = sanitize_key( $values );
2656                if ( '' === $slug ) {
2657                    continue;
2658                }
2659                $existing          = $out['post_types'] ?? array();
2660                $out['post_types'] = array_values( array_unique( array_merge( $existing, array( $slug ) ) ) );
2661                continue;
2662            }
2663            if ( ! is_array( $values ) ) {
2664                continue;
2665            }
2666            $clean = array_values(
2667                array_filter(
2668                    array_map( 'sanitize_text_field', $values ),
2669                    static function ( $v ) {
2670                        return '' !== $v;
2671                    }
2672                )
2673            );
2674            if ( $clean ) {
2675                $existing           = $out[ $filter_key ] ?? array();
2676                $out[ $filter_key ] = array_values( array_unique( array_merge( $existing, $clean ) ) );
2677            }
2678        }
2679        return $out;
2680    }
2681
2682    /**
2683     * Parse `?query_type_<key>=and` overrides into `{ [filterKey]: 'and' }`.
2684     * Only literal `'and'` is honoured — anything else is dropped so it
2685     * can't round-trip back through `pushStateToUrl`. Mirrors
2686     * `store/url-state.js`.
2687     *
2688     * @param array<string, string[]> $active_filters Result of parse_url_filters().
2689     * @return array<string, string>
2690     */
2691    protected static function parse_url_filter_logic( array $active_filters ): array {
2692        // phpcs:ignore WordPress.Security.NonceVerification.Recommended,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- read-only URL state; sanitized per-value below.
2693        $raw = wp_unslash( $_GET );
2694        if ( ! is_array( $raw ) ) {
2695            return array();
2696        }
2697
2698        $out = array();
2699        foreach ( $raw as $key => $value ) {
2700            if ( ! is_string( $key ) || 0 !== strpos( $key, 'query_type_' ) ) {
2701                continue;
2702            }
2703            if ( ! is_string( $value ) || 'and' !== $value ) {
2704                continue;
2705            }
2706            $filter_key = sanitize_key( substr( $key, strlen( 'query_type_' ) ) );
2707            if ( '' === $filter_key || in_array( $filter_key, self::RESERVED_QUERY_PARAMS, true ) ) {
2708                continue;
2709            }
2710            if ( empty( $active_filters[ $filter_key ] ) ) {
2711                continue;
2712            }
2713            $out[ $filter_key ] = 'and';
2714        }
2715        return $out;
2716    }
2717}