Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
68.73%
400 / 582
39.58%
19 / 48
 CRAP
0.00%
0 / 1
Jetpack_Gutenberg
69.32%
400 / 577
39.58%
19 / 48
 1917.59
0.00%
0 / 1
 is_gutenberg_version_available
87.50%
21 / 24
0.00%
0 / 1
 8.12
 prepend_block_prefix
0.00%
0 / 1
0.00%
0 / 1
 2
 remove_extension_prefix
100.00%
3 / 3
100.00%
1 / 1
 3
 share_items
0.00%
0 / 1
0.00%
0 / 1
 2
 set_extension_available
100.00%
2 / 2
100.00%
1 / 1
 1
 set_extension_unavailable
100.00%
10 / 10
100.00%
1 / 1
 4
 init
n/a
0 / 0
n/a
0 / 0
 1
 reset
100.00%
5 / 5
100.00%
1 / 1
 1
 get_blocks_directory
100.00%
1 / 1
100.00%
1 / 1
 1
 preset_exists
n/a
0 / 0
n/a
0 / 0
 1
 get_preset
66.67%
6 / 9
0.00%
0 / 1
 4.59
 get_jetpack_gutenberg_extensions_allowed_list
100.00%
3 / 3
100.00%
1 / 1
 3
 get_available_extensions
80.00%
4 / 5
0.00%
0 / 1
 3.07
 get_excluded_extensions
66.67%
2 / 3
0.00%
0 / 1
 2.15
 is_registered_and_no_entry_in_availability
100.00%
1 / 1
100.00%
1 / 1
 2
 is_available
100.00%
1 / 1
100.00%
1 / 1
 2
 get_cached_availability
0.00%
0 / 3
0.00%
0 / 1
 6
 get_availability
100.00%
13 / 13
100.00%
1 / 1
 6
 get_extensions
75.00%
6 / 8
0.00%
0 / 1
 4.25
 is_registered
100.00%
1 / 1
100.00%
1 / 1
 1
 is_gutenberg_available
0.00%
0 / 1
0.00%
0 / 1
 2
 should_load
100.00%
6 / 6
100.00%
1 / 1
 4
 register_blocks_assets_base_url
100.00%
10 / 10
100.00%
1 / 1
 3
 load_assets_as_required
90.00%
9 / 10
0.00%
0 / 1
 4.02
 load_styles_as_required
27.27%
3 / 11
0.00%
0 / 1
 19.85
 load_scripts_as_required
31.82%
7 / 22
0.00%
0 / 1
 28.29
 block_has_asset
100.00%
1 / 1
100.00%
1 / 1
 1
 get_asset_version
0.00%
0 / 3
0.00%
0 / 1
 12
 enqueue_block_editor_assets
78.26%
90 / 115
0.00%
0 / 1
 29.92
 get_no_post_editor_extensions
100.00%
4 / 4
100.00%
1 / 1
 4
 load_independent_blocks
100.00%
17 / 17
100.00%
1 / 1
 10
 lazy_register_deferred_block
100.00%
4 / 4
100.00%
1 / 1
 4
 register_deferred_blocks_in_subtree
95.00%
19 / 20
0.00%
0 / 1
 14
 load_and_register_deferred_block
85.00%
17 / 20
0.00%
0 / 1
 9.27
 warn_about_deferred_block_registration_failure
90.91%
10 / 11
0.00%
0 / 1
 4.01
 is_block_editor_context
96.43%
27 / 28
0.00%
0 / 1
 14
 load_block_editor_extensions
100.00%
16 / 16
100.00%
1 / 1
 7
 blocks_variation
88.00%
22 / 25
0.00%
0 / 1
 9.14
 get_extensions_preset_for_variation
40.00%
6 / 15
0.00%
0 / 1
 17.58
 validate_block_embed_url
92.59%
25 / 27
0.00%
0 / 1
 14.08
 should_show_frontend_preview
0.00%
0 / 5
0.00%
0 / 1
 12
 upgrade_nudge
0.00%
0 / 6
0.00%
0 / 1
 2
 notice
0.00%
0 / 34
0.00%
0 / 1
 72
 get_site_specific_features
0.00%
0 / 8
0.00%
0 / 1
 12
 set_availability_for_plan
66.67%
18 / 27
0.00%
0 / 1
 12.00
 get_render_callback_with_availability_check
0.00%
0 / 14
0.00%
0 / 1
 56
 display_deprecated_block_message
0.00%
0 / 9
0.00%
0 / 1
 20
 register_block_metadata_collection
33.33%
2 / 6
0.00%
0 / 1
 3.19
 set_block_js_loading_strategy
100.00%
1 / 1
100.00%
1 / 1
 1
 get_block_js_loading_strategy
100.00%
7 / 7
100.00%
1 / 1
 2
1<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2/**
3 * Handles server-side registration and use of all blocks and plugins available in Jetpack for the block editor, aka Gutenberg.
4 * Works in tandem with client-side block registration via `index.json`
5 *
6 * @package automattic/jetpack
7 */
8
9use Automattic\Jetpack\Assets;
10use Automattic\Jetpack\Assets\Shared_Stores_Assets;
11use Automattic\Jetpack\Blocks;
12use Automattic\Jetpack\Connection\Initial_State as Connection_Initial_State;
13use Automattic\Jetpack\Connection\Manager as Connection_Manager;
14use Automattic\Jetpack\Constants;
15use Automattic\Jetpack\Current_Plan as Jetpack_Plan;
16use Automattic\Jetpack\Modules;
17use Automattic\Jetpack\My_Jetpack\Initializer as My_Jetpack_Initializer;
18use Automattic\Jetpack\Plugin\Unavailable_Blocks;
19use Automattic\Jetpack\Status;
20use Automattic\Jetpack\Status\Host;
21
22if ( ! defined( 'ABSPATH' ) ) {
23    exit( 0 );
24}
25
26// Required directly so the AI master-gate helper is available regardless of
27// which loader pulled this class in.
28require_once __DIR__ . '/_inc/lib/class-jetpack-ai-settings.php';
29
30/**
31 * General Gutenberg editor specific functionality
32 */
33class Jetpack_Gutenberg {
34
35    /**
36     * Only these extensions can be registered. Used to control availability of beta blocks.
37     *
38     * @var array|null Extensions allowed list or `null` if not initialized yet.
39     * @see static::get_extensions()
40     */
41    private static $extensions = null;
42
43    /**
44     * Keeps track of the reasons why a given extension is unavailable.
45     *
46     * @var array Extensions availability information
47     */
48    private static $availability = array();
49
50    /**
51     * A cached array of the fully processed availability data. Keeps track of
52     * reasons why an extension is unavailable or missing.
53     *
54     * @var array Extensions availability information.
55     */
56    private static $cached_availability = null;
57
58    /**
59     * Site-specific features available.
60     * Their calculation can be expensive and slow, so we're caching it for the request.
61     *
62     * @var array Site-specific features
63     */
64    private static $site_specific_features = array();
65
66    /**
67     * List of deprecated blocks.
68     *
69     * @var array List of deprecated blocks.
70     */
71    private static $deprecated_blocks = array(
72        'jetpack/revue',
73    );
74
75    /**
76     * Display-only blocks whose registration PHP can be deferred until the block
77     * actually appears on a front-end page.
78     *
79     * Every block listed here has been verified to be "pure": the callback it hooks
80     * to `init` does nothing but call Blocks::jetpack_register_block() (plus trivial
81     * connection/module guards). It registers exactly one block type named
82     * `jetpack/<dir>` (matching its directory), and any front-end hooks it adds (asset
83     * enqueues, wp_footer, filters, …) live inside its render callback, so they only
84     * run when the block is rendered.
85     *
86     * On plain front-end requests these blocks are NOT loaded on `init`. Instead they
87     * are registered just-in-time the first time the block (or a block whose subtree
88     * contains it) is encountered while rendering, via self::lazy_register_deferred_block()
89     * on `pre_render_block`. On admin/REST/cron/CLI/XML-RPC (block-editor) requests they
90     * keep loading eagerly so the editor, the block-types REST endpoint and server-side
91     * rendering are unaffected.
92     *
93     * One class of front-end request is NOT safe to defer on: front-end block editors
94     * (e.g. P2) render the inserter on a plain front-end page, so is_block_editor_context()
95     * is false, yet the block must be registered at `init` for get_availability() to report
96     * it as available. self::load_independent_blocks() therefore never defers a block that
97     * ships in the `no-post-editor` preset (extensions/index.json) — those are exactly the
98     * blocks available in editors other than the post editor. A block listed here that is
99     * also in `no-post-editor` simply keeps loading eagerly.
100     *
101     * A block must NOT be added here if:
102     *   - its `init` callback registers any other hook, post meta, REST route,
103     *     shortcode, block pattern or hooked-block;
104     *   - it registers more than one block type, or a block name that differs from its
105     *     directory name (e.g. videopress registers `jetpack/videopress-block`); or
106     *   - it uses `plan_check` (its availability is computed from the init-time
107     *     `jetpack_register_gutenberg_extensions` hook, which lazy registration bypasses,
108     *     so the front-end availability nudge/render could read a stale value); or
109     *   - a front-end path reads its entry from get_cached_availability() before the
110     *     block renders. Deferred blocks appear unavailable there until the lazy
111     *     registration callback runs; or
112     *   - its block file can be `require`d by another runtime code path after `init`
113     *     (e.g. slideshow is included by modules/shortcodes/slideshow.php). The lazy
114     *     loader registers a block by running the `init` callback its include adds; if
115     *     the file was already included elsewhere, the include is a no-op and the
116     *     callback would never run, so the block would silently fail to register; or
117     *   - another runtime code path calls a function defined in its block file
118     *     (e.g. button defines Button\render_email(), called by subscriptions and
119     *     memberships for WooCommerce e-mail rendering). Deferring the file would leave
120     *     that function undefined when the dependent path runs; or
121     *   - it registers a `render_email_callback`. That callback is read off the
122     *     registered block type by the WooCommerce e-mail editor — an out-of-band
123     *     renderer that does not go through `pre_render_block`/`do_blocks` — so the block
124     *     must already be registered when an e-mail containing it is rendered, which can
125     *     happen on a front-end request (e.g. a transactional e-mail sent during checkout).
126     *
127     * When in doubt, leave it out: omitted blocks simply keep their current eager
128     * behavior.
129     *
130     * @since 16.0
131     * @var string[] Block feature names (directory names, without the `jetpack/` prefix).
132     */
133    private static $lazy_blocks = array(
134        'blog-stats',
135        'blogging-prompt',
136        'business-hours',
137        'eventbrite',
138        'gif',
139        'goodreads',
140        'google-calendar',
141        'google-docs-embed',
142        'image-compare',
143        'like',
144        'markdown',
145        'nextdoor',
146        'payments-intro',
147        'pinterest',
148        'related-posts',
149        'repeat-visitor',
150        'sharing-buttons',
151        'story',
152        'tock',
153        'top-posts',
154        'voice-to-content',
155    );
156
157    /**
158     * Blocks that were deferred on the current request and still need to be
159     * registered just-in-time when first rendered. Keyed by block feature name.
160     *
161     * @since 16.0
162     * @var array<string,bool>
163     */
164    private static $deferred_blocks = array();
165
166    /**
167     * Fallback minimum plan requirements for WordPress.com/Atomic sites.
168     *
169     * Used when features have conditional availability (e.g., sticker-based gating)
170     * and don't appear in features_data['available']. This only affects the upsell
171     * message shown to users.
172     *
173     * @since 15.5
174     * @var array Feature slug => minimum WordPress.com plan slug.
175     */
176    private static $wpcom_minimum_plan_fallbacks = array(
177        'donations'              => 'value_bundle',
178        'payment-buttons'        => 'value_bundle',
179        'paypal-payment-buttons' => 'value_bundle',
180    );
181
182    /**
183     * Storing the contents of the preset file.
184     *
185     * Already been json_decode.
186     *
187     * @var null|object JSON decoded object after first usage.
188     */
189    private static $preset_cache = null;
190
191    /**
192     * Keep track of JS loading strategies for each block that needs it.
193     *
194     * @var array<string, array|bool>
195     *
196     * @since 15.0
197     */
198    private static $block_js_loading_strategies = array();
199
200    /**
201     * Check to see if a minimum version of Gutenberg is available. Because a Gutenberg version is not available in
202     * php if the Gutenberg plugin is not installed, if we know which minimum WP release has the required version we can
203     * optionally fall back to that.
204     *
205     * @param array  $version_requirements An array containing the required Gutenberg version and, if known, the WordPress version that was released with this minimum version.
206     * @param string $slug The slug of the block or plugin that has the gutenberg version requirement.
207     *
208     * @since 8.3.0
209     *
210     * @return boolean True if the version of gutenberg required by the block or plugin is available.
211     */
212    public static function is_gutenberg_version_available( $version_requirements, $slug ) {
213        global $wp_version;
214
215        // Bail if we don't at least have the gutenberg version requirement, the WP version is optional.
216        if ( empty( $version_requirements['gutenberg'] ) ) {
217            return false;
218        }
219
220        // If running a local dev build of gutenberg plugin GUTENBERG_DEVELOPMENT_MODE is set so assume correct version.
221        if ( defined( 'GUTENBERG_DEVELOPMENT_MODE' ) && GUTENBERG_DEVELOPMENT_MODE ) {
222            return true;
223        }
224
225        $version_available = false;
226
227        // If running a production build of the gutenberg plugin then GUTENBERG_VERSION is set, otherwise if WP version
228        // with required version of Gutenberg is known check that.
229        if ( defined( 'GUTENBERG_VERSION' ) ) {
230            $version_available = version_compare( GUTENBERG_VERSION, $version_requirements['gutenberg'], '>=' );
231        } elseif ( ! empty( $version_requirements['wp'] ) ) {
232            $version_available = version_compare( $wp_version, $version_requirements['wp'], '>=' );
233        }
234
235        if ( ! $version_available ) {
236            $slug = self::remove_extension_prefix( $slug );
237            self::set_extension_unavailable(
238                $slug,
239                'incorrect_gutenberg_version',
240                array(
241                    'required_feature' => $slug,
242                    'required_version' => $version_requirements,
243                    'current_version'  => array(
244                        'wp'        => $wp_version,
245                        'gutenberg' => defined( 'GUTENBERG_VERSION' ) ? GUTENBERG_VERSION : null,
246                    ),
247                )
248            );
249        }
250
251        return $version_available;
252    }
253
254    /**
255     * Prepend the 'jetpack/' prefix to a block name
256     *
257     * @param string $block_name The block name.
258     *
259     * @return string The prefixed block name.
260     */
261    private static function prepend_block_prefix( $block_name ) {
262        return 'jetpack/' . $block_name;
263    }
264
265    /**
266     * Remove the 'jetpack/' or jetpack-' prefix from an extension name
267     *
268     * @param string $extension_name The extension name.
269     *
270     * @return string The unprefixed extension name.
271     */
272    public static function remove_extension_prefix( $extension_name ) {
273        if ( str_starts_with( $extension_name, 'jetpack/' ) || str_starts_with( $extension_name, 'jetpack-' ) ) {
274            return substr( $extension_name, strlen( 'jetpack/' ) );
275        }
276        return $extension_name;
277    }
278
279    /**
280     * Whether two arrays share at least one item
281     *
282     * @param array $a An array.
283     * @param array $b Another array.
284     *
285     * @return boolean True if $a and $b share at least one item
286     */
287    protected static function share_items( $a, $b ) {
288        return array_intersect( $a, $b ) !== array();
289    }
290
291    /**
292     * Set a (non-block) extension as available
293     *
294     * @param string $slug Slug of the extension.
295     */
296    public static function set_extension_available( $slug ) {
297        $slug                        = self::remove_extension_prefix( $slug );
298        self::$availability[ $slug ] = true;
299    }
300
301    /**
302     * Set the reason why an extension (block or plugin) is unavailable
303     *
304     * @param string $slug Slug of the extension.
305     * @param string $reason A string representation of why the extension is unavailable.
306     * @param array  $details A free-form array containing more information on why the extension is unavailable.
307     */
308    public static function set_extension_unavailable( $slug, $reason, $details = array() ) {
309        if (
310            // Extensions that require a plan may be eligible for upgrades.
311            'missing_plan' === $reason
312            && (
313                /**
314                 * Filter 'jetpack_block_editor_enable_upgrade_nudge' with `true` to enable or `false`
315                 * to disable paid feature upgrade nudges in the block editor.
316                 *
317                 * When this is changed to default to `true`, you should also update `modules/memberships/class-jetpack-memberships.php`
318                 * See https://github.com/Automattic/jetpack/pull/13394#pullrequestreview-293063378
319                 *
320                 * @since 7.7.0
321                 *
322                 * @param boolean
323                 */
324                ! apply_filters( 'jetpack_block_editor_enable_upgrade_nudge', false )
325                /** This filter is documented in _inc/lib/admin-pages/class.jetpack-react-page.php */
326                || ! apply_filters( 'jetpack_show_promotions', true )
327            )
328        ) {
329            // The block editor may apply an upgrade nudge if `missing_plan` is the reason.
330            // Add a descriptive suffix to disable behavior but provide informative reason.
331            $reason .= '__nudge_disabled';
332        }
333        $slug                        = self::remove_extension_prefix( $slug );
334        self::$availability[ $slug ] = array(
335            'reason'  => $reason,
336            'details' => $details,
337        );
338    }
339
340    /**
341     * Used to initialize the class, no longer in use.
342     *
343     * @return void
344     * @deprecated 12.2 No longer needed.
345     */
346    public static function init() {
347        _deprecated_function( __METHOD__, '12.2' );
348    }
349
350    /**
351     * Resets the class to its original state
352     *
353     * Used in unit tests
354     *
355     * @return void
356     */
357    public static function reset() {
358        self::$extensions                  = null;
359        self::$availability                = array();
360        self::$cached_availability         = null;
361        self::$block_js_loading_strategies = array();
362        self::$deferred_blocks             = array();
363    }
364
365    /**
366     * Return the Gutenberg extensions (blocks and plugins) directory
367     *
368     * @return string The Gutenberg extensions directory
369     */
370    public static function get_blocks_directory() {
371        /**
372         * Filter to select Gutenberg blocks directory
373         *
374         * @since 6.9.0
375         *
376         * @param string default: '_inc/blocks/'
377         */
378        return apply_filters( 'jetpack_blocks_directory', '_inc/blocks/' );
379    }
380
381    /**
382     * Checks for a given .json file in the blocks folder.
383     *
384     * @deprecated 14.3
385     *
386     * @param string $preset The name of the .json file to look for.
387     *
388     * @return bool True if the file is found.
389     */
390    public static function preset_exists( $preset ) {
391        _deprecated_function( __METHOD__, '14.3' );
392        return file_exists( JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $preset . '.json' );
393    }
394
395    /**
396     * Decodes JSON loaded from the preset file in the blocks folder
397     *
398     * @since 14.3 Deprecated argument. Only one value is ever used.
399     *
400     * @param null $deprecated No longer used.
401     *
402     * @return mixed Returns an object if the file is present, or false if a valid .json file is not present.
403     */
404    public static function get_preset( $deprecated = null ) {
405        if ( $deprecated ) {
406            _deprecated_argument( __METHOD__, '14.3', 'The $preset argument is no longer needed or used.' );
407        }
408
409        if ( self::$preset_cache ) {
410            return self::$preset_cache;
411        }
412
413        /*
414         * The manifest is a build artifact and is absent in a source checkout (e.g. when
415         * running the test suite). Return false — as documented — rather than calling
416         * wp_json_file_decode() on a missing file, which triggers _doing_it_wrong().
417         */
418        $preset_file = JETPACK__PLUGIN_DIR . self::get_blocks_directory() . 'index.json';
419        if ( ! file_exists( $preset_file ) ) {
420            return false;
421        }
422
423        self::$preset_cache = wp_json_file_decode( $preset_file );
424        return self::$preset_cache;
425    }
426
427    /**
428     * Returns a list of Jetpack Gutenberg extensions (blocks and plugins), based on index.json
429     *
430     * @return array A list of blocks: eg [ 'publicize', 'markdown' ]
431     */
432    public static function get_jetpack_gutenberg_extensions_allowed_list() {
433        $preset_extensions_manifest = ( defined( 'TESTING_IN_JETPACK' ) && TESTING_IN_JETPACK ) ? array() : self::get_preset();
434        $blocks_variation           = self::blocks_variation();
435
436        return self::get_extensions_preset_for_variation( $preset_extensions_manifest, $blocks_variation );
437    }
438
439    /**
440     * Returns a diff from a combined list of allowed extensions and extensions determined to be excluded
441     *
442     * @param  array $allowed_extensions An array of allowed extensions.
443     *
444     * @return array A list of blocks: eg array( 'publicize', 'markdown' )
445     */
446    public static function get_available_extensions( $allowed_extensions = null ) {
447        $exclusions         = self::get_excluded_extensions();
448        $allowed_extensions = $allowed_extensions === null ? self::get_jetpack_gutenberg_extensions_allowed_list() : $allowed_extensions;
449
450        // Avoid errors if option data is not as expected.
451        if ( ! is_array( $exclusions ) ) {
452            $exclusions = array();
453        }
454
455        return array_diff( $allowed_extensions, $exclusions );
456    }
457
458    /**
459     * Returns the extensions a site has excluded via the `jetpack_excluded_extensions` option.
460     *
461     * @return mixed The stored option value, or an empty array when none is set.
462     */
463    private static function get_excluded_extensions() {
464        // Without a persistent object cache, a missing option costs a query on every request, so store the empty default.
465        if ( ! wp_using_ext_object_cache() ) {
466            return Jetpack_Options::get_option_and_ensure_autoload( 'jetpack_excluded_extensions', array() );
467        }
468
469        return get_option( 'jetpack_excluded_extensions', array() );
470    }
471
472    /**
473     * Return true if the extension has been registered and there's nothing in the availablilty array.
474     *
475     * @param string $extension The name of the extension.
476     *
477     * @return bool whether the extension has been registered and there's nothing in the availablilty array.
478     */
479    public static function is_registered_and_no_entry_in_availability( $extension ) {
480        return self::is_registered( 'jetpack/' . $extension ) && ! isset( self::$availability[ $extension ] );
481    }
482
483    /**
484     * Return true if the extension has a true entry in the availablilty array.
485     *
486     * @param string $extension The name of the extension.
487     *
488     * @return bool whether the extension has a true entry in the availablilty array.
489     */
490    public static function is_available( $extension ) {
491        return isset( self::$availability[ $extension ] ) && true === self::$availability[ $extension ];
492    }
493
494    /**
495     * Get the availability of each block / plugin, or return the cached availability
496     * if it has already been calculated. Avoids re-registering extensions when not
497     * necessary.
498     *
499     * @return array A list of block and plugins and their availability status.
500     */
501    public static function get_cached_availability() {
502        if ( null === self::$cached_availability ) {
503            self::$cached_availability = self::get_availability();
504        }
505        return self::$cached_availability;
506    }
507
508    /**
509     * Get availability of each block / plugin.
510     *
511     * @return array A list of block and plugins and their availablity status
512     */
513    public static function get_availability() {
514        /**
515         * Fires before Gutenberg extensions availability is computed.
516         *
517         * In the function call you supply, use `Blocks::jetpack_register_block()` to set a block as available.
518         * Alternatively, use `Jetpack_Gutenberg::set_extension_available()` (for a non-block plugin), and
519         * `Jetpack_Gutenberg::set_extension_unavailable()` (if the block or plugin should not be registered
520         * but marked as unavailable).
521         *
522         * @since 7.0.0
523         */
524        do_action( 'jetpack_register_gutenberg_extensions' );
525
526        $available_extensions = array();
527
528        foreach ( static::get_extensions() as $extension ) {
529            $is_available                       = self::is_registered_and_no_entry_in_availability( $extension ) || self::is_available( $extension );
530            $available_extensions[ $extension ] = array(
531                'available' => $is_available,
532            );
533
534            if ( ! $is_available ) {
535                $reason  = isset( self::$availability[ $extension ] ) ? self::$availability[ $extension ]['reason'] : 'missing_module';
536                $details = isset( self::$availability[ $extension ] ) ? self::$availability[ $extension ]['details'] : array();
537                $available_extensions[ $extension ]['unavailable_reason'] = $reason;
538                $available_extensions[ $extension ]['details']            = $details;
539            }
540        }
541
542        return $available_extensions;
543    }
544
545    /**
546     * Return the list of extensions that are available.
547     *
548     * @since 11.9
549     *
550     * @return array A list of block and plugins and their availability status.
551     */
552    public static function get_extensions() {
553        if ( ! static::should_load() ) {
554            return array();
555        }
556
557        if ( null === self::$extensions ) {
558            /**
559             * Filter the list of block editor extensions that are available through Jetpack.
560             *
561             * @since 7.0.0
562             *
563             * @param array
564             */
565            self::$extensions = apply_filters( 'jetpack_set_available_extensions', self::get_available_extensions() );
566
567            if ( ! is_array( self::$extensions ) ) {
568                _doing_it_wrong( __METHOD__, esc_html__( 'The jetpack_set_available_extensions filter must return an array.', 'jetpack' ), '14.9' );
569                self::$extensions = array();
570            }
571        }
572
573        return self::$extensions;
574    }
575
576    /**
577     * Check if an extension/block is already registered
578     *
579     * @since 7.2
580     *
581     * @param string $slug Name of extension/block to check.
582     *
583     * @return bool
584     */
585    public static function is_registered( $slug ) {
586        return WP_Block_Type_Registry::get_instance()->is_registered( $slug );
587    }
588
589    /**
590     * Check if Gutenberg editor is available
591     *
592     * @since 6.7.0
593     *
594     * @return bool
595     */
596    public static function is_gutenberg_available() {
597        return true;
598    }
599
600    /**
601     * Check whether conditions indicate Gutenberg Extensions (blocks and plugins) should be loaded
602     *
603     * Loading blocks and plugins is enabled by default and may be disabled via filter:
604     *   add_filter( 'jetpack_gutenberg', '__return_false' );
605     *
606     * @since 6.9.0
607     *
608     * @return bool
609     */
610    public static function should_load() {
611        if ( ! Jetpack::is_connection_ready() && ! ( new Status() )->is_offline_mode() ) {
612            return false;
613        }
614
615        $return = true;
616
617        if ( ! ( new Modules() )->is_active( 'blocks' ) ) {
618            $return = false;
619        }
620
621        /**
622         * Filter to enable Gutenberg blocks.
623         *
624         * Defaults to true if (connected or in offline mode) and the Blocks module is active.
625         *
626         * @since 6.5.0
627         * @since 13.9 Filter is able to activate or deactivate Gutenberg blocks.
628         *
629         * @param bool true Whether to load Gutenberg blocks
630         */
631        return (bool) apply_filters( 'jetpack_gutenberg', $return );
632    }
633
634    /**
635     * Queue a script to set `Jetpack_Block_Assets_Base_Url`.
636     *
637     * In certain cases Webpack needs to know a base to load additional assets from.
638     * Normally it can determine that itself, but when JS concatenation is involved that tends to confuse it.
639     * We work around that by explicitly outputting a variable with the correct URL.
640     * We set that as its own "script" so we can reliably only output it once.
641     */
642    private static function register_blocks_assets_base_url() {
643        if ( ! wp_script_is( 'jetpack-blocks-assets-base-url', 'registered' ) ) {
644            // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.MissingVersion -- No actual script, so no version needed.
645            wp_register_script( 'jetpack-blocks-assets-base-url', false, array(), null, array( 'in_footer' => false ) );
646            $json_encode_flags = JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP;
647            if ( get_option( 'blog_charset' ) === 'UTF-8' ) {
648                $json_encode_flags |= JSON_UNESCAPED_UNICODE;
649            }
650            wp_add_inline_script(
651                'jetpack-blocks-assets-base-url',
652                'var Jetpack_Block_Assets_Base_Url=' . wp_json_encode( plugins_url( self::get_blocks_directory(), JETPACK__PLUGIN_FILE ), $json_encode_flags ) . ';',
653                'before'
654            );
655        }
656    }
657
658    /**
659     * Only enqueue block assets when needed.
660     *
661     * @param string $type Slug of the block or absolute path to the block source code directory.
662     * @param array  $script_dependencies Script dependencies. Will be merged with automatically
663     *                                    detected script dependencies from the webpack build.
664     *
665     * @return void
666     */
667    public static function load_assets_as_required( $type, $script_dependencies = array() ) {
668        if ( is_admin() ) {
669            // A block's view assets will not be required in wp-admin.
670            return;
671        }
672
673        // Retrieve the feature from block.json if a path is passed.
674        if ( path_is_absolute( $type ) ) {
675            $metadata = Blocks::get_block_metadata_from_file( Blocks::get_path_to_block_metadata( $type ) );
676            $feature  = Blocks::get_block_feature_from_metadata( $metadata );
677
678            if ( ! empty( $feature ) ) {
679                $type = $feature;
680            }
681        }
682
683        $type = sanitize_title_with_dashes( $type );
684        self::load_styles_as_required( $type );
685        self::load_scripts_as_required( $type, $script_dependencies );
686    }
687
688    /**
689     * Only enqueue block sytles when needed.
690     *
691     * @param string $type Slug of the block.
692     *
693     * @since 7.2.0
694     *
695     * @return void
696     */
697    public static function load_styles_as_required( $type ) {
698        if ( is_admin() ) {
699            // A block's view assets will not be required in wp-admin.
700            return;
701        }
702
703        // Enqueue styles.
704        $style_relative_path = self::get_blocks_directory() . $type . '/view' . ( is_rtl() ? '.rtl' : '' ) . '.css';
705        if ( self::block_has_asset( $style_relative_path ) ) {
706            $style_version = self::get_asset_version( $style_relative_path );
707            $view_style    = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
708            $view_style    = add_query_arg( 'minify', 'false', $view_style );
709
710            // If this is a customizer preview, render the style directly to the preview after autosave.
711            // phpcs:ignore WordPress.Security.NonceVerification.Recommended
712            if ( is_customize_preview() && ! empty( $_GET['customize_autosaved'] ) ) {
713                // phpcs:ignore WordPress.WP.EnqueuedResources.NonEnqueuedStylesheet
714                echo '<link rel="stylesheet" id="jetpack-block-' . esc_attr( $type ) . '" href="' . esc_attr( $view_style ) . '&amp;ver=' . esc_attr( $style_version ) . '" media="all">';
715            } else {
716                wp_enqueue_style( 'jetpack-block-' . $type, $view_style, array(), $style_version );
717                wp_style_add_data( 'jetpack-block-' . $type, 'path', JETPACK__PLUGIN_DIR . $style_relative_path );
718            }
719        }
720    }
721
722    /**
723     * Only enqueue block scripts when needed.
724     *
725     * @param string $type Slug of the block.
726     * @param array  $script_dependencies Script dependencies. Will be merged with automatically
727     *                             detected script dependencies from the webpack build.
728     *
729     * @since 7.2.0
730     *
731     * @return void
732     */
733    public static function load_scripts_as_required( $type, $script_dependencies = array() ) {
734        if ( is_admin() ) {
735            // A block's view assets will not be required in wp-admin.
736            return;
737        }
738
739        self::register_blocks_assets_base_url();
740
741        // Enqueue script.
742        $script_relative_path  = self::get_blocks_directory() . $type . '/view.js';
743        $script_deps_path      = JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $type . '/view.asset.php';
744        $script_dependencies[] = 'jetpack-blocks-assets-base-url';
745        if ( file_exists( $script_deps_path ) ) {
746            $asset_manifest      = include $script_deps_path;
747            $script_dependencies = array_unique( array_merge( $script_dependencies, $asset_manifest['dependencies'] ) );
748        }
749
750        if ( ! Blocks::is_amp_request() && self::block_has_asset( $script_relative_path ) ) {
751            $script_version = self::get_asset_version( $script_relative_path );
752            $view_script    = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
753            $view_script    = add_query_arg( 'minify', 'false', $view_script );
754            $strategy       = self::get_block_js_loading_strategy( $type );
755
756            // Enqueue dependencies.
757            wp_enqueue_script( 'jetpack-block-' . $type, $view_script, $script_dependencies, $script_version, $strategy );
758
759            // If this is a customizer preview, enqueue the dependencies and render the script directly to the preview after autosave.
760            // phpcs:ignore WordPress.Security.NonceVerification.Recommended
761            if ( is_customize_preview() && ! empty( $_GET['customize_autosaved'] ) ) {
762                // The Map block is dependent on wp-element, and it doesn't appear to to be possible to load
763                // this dynamically into the customizer iframe currently.
764                if ( 'map' === $type ) {
765                    echo '<div>' . esc_html__( 'No map preview available. Publish and refresh to see this widget.', 'jetpack' ) . '</div>';
766                    echo '<script>';
767                    echo 'Array.from(document.getElementsByClassName(\'wp-block-jetpack-map\')).forEach(function(element){element.style.display = \'none\';})';
768                    echo '</script>';
769                } else {
770                    echo '<script id="jetpack-block-' . esc_attr( $type ) . '" src="' . esc_attr( $view_script ) . '&amp;ver=' . esc_attr( $script_version ) . '"></script>';
771                }
772            }
773        }
774    }
775
776    /**
777     * Check if an asset exists for a block.
778     *
779     * @param string $file Path of the file we are looking for.
780     *
781     * @return bool $block_has_asset Does the file exist.
782     */
783    public static function block_has_asset( $file ) {
784        return file_exists( JETPACK__PLUGIN_DIR . $file );
785    }
786
787    /**
788     * Get the version number to use when loading the file. Allows us to bypass cache when developing.
789     *
790     * @param string $file Path of the file we are looking for.
791     *
792     * @return string $script_version Version number.
793     */
794    public static function get_asset_version( $file ) {
795        return Jetpack::is_development_version() && self::block_has_asset( $file )
796            ? filemtime( JETPACK__PLUGIN_DIR . $file )
797            : JETPACK__VERSION;
798    }
799
800    /**
801     * Load Gutenberg editor assets
802     *
803     * @since 6.7.0
804     *
805     * @return void
806     */
807    public static function enqueue_block_editor_assets() {
808        if ( ! self::should_load() ) {
809            return;
810        }
811
812        /*
813         * When the user returns to the editor right after a successful plan
814         * purchase (signalled by the `plan_upgraded` redirect argument), refresh
815         * the locally cached plan from WordPress.com before block availability is
816         * computed below. Otherwise `available_blocks` is derived from the stale
817         * `jetpack_active_plan` option (only refreshed by the daily heartbeat) and
818         * paid blocks keep showing their upgrade nudge even though the plan is now
819         * active. Simple sites gate features live via `wpcom_site_has_feature()`,
820         * so they neither need nor benefit from this.
821         *
822         * The refresh is a blocking WordPress.com request, so it is guarded to run
823         * only on a connected, non-WPCOM site, throttled to once per minute (a
824         * repeated or bookmarked `?plan_upgraded` URL cannot trigger a request on
825         * every load), and time-boxed so a slow origin cannot hang the editor. The
826         * client-side reload fallback covers a skipped or failed refresh. The value
827         * is only used to trigger a cache refresh from an authoritative source, so
828         * no nonce is required. See FORMS-712.
829         */
830        if (
831            ! empty( $_GET['plan_upgraded'] ) // phpcs:ignore WordPress.Security.NonceVerification.Recommended
832            && ! ( defined( 'IS_WPCOM' ) && IS_WPCOM )
833            && Jetpack::is_connection_ready()
834            && ! get_transient( 'jetpack_plan_upgraded_refresh' )
835        ) {
836            set_transient( 'jetpack_plan_upgraded_refresh', 1, MINUTE_IN_SECONDS );
837
838            $cap_plan_refresh_timeout = static function () {
839                return 5;
840            };
841            add_filter( 'http_request_timeout', $cap_plan_refresh_timeout, PHP_INT_MAX );
842            Jetpack_Plan::refresh_from_wpcom();
843            remove_filter( 'http_request_timeout', $cap_plan_refresh_timeout, PHP_INT_MAX );
844        }
845
846        $status = new Status();
847
848        // Required for Analytics. See _inc/lib/admin-pages/class.jetpack-admin-page.php.
849        if ( ! $status->is_offline_mode() && Jetpack::is_connection_ready() ) {
850            wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
851        }
852
853        $blocks_dir       = self::get_blocks_directory();
854        $blocks_variation = self::blocks_variation();
855
856        if ( 'production' !== $blocks_variation ) {
857            $blocks_env = '-' . esc_attr( $blocks_variation );
858        } else {
859            $blocks_env = '';
860        }
861
862        self::register_blocks_assets_base_url();
863
864        Assets::register_script(
865            'jetpack-blocks-editor',
866            "{$blocks_dir}editor{$blocks_env}.js",
867            JETPACK__PLUGIN_FILE,
868            array(
869                'textdomain'   => 'jetpack',
870                'dependencies' => array( 'jetpack-blocks-assets-base-url' ),
871            )
872        );
873
874        /**
875         * This can be called multiple times per page load in the admin, during the `enqueue_block_assets` action.
876         * These assets are necessary for the admin for editing but are not necessary for each pattern preview.
877         * Therefore we dequeue them, so they don't load for each pattern preview iframe.
878         */
879        if ( ! wp_should_load_block_editor_scripts_and_styles() ) {
880            wp_dequeue_script( 'jp-tracks' );
881            wp_dequeue_script( 'jetpack-blocks-editor' );
882
883            return;
884        }
885
886        // Hack around #20357 (specifically, that the editor bundle depends on
887        // wp-edit-post but wp-edit-post's styles break the Widget Editor and
888        // Site Editor) until a real fix gets unblocked.
889        // @todo Remove this once #20357 is properly fixed.
890        $wp_styles_fix = wp_styles()->query( 'jetpack-blocks-editor', 'registered' );
891        if ( empty( $wp_styles_fix ) ) {
892            wp_die( 'Your installation of Jetpack is incomplete. Please run "jetpack build plugins/jetpack" in your dev env.' );
893        }
894        wp_styles()->query( 'jetpack-blocks-editor', 'registered' )->deps = array();
895
896        Assets::enqueue_script( 'jetpack-blocks-editor' );
897
898        if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
899            $user                      = wp_get_current_user();
900            $user_data                 = array(
901                'email'    => $user->user_email,
902                'userid'   => $user->ID,
903                'username' => $user->user_login,
904            );
905            $blog_id                   = get_current_blog_id();
906            $is_current_user_connected = true;
907        } else {
908            $user_data                 = Jetpack_Tracks_Client::get_connected_user_tracks_identity();
909            $blog_id                   = Jetpack_Options::get_option( 'id', 0 );
910            $is_current_user_connected = ( new Connection_Manager( 'jetpack' ) )->is_user_connected();
911        }
912
913        if ( $blocks_variation === 'beta' && $is_current_user_connected ) {
914            wp_enqueue_style( 'recoleta-font', '//s1.wp.com/i/fonts/recoleta/css/400.min.css', array(), Constants::get_constant( 'JETPACK__VERSION' ) );
915        }
916        // AI Assistant
917        // The SEO package registers the setting for saving once it starts; see the seo-enhancer store.
918        // Not `Initializer::is_available()`: WordPress.com may not start it on every site the plan allows.
919        $is_seo_auto_enhance_switchable = apply_filters( 'ai_seo_enhancer_enabled', true )
920            && did_action( 'jetpack_seo_init' ) > 0;
921        $ai_assistant_state             = array(
922            'is-enabled'                     => Jetpack_AI_Settings::is_ai_enabled(),
923            'is-seo-enabled'                 => Jetpack_AI_Settings::is_ai_seo_enabled(),
924            'is-seo-auto-enhance-switchable' => $is_seo_auto_enhance_switchable,
925            'is-seo-auto-enhance-enabled'    => $is_seo_auto_enhance_switchable && (bool) get_option( 'ai_seo_enhancer_enabled', false ),
926        );
927
928        $screen_base = null;
929        if ( function_exists( 'get_current_screen' ) ) {
930            $current_screen = get_current_screen();
931            $screen_base    = $current_screen ? $current_screen->base : null;
932        }
933
934        $modules = array();
935        if ( class_exists( 'Jetpack_Core_API_Module_List_Endpoint' ) ) {
936            $module_list_endpoint = new Jetpack_Core_API_Module_List_Endpoint();
937            $modules              = $module_list_endpoint->get_modules();
938        }
939
940        // WordPress.com Simple can load this class without the plugin's autoloaded classes.
941        $available_blocks = class_exists( Unavailable_Blocks::class )
942            ? Unavailable_Blocks::describe_inactive_modules( self::get_availability() )
943            : self::get_availability();
944
945        $jetpack_plan  = Jetpack_Plan::get();
946        $initial_state = array(
947            'available_blocks' => $available_blocks,
948            'blocks_variation' => $blocks_variation,
949            'modules'          => $modules,
950            'jetpack'          => array(
951                'is_active'                     => Jetpack::is_connection_ready(),
952                'is_current_user_connected'     => $is_current_user_connected,
953                /** This filter is documented in class.jetpack-gutenberg.php */
954                'enable_upgrade_nudge'          => apply_filters( 'jetpack_block_editor_enable_upgrade_nudge', false ),
955                'is_private_site'               => $status->is_private_site(),
956                'is_coming_soon'                => $status->is_coming_soon(),
957                'is_offline_mode'               => $status->is_offline_mode(),
958                'is_newsletter_feature_enabled' => class_exists( '\Jetpack_Memberships' ),
959                // Whether the current user may send a newsletter test email to an
960                // address other than their own. The wpcom guard enforces this on send
961                // (also checking add_users and site stickers); this flag only controls
962                // whether the editor's recipient field is editable. Approximated with
963                // manage_options so editors, who can only test-send to themselves,
964                // aren't shown an editable field that would always be rejected.
965                'can_send_test_email_to_others' => current_user_can( 'manage_options' ),
966                // Which settings-driven subscribe placements are on, for the Site Editor's admin-only notice.
967                'subscribe_placements'          => current_user_can( 'manage_options' ) ? array(
968                    'sm_enabled'                        => (bool) get_option( 'sm_enabled', false ),
969                    'jetpack_subscribe_overlay_enabled' => (bool) get_option( 'jetpack_subscribe_overlay_enabled', false ),
970                    'jetpack_subscribe_floating_button_enabled' => (bool) get_option( 'jetpack_subscribe_floating_button_enabled', false ),
971                    'wpcom_action_bar'                  => ( new Host() )->is_wpcom_simple() && ! get_option( 'wpcom_hide_action_bar' ),
972                ) : null,
973                // this is the equivalent of JP initial state siteData.showMyJetpack (class-jetpack-redux-state-helper)
974                // used to determine if we can link to My Jetpack from the block editor
975                'is_my_jetpack_available'       => My_Jetpack_Initializer::should_initialize(),
976                'jetpack_plan'                  => array(
977                    'data' => $jetpack_plan['product_slug'],
978                ),
979                /**
980                 * Enable the RePublicize UI in the block editor context.
981                 *
982                 * @module publicize
983                 *
984                 * @since 10.3.0
985                 * @deprecated 11.5 This is a feature flag that is no longer used.
986                 *
987                 * @param bool true Enable the RePublicize UI in the block editor context. Defaults to true.
988                 */
989                'republicize_enabled'           => apply_filters( 'jetpack_block_editor_republicize_feature', true ),
990            ),
991            'siteFragment'     => $status->get_site_suffix(),
992            'adminUrl'         => esc_url( admin_url() ),
993            'tracksUserData'   => $user_data,
994            'wpcomBlogId'      => $blog_id,
995            'allowedMimeTypes' => wp_get_mime_types(),
996            'siteLocale'       => str_replace( '_', '-', get_locale() ),
997            'ai-assistant'     => $ai_assistant_state,
998            'screenBase'       => $screen_base,
999            /**
1000             * Add your own feature flags to the block editor.
1001             *
1002             * You can access the feature flags in the block editor via hasFeatureFlag( 'your-feature-flag' ) function.
1003             *
1004             * @since 14.8
1005             *
1006             * @param array true Enable the RePublicize UI in the block editor context. Defaults to true.
1007             */
1008            'feature_flags'    => apply_filters( 'jetpack_block_editor_feature_flags', array() ),
1009            'pluginBasePath'   => plugins_url( '', Constants::get_constant( 'JETPACK__PLUGIN_FILE' ) ),
1010        );
1011
1012        wp_localize_script(
1013            Shared_Stores_Assets::SCRIPT_HANDLE,
1014            'Jetpack_Editor_Initial_State',
1015            $initial_state
1016        );
1017
1018        // Adds Connection package initial state.
1019        Connection_Initial_State::render_script( 'jetpack-blocks-editor' );
1020    }
1021
1022    /**
1023     * Block feature names in the `no-post-editor` preset (extensions/index.json): blocks
1024     * whose editor bundle is usable outside the post editor, so they appear in front-end
1025     * block editors such as P2. These must never be deferred (see self::$lazy_blocks and
1026     * self::load_independent_blocks()).
1027     *
1028     * @since 16.2
1029     *
1030     * @return string[] Feature names, or an empty array when the preset is unavailable.
1031     */
1032    private static function get_no_post_editor_extensions() {
1033        $preset = self::get_preset();
1034        if ( is_object( $preset ) && isset( $preset->{'no-post-editor'} ) && is_array( $preset->{'no-post-editor'} ) ) {
1035            return $preset->{'no-post-editor'};
1036        }
1037        return array();
1038    }
1039
1040    /**
1041     * Some blocks do not depend on a specific module,
1042     * and can consequently be loaded outside of the usual modules.
1043     * We will look for such modules in the extensions/ directory.
1044     *
1045     * @since 7.1.0
1046     * @since 16.0 Pure display blocks are deferred on front-end requests and registered on first render.
1047     * @since 16.2 Blocks in the `no-post-editor` preset are never deferred, so front-end editors (e.g. P2) keep them.
1048     * @see wp_common_block_scripts_and_styles()
1049     */
1050    public static function load_independent_blocks() {
1051        if ( self::should_load() ) {
1052            /**
1053             * Look for files that match our list of available Jetpack Gutenberg extensions (blocks and plugins).
1054             * If available, load them.
1055             */
1056            $directories = array( 'blocks', 'plugins', 'extended-blocks' );
1057
1058            /*
1059             * On plain front-end requests, defer the registration PHP of pure display
1060             * blocks (see self::$lazy_blocks) until the block is actually encountered
1061             * while rendering. The block editor, the block-types REST endpoint and
1062             * server-side rendering all run in a "block-editor context" and keep loading
1063             * every block eagerly, so their behavior is unchanged.
1064             */
1065            $defer = ! self::is_block_editor_context();
1066
1067            /*
1068             * Front-end block editors (e.g. P2) render the inserter on a plain front-end
1069             * request, so is_block_editor_context() is false there, yet a block must be
1070             * registered on `init` for get_availability() to report it and keep it in the
1071             * inserter. Never defer a block that ships in the `no-post-editor` preset —
1072             * those are precisely the blocks usable outside the post editor.
1073             */
1074            $no_post_editor_blocks = $defer ? self::get_no_post_editor_extensions() : array();
1075
1076            foreach ( static::get_extensions() as $extension ) {
1077                if (
1078                    $defer
1079                    && in_array( $extension, self::$lazy_blocks, true )
1080                    && ! in_array( $extension, $no_post_editor_blocks, true )
1081                ) {
1082                    self::$deferred_blocks[ $extension ] = true;
1083                    continue;
1084                }
1085
1086                foreach ( $directories as $dirname ) {
1087                    $path = JETPACK__PLUGIN_DIR . "extensions/{$dirname}/{$extension}/{$extension}.php";
1088
1089                    if ( file_exists( $path ) ) {
1090                        include_once $path;
1091                        continue 2;
1092                    }
1093                }
1094            }
1095
1096            if ( ! empty( self::$deferred_blocks ) ) {
1097                add_filter( 'pre_render_block', array( __CLASS__, 'lazy_register_deferred_block' ), 10, 3 );
1098            }
1099        }
1100    }
1101
1102    /**
1103     * Register deferred blocks present in a top-level block's subtree before it renders.
1104     *
1105     * Hooked to `pre_render_block`. For a top-level block ($parent_block is null) the
1106     * filter fires before core builds the block's WP_Block object, so we walk the whole
1107     * parsed subtree and register every deferred Jetpack block it contains. This must
1108     * happen at the top level: core resolves an inner block's `block_type` when it
1109     * constructs that inner WP_Block, which is *before* the inner block's own
1110     * `pre_render_block` fires — so registering a deferred dynamic block only when its
1111     * own inner filter fires would be too late and its render_callback would be skipped.
1112     * Inner-block invocations (non-null $parent_block) are ignored because the top-level
1113     * walk has already handled the whole tree. Returns $pre_render untouched.
1114     *
1115     * @since 16.0
1116     *
1117     * @param string|null    $pre_render   The pre-rendered content. Default null.
1118     * @param array          $parsed_block The parsed block being rendered.
1119     * @param \WP_Block|null $parent_block Parent block, or null for a top-level block.
1120     *
1121     * @return string|null Unchanged $pre_render.
1122     */
1123    public static function lazy_register_deferred_block( $pre_render, $parsed_block, $parent_block = null ) {
1124        // Respect any earlier short-circuit, only act on top-level blocks, and stop
1125        // once every deferred block on the page has been registered.
1126        if ( null !== $pre_render || null !== $parent_block || empty( self::$deferred_blocks ) ) {
1127            return $pre_render;
1128        }
1129
1130        self::register_deferred_blocks_in_subtree( $parsed_block );
1131
1132        return $pre_render;
1133    }
1134
1135    /**
1136     * Recursively register any deferred Jetpack blocks found in a parsed block subtree.
1137     *
1138     * @since 16.0
1139     *
1140     * @param array $parsed_block A parsed block (with optional `innerBlocks`).
1141     * @param array $seen_refs    Reusable-block IDs already visited, to guard against cycles.
1142     *
1143     * @return void
1144     */
1145    private static function register_deferred_blocks_in_subtree( $parsed_block, &$seen_refs = array() ) {
1146        if ( empty( self::$deferred_blocks ) ) {
1147            return;
1148        }
1149
1150        $block_name = $parsed_block['blockName'] ?? '';
1151        if ( '' !== $block_name && str_starts_with( $block_name, 'jetpack/' ) ) {
1152            $feature = substr( $block_name, strlen( 'jetpack/' ) );
1153            if ( ! empty( self::$deferred_blocks[ $feature ] ) ) {
1154                // Only attempt registration once per block, whether or not it succeeds
1155                // (a block guarded by a connection/module check may intentionally not register).
1156                unset( self::$deferred_blocks[ $feature ] );
1157
1158                if ( ! self::is_registered( $block_name ) ) {
1159                    self::load_and_register_deferred_block( $feature );
1160                }
1161            }
1162        }
1163
1164        /*
1165         * A synced pattern / reusable block (core/block) keeps its content in a separate
1166         * wp_block post that core only parses at render time (render_block_core_block),
1167         * so it is absent from this parsed tree. Resolve the reference and recurse so a
1168         * deferred block inside the pattern is registered before core builds its WP_Block.
1169         *
1170         * core/navigation has the same ref-based hidden-content shape (a wp_navigation
1171         * post) but is intentionally not handled: none of the deferred blocks can be
1172         * inserted into a navigation menu through the editor, and resolving the ref would
1173         * add a get_post()/parse_blocks() on essentially every front-end page (menus are
1174         * near-ubiquitous) for a case that cannot occur without hand-authored markup.
1175         */
1176        if ( 'core/block' === $block_name && ! empty( $parsed_block['attrs']['ref'] ) ) {
1177            $ref = (int) $parsed_block['attrs']['ref'];
1178            if ( ! isset( $seen_refs[ $ref ] ) ) {
1179                $seen_refs[ $ref ] = true;
1180                $reusable_block    = get_post( $ref );
1181                if ( $reusable_block instanceof \WP_Post && 'wp_block' === $reusable_block->post_type ) {
1182                    foreach ( parse_blocks( $reusable_block->post_content ) as $inner_block ) {
1183                        self::register_deferred_blocks_in_subtree( $inner_block, $seen_refs );
1184                    }
1185                }
1186            }
1187        }
1188
1189        if ( ! empty( $parsed_block['innerBlocks'] ) ) {
1190            foreach ( $parsed_block['innerBlocks'] as $inner_block ) {
1191                self::register_deferred_blocks_in_subtree( $inner_block, $seen_refs );
1192            }
1193        }
1194    }
1195
1196    /**
1197     * Include a deferred block's registration PHP and run the `init` callback it
1198     * adds, immediately.
1199     *
1200     * The block files register themselves with `add_action( 'init', … )`. By render
1201     * time `init` has long since fired, so including the file is not enough on its
1202     * own: we capture the callback(s) the include adds to `init` and invoke them now.
1203     * Only blocks in self::$lazy_blocks reach this path, and each adds exactly its
1204     * own registration callback to `init`, so this runs that single registration.
1205     *
1206     * @since 16.0
1207     *
1208     * @param string $feature Block feature name (directory name without the `jetpack/` prefix).
1209     *
1210     * @return void
1211     */
1212    private static function load_and_register_deferred_block( $feature ) {
1213        $path = JETPACK__PLUGIN_DIR . "extensions/blocks/{$feature}/{$feature}.php";
1214        if ( ! file_exists( $path ) ) {
1215            self::warn_about_deferred_block_registration_failure( $feature, 'missing block registration file' );
1216            return;
1217        }
1218
1219        global $wp_filter;
1220
1221        $before = isset( $wp_filter['init'] ) ? $wp_filter['init']->callbacks : array();
1222
1223        include_once $path;
1224
1225        if ( ! isset( $wp_filter['init'] ) ) {
1226            self::warn_about_deferred_block_registration_failure( $feature, 'block file did not add an init callback' );
1227            return;
1228        }
1229
1230        $registered_callback = false;
1231
1232        // Run (and then detach) any callback the include just added to `init`.
1233        foreach ( $wp_filter['init']->callbacks as $priority => $callbacks ) {
1234            foreach ( $callbacks as $id => $callback ) {
1235                if ( isset( $before[ $priority ][ $id ] ) ) {
1236                    continue;
1237                }
1238                $registered_callback = true;
1239                if ( is_callable( $callback['function'] ) ) {
1240                    call_user_func( $callback['function'] );
1241                }
1242                remove_action( 'init', $callback['function'], $priority );
1243            }
1244        }
1245
1246        if ( ! $registered_callback ) {
1247            self::warn_about_deferred_block_registration_failure( $feature, 'block file did not add a new init callback' );
1248        }
1249    }
1250
1251    /**
1252     * Surface lazy-registration mistakes during debugging without adding front-end noise.
1253     *
1254     * @since 16.0
1255     *
1256     * @param string $feature Block feature name (directory name without the `jetpack/` prefix).
1257     * @param string $reason  Short reason for the failure.
1258     *
1259     * @return void
1260     */
1261    private static function warn_about_deferred_block_registration_failure( $feature, $reason ) {
1262        if ( ! ( defined( 'WP_DEBUG' ) && WP_DEBUG ) || ! function_exists( '_doing_it_wrong' ) ) {
1263            return;
1264        }
1265
1266        _doing_it_wrong(
1267            __METHOD__,
1268            sprintf(
1269                /* translators: 1: Jetpack block feature name. 2: Failure reason. */
1270                esc_html__( 'Lazy Jetpack block registration failed for "%1$s": %2$s.', 'jetpack' ),
1271                esc_html( $feature ),
1272                esc_html( $reason )
1273            ),
1274            '16.0'
1275        );
1276    }
1277
1278    /**
1279     * Determine whether the current request is a block-editor context that needs
1280     * every Jetpack block loaded eagerly on `init`.
1281     *
1282     * Returns true for admin, REST, cron, WP-CLI and XML-RPC requests so the editor,
1283     * the `/wp/v2/block-types` endpoint and server-side rendering keep seeing the full
1284     * set of blocks. Returns false only for plain front-end web requests, where pure
1285     * display blocks are registered just-in-time as they render.
1286     *
1287     * This runs at module-load time (around after_setup_theme), before core defines
1288     * REST_REQUEST during parse_request, so self-hosted and Atomic REST requests are
1289     * detected from the request URL instead of the constant. That URL check cannot
1290     * work on WordPress.com Simple: its public API filters `rest_url_prefix` to an
1291     * empty string, so rest_get_url_prefix() returns '' and the REST roots computed
1292     * below collapse to '//', which no request path can match. Simple's requests are
1293     * detected via REST_API_REQUEST instead, which its API entry points define before
1294     * wp-load.php runs.
1295     *
1296     * @since 16.0
1297     *
1298     * @return bool True for block-editor (non-front-end) contexts, false for plain front-end requests.
1299     */
1300    private static function is_block_editor_context() {
1301        if ( is_admin() ) {
1302            return true;
1303        }
1304
1305        /*
1306         * Treat any non-front-end execution context as block-editor. These are not the
1307         * front-end hot path this gate optimizes, and some still render block content
1308         * (e.g. cron-generated subscription e-mails) that depends on full registration.
1309         *
1310         * Core defines REST_REQUEST during parse_request, after this runs, so it is
1311         * normally still unset here; it is checked anyway so the result stays correct
1312         * if this is ever called later in the request. REST_API_REQUEST is what catches
1313         * WordPress.com Simple, where the URL check below cannot work at all (see the
1314         * method docblock).
1315         */
1316        if (
1317            Constants::is_true( 'DOING_CRON' )
1318            || Constants::is_true( 'WP_CLI' )
1319            || Constants::is_true( 'XMLRPC_REQUEST' )
1320            || Constants::is_true( 'REST_REQUEST' )
1321            || Constants::is_true( 'REST_API_REQUEST' )
1322        ) {
1323            return true;
1324        }
1325
1326        /*
1327         * No request URI means a non-web execution context (WP-CLI without it, test
1328         * suites, etc.). A genuine front-end page request always carries one, so it
1329         * costs nothing on the hot path to treat the empty case as "load eagerly".
1330         */
1331        $request_uri = isset( $_SERVER['REQUEST_URI'] ) ? sanitize_text_field( wp_unslash( $_SERVER['REQUEST_URI'] ) ) : '';
1332        if ( '' === $request_uri ) {
1333            return true;
1334        }
1335
1336        /*
1337         * Anchor the REST root (home path + prefix) at the start of the request path,
1338         * so a front-end URL that merely carries the prefix in a query value or a
1339         * deeper path segment is not misread as a REST request. home_url() is used
1340         * rather than rest_url() so detection does not depend on permalink structure.
1341         * Both the rewritten `/wp-json/` form and the index-permalink
1342         * `/index.php/wp-json/` form (used when the site lacks pretty permalinks) are
1343         * matched.
1344         */
1345        $path = (string) wp_parse_url( $request_uri, PHP_URL_PATH );
1346        if ( '' !== $path ) {
1347            $home_path   = trailingslashit( (string) wp_parse_url( home_url(), PHP_URL_PATH ) );
1348            $rest_prefix = trailingslashit( rest_get_url_prefix() );
1349            $rest_roots  = array(
1350                $home_path . $rest_prefix,
1351                $home_path . 'index.php/' . $rest_prefix,
1352            );
1353            foreach ( $rest_roots as $rest_root ) {
1354                if ( str_starts_with( trailingslashit( $path ), $rest_root ) ) {
1355                    return true;
1356                }
1357            }
1358        }
1359
1360        // Plain-permalink REST uses a `rest_route` query var; match the exact key.
1361        $query = (string) wp_parse_url( $request_uri, PHP_URL_QUERY );
1362        if ( '' !== $query ) {
1363            parse_str( $query, $query_vars );
1364            if ( ! empty( $query_vars['rest_route'] ) ) {
1365                return true;
1366            }
1367        }
1368
1369        return false;
1370    }
1371
1372    /**
1373     * Editor-oriented extensions that nonetheless have front-end side effects and must
1374     * therefore keep loading on every request, even outside the block editor.
1375     *
1376     * Keyed by directory ('plugins' / 'extended-blocks') for an exact, intentional match.
1377     *
1378     * @since 16.0
1379     *
1380     * @var array
1381     */
1382    private static $frontend_editor_extensions = array(
1383        'plugins'         => array(
1384            // Mounts the Reader Chat widget on the front end (wp_enqueue_scripts) and
1385            // wires the AI sidebar/provider registration AI Assistant depends on.
1386            'ai-assistant-plugin',
1387            // Signals Big Sky via the jetpack_image_studio_enabled filter on `init`,
1388            // which can run on the front end.
1389            'image-studio',
1390        ),
1391        'extended-blocks' => array(
1392            // Registers the videopress/video block on `init`, required to render it on the front end.
1393            'videopress-video',
1394            // Registers the `premium-content/container` plan availability that the Premium Content
1395            // block's front-end render reads via required_plan_checks(); skipping it breaks the paywall.
1396            'premium-content-container',
1397        ),
1398    );
1399
1400    /**
1401     * Loads PHP components of block editor extensions.
1402     *
1403     * @since 8.9.0
1404     */
1405    public static function load_block_editor_extensions() {
1406        if ( self::should_load() ) {
1407            // Block editor extensions to load.
1408            $extensions_to_load = array(
1409                'extended-blocks',
1410                'plugins',
1411            );
1412
1413            $is_editor_context = self::is_block_editor_context();
1414
1415            // Collect the extension paths.
1416            foreach ( $extensions_to_load as $extension_to_load ) {
1417                $extensions_folder = glob( JETPACK__PLUGIN_DIR . 'extensions/' . $extension_to_load . '/*' );
1418
1419                $frontend_allow_list = self::$frontend_editor_extensions[ $extension_to_load ] ?? array();
1420
1421                // Require each of the extension files, in case it exists.
1422                foreach ( $extensions_folder as $extension_folder ) {
1423                    $name = basename( $extension_folder );
1424
1425                    /*
1426                     * On plain front-end requests, only load extensions that have known
1427                     * front-end side effects. Editor-only extensions are skipped here and
1428                     * loaded on admin/REST (block-editor) requests instead, reducing the
1429                     * per-front-end-request PHP/opcache footprint.
1430                     */
1431                    if ( ! $is_editor_context && ! in_array( $name, $frontend_allow_list, true ) ) {
1432                        continue;
1433                    }
1434
1435                    $extension_file_path = JETPACK__PLUGIN_DIR . 'extensions/' . $extension_to_load . '/' . $name . '/' . $name . '.php';
1436
1437                    if ( file_exists( $extension_file_path ) ) {
1438                        include_once $extension_file_path;
1439                    }
1440                }
1441            }
1442        }
1443    }
1444
1445    /**
1446     * Determine whether a site should use the default set of blocks, or a custom set.
1447     * Possible variations are currently beta, experimental, and production.
1448     *
1449     * @since 8.1.0
1450     *
1451     * @return string $block_varation production|beta|experimental
1452     */
1453    public static function blocks_variation() {
1454        // Default to production blocks.
1455        $block_varation = 'production';
1456
1457        /*
1458         * Prefer to use this JETPACK_BLOCKS_VARIATION constant
1459         * or the jetpack_blocks_variation filter
1460         * to set the block variation in your code.
1461         */
1462        $default = Constants::get_constant( 'JETPACK_BLOCKS_VARIATION' );
1463        if ( ! empty( $default ) && in_array( $default, array( 'beta', 'experimental', 'production' ), true ) ) {
1464            $block_varation = $default;
1465        }
1466
1467        /**
1468        * Alternative to `JETPACK_BETA_BLOCKS`, set to `true` to load Beta Blocks.
1469        *
1470        * @since 6.9.0
1471        * @deprecated 11.8.0 Use jetpack_blocks_variation filter instead.
1472        *
1473        * @param boolean
1474        */
1475        $is_beta = apply_filters_deprecated(
1476            'jetpack_load_beta_blocks',
1477            array( false ),
1478            'jetpack-11.8.0',
1479            'jetpack_blocks_variation'
1480        );
1481
1482        /*
1483         * Switch to beta blocks if you use the JETPACK_BETA_BLOCKS constant
1484         * or the deprecated jetpack_load_beta_blocks filter.
1485         * This only applies when not using the newer JETPACK_BLOCKS_VARIATION constant.
1486         */
1487        if (
1488            empty( $default )
1489            && (
1490                $is_beta
1491                || Constants::is_true( 'JETPACK_BETA_BLOCKS' )
1492            )
1493        ) {
1494            $block_varation = 'beta';
1495        }
1496
1497        /**
1498        * Alternative to `JETPACK_EXPERIMENTAL_BLOCKS`, set to `true` to load Experimental Blocks.
1499        *
1500        * @since 6.9.0
1501        * @deprecated 11.8.0 Use jetpack_blocks_variation filter instead.
1502        *
1503        * @param boolean
1504        */
1505        $is_experimental = apply_filters_deprecated(
1506            'jetpack_load_experimental_blocks',
1507            array( false ),
1508            'jetpack-11.8.0',
1509            'jetpack_blocks_variation'
1510        );
1511
1512        /*
1513         * Switch to experimental blocks if you use the JETPACK_EXPERIMENTAL_BLOCKS constant
1514         * or the deprecated jetpack_load_experimental_blocks filter.
1515         * This only applies when not using the newer JETPACK_BLOCKS_VARIATION constant.
1516         */
1517        if (
1518            empty( $default )
1519            && (
1520                $is_experimental
1521                || Constants::is_true( 'JETPACK_EXPERIMENTAL_BLOCKS' )
1522            )
1523        ) {
1524            $block_varation = 'experimental';
1525        }
1526
1527        /**
1528         * Allow customizing the variation of blocks in use on a site.
1529         * Overwrites any previously set values, whether by constant or filter.
1530         *
1531         * @since 8.1.0
1532         *
1533         * @param string $block_variation Can be beta, experimental, and production. Defaults to production.
1534         */
1535        return apply_filters( 'jetpack_blocks_variation', $block_varation );
1536    }
1537
1538    /**
1539     * Get a list of extensions available for the variation you chose.
1540     *
1541     * @since 8.1.0
1542     *
1543     * @param object $preset_extensions_manifest List of extensions available in Jetpack.
1544     * @param string $blocks_variation           Subset of blocks. production|beta|experimental.
1545     *
1546     * @return array $preset_extensions Array of extensions for that variation
1547     */
1548    public static function get_extensions_preset_for_variation( $preset_extensions_manifest, $blocks_variation ) {
1549        $preset_extensions = isset( $preset_extensions_manifest->{ $blocks_variation } )
1550                ? (array) $preset_extensions_manifest->{ $blocks_variation }
1551                : array();
1552
1553        /*
1554         * Experimental and Beta blocks need the production blocks as well.
1555         */
1556        if (
1557            'experimental' === $blocks_variation
1558            || 'beta' === $blocks_variation
1559        ) {
1560            $production_extensions = isset( $preset_extensions_manifest->production )
1561                ? (array) $preset_extensions_manifest->production
1562                : array();
1563
1564            $preset_extensions = array_unique( array_merge( $preset_extensions, $production_extensions ) );
1565        }
1566
1567        /*
1568         * Beta blocks need the experimental blocks as well.
1569         *
1570         * If you've chosen to see Beta blocks,
1571         * we want to make all blocks available to you:
1572         * - Production
1573         * - Experimental
1574         * - Beta
1575         */
1576        if ( 'beta' === $blocks_variation ) {
1577            $production_extensions = isset( $preset_extensions_manifest->experimental )
1578                ? (array) $preset_extensions_manifest->experimental
1579                : array();
1580
1581            $preset_extensions = array_unique( array_merge( $preset_extensions, $production_extensions ) );
1582        }
1583
1584        return $preset_extensions;
1585    }
1586
1587    /**
1588     * Validate a URL used in a SSR block.
1589     *
1590     * @since 8.3.0
1591     *
1592     * @param string $url      URL saved as an attribute in block.
1593     * @param array  $allowed  Array of allowed hosts for that block, or regexes to check against.
1594     * @param bool   $is_regex Array of regexes matching the URL that could be used in block.
1595     *
1596     * @return bool|string
1597     */
1598    public static function validate_block_embed_url( $url, $allowed = array(), $is_regex = false ) {
1599        if (
1600            empty( $url )
1601            || ! is_array( $allowed )
1602            || empty( $allowed )
1603        ) {
1604            return false;
1605        }
1606
1607        $url_components = wp_parse_url( $url );
1608
1609        // Bail early if we cannot find a host.
1610        if ( empty( $url_components['host'] ) ) {
1611            return false;
1612        }
1613
1614        // Only http and https URLs are valid.
1615        if (
1616            isset( $url_components['scheme'] )
1617            && ! in_array( strtolower( $url_components['scheme'] ), array( 'http', 'https' ), true )
1618        ) {
1619            return false;
1620        }
1621
1622        // Normalize URL.
1623        $url = sprintf(
1624            '%s://%s%s%s',
1625            $url_components['scheme'] ?? 'https',
1626            $url_components['host'],
1627            $url_components['path'] ?? '/',
1628            isset( $url_components['query'] ) ? '?' . $url_components['query'] : ''
1629        );
1630
1631        if ( ! empty( $url_components['fragment'] ) ) {
1632            $url = $url . '#' . rawurlencode( $url_components['fragment'] );
1633        }
1634
1635        /*
1636         * If we're using an allowed list of hosts,
1637         * check if the URL belongs to one of the domains allowed for that block.
1638         */
1639        if (
1640            false === $is_regex
1641            && in_array( $url_components['host'], $allowed, true )
1642        ) {
1643            return $url;
1644        }
1645
1646        /*
1647         * If we are using an array of regexes to check against,
1648         * loop through that.
1649         */
1650        if ( true === $is_regex ) {
1651            foreach ( $allowed as $regex ) {
1652                if ( 1 === preg_match( $regex, $url ) ) {
1653                    return $url;
1654                }
1655            }
1656        }
1657
1658        return false;
1659    }
1660
1661    /**
1662     * Determines whether a preview of the block with an upgrade nudge should
1663     * be displayed for admins on the site frontend.
1664     *
1665     * @since 8.4.0
1666     *
1667     * @param array $availability_for_block The availability for the block.
1668     *
1669     * @return bool
1670     */
1671    public static function should_show_frontend_preview( $availability_for_block ) {
1672        return (
1673            isset( $availability_for_block['details']['required_plan'] )
1674            && current_user_can( 'manage_options' )
1675            && ! is_feed()
1676        );
1677    }
1678
1679    /**
1680     * Output an UpgradeNudge Component on the frontend of a site.
1681     *
1682     * @since 8.4.0
1683     *
1684     * @param string $plan The plan that users need to purchase to make the block work.
1685     *
1686     * @return string
1687     */
1688    public static function upgrade_nudge( $plan ) {
1689        require_once JETPACK__PLUGIN_DIR . '_inc/lib/components.php';
1690        return Jetpack_Components::render_upgrade_nudge(
1691            array(
1692                'plan' => $plan,
1693            )
1694        );
1695    }
1696
1697    /**
1698     * Output a notice within a block.
1699     *
1700     * @since 8.6.0
1701     *
1702     * @param string $message Notice we want to output.
1703     * @param string $status  Status of the notice. Can be one of success, info, warning, error. info by default.
1704     * @param string $classes List of CSS classes.
1705     *
1706     * @return string
1707     */
1708    public static function notice( $message, $status = 'info', $classes = '' ) {
1709        if (
1710            empty( $message )
1711            || ! in_array( $status, array( 'success', 'info', 'warning', 'error' ), true )
1712        ) {
1713            return '';
1714        }
1715
1716        $color = '';
1717        switch ( $status ) {
1718            case 'success':
1719                $color = '#00a32a';
1720                break;
1721            case 'warning':
1722                $color = '#dba617';
1723                break;
1724            case 'error':
1725                $color = '#d63638';
1726                break;
1727            case 'info':
1728            default:
1729                $color = '#72aee6';
1730                break;
1731        }
1732
1733        return sprintf(
1734            '<div class="jetpack-block__notice %1$s %3$s" style="border-left:5px solid %4$s;padding:1em;background-color:#f8f9f9;">%2$s</div>',
1735            esc_attr( $status ),
1736            wp_kses(
1737                $message,
1738                array(
1739                    'br' => array(),
1740                    'p'  => array(),
1741                    'a'  => array(
1742                        'href'   => array(),
1743                        'target' => array(),
1744                        'rel'    => array(),
1745                    ),
1746                )
1747            ),
1748            esc_attr( $classes ),
1749            sanitize_hex_color( $color )
1750        );
1751    }
1752
1753    /**
1754     * Retrieve site-specific features for Simple sites.
1755     *
1756     * We're caching the data for the lifetime of the request, because it can be slow to calculate,
1757     * and it can be called multiple times per single request.
1758     *
1759     * We intentionally don't use object caching or any other type of persistent caching,
1760     * in order to avoid complex cache invalidation on subscription addition or removal.
1761     *
1762     * @since 10.7
1763     *
1764     * @return array
1765     */
1766    private static function get_site_specific_features() {
1767        $current_blog_id = get_current_blog_id();
1768
1769        if ( isset( self::$site_specific_features[ $current_blog_id ] ) ) {
1770            return self::$site_specific_features[ $current_blog_id ];
1771        }
1772
1773        if ( ! class_exists( 'Store_Product_List' ) ) {
1774            require WP_CONTENT_DIR . '/admin-plugins/wpcom-billing/store-product-list.php';
1775        }
1776
1777        $site_specific_features                           = Store_Product_List::get_site_specific_features_data( $current_blog_id );
1778        self::$site_specific_features[ $current_blog_id ] = $site_specific_features;
1779
1780        return $site_specific_features;
1781    }
1782
1783    /**
1784     * Set the availability of the block as the editor
1785     * is loaded.
1786     *
1787     * @param string $slug Slug of the block.
1788     */
1789    public static function set_availability_for_plan( $slug ) {
1790        $slug = self::remove_extension_prefix( $slug );
1791
1792        if ( Jetpack_Plan::supports( $slug ) ) {
1793            self::set_extension_available( $slug );
1794            return;
1795        }
1796
1797        // Check what's the minimum plan where the feature is available.
1798        $plan           = '';
1799        $features_data  = array();
1800        $is_simple_site = defined( 'IS_WPCOM' ) && IS_WPCOM;
1801        $is_atomic_site = ( new Host() )->is_woa_site();
1802
1803        if ( $is_simple_site || $is_atomic_site ) {
1804            // Simple sites.
1805            if ( $is_simple_site ) {
1806                $features_data = self::get_site_specific_features();
1807            } else {
1808                // Atomic sites.
1809                $option = get_option( 'jetpack_active_plan' );
1810                if ( isset( $option['features'] ) ) {
1811                    $features_data = $option['features'];
1812                }
1813            }
1814
1815            if ( ! empty( $features_data['available'][ $slug ] ) ) {
1816                $plan = $features_data['available'][ $slug ][0];
1817            } elseif ( isset( self::$wpcom_minimum_plan_fallbacks[ $slug ] ) ) {
1818                // Fallback for features with conditional availability (e.g., sticker-based gating)
1819                // that don't appear in features_data['available'].
1820                $plan = self::$wpcom_minimum_plan_fallbacks[ $slug ];
1821            }
1822        } else {
1823            // Jetpack sites.
1824            $plan = Jetpack_Plan::get_minimum_plan_for_feature( $slug );
1825        }
1826
1827        self::set_extension_unavailable(
1828            $slug,
1829            'missing_plan',
1830            array(
1831                'required_feature' => $slug,
1832                'required_plan'    => $plan,
1833            )
1834        );
1835    }
1836
1837    /**
1838     * Wraps the suplied render_callback in a function to check
1839     * the availability of the block before rendering it.
1840     *
1841     * @param string   $slug The block slug, used to check for availability.
1842     * @param callable $render_callback The render_callback that will be called if the block is available.
1843     */
1844    public static function get_render_callback_with_availability_check( $slug, $render_callback ) {
1845        return function ( $prepared_attributes, $block_content, $block ) use ( $render_callback, $slug ) {
1846            $availability = self::get_cached_availability();
1847            $bare_slug    = self::remove_extension_prefix( $slug );
1848            if ( isset( $availability[ $bare_slug ] ) && $availability[ $bare_slug ]['available'] ) {
1849                return call_user_func( $render_callback, $prepared_attributes, $block_content, $block );
1850            }
1851
1852            // A preview of the block is rendered for admins on the frontend with an upgrade nudge.
1853            if ( isset( $availability[ $bare_slug ] ) ) {
1854                if ( self::should_show_frontend_preview( $availability[ $bare_slug ] ) ) {
1855                    $block_preview = call_user_func( $render_callback, $prepared_attributes, $block_content, $block );
1856
1857                    // If the upgrade nudge isn't already being displayed by a parent block, display the nudge.
1858                    if ( isset( $block->attributes['shouldDisplayFrontendBanner'] ) && $block->attributes['shouldDisplayFrontendBanner'] ) {
1859                        $upgrade_nudge = self::upgrade_nudge( $availability[ $bare_slug ]['details']['required_plan'] );
1860                        return $upgrade_nudge . $block_preview;
1861                    }
1862
1863                    return $block_preview;
1864                }
1865            }
1866
1867            return null;
1868        };
1869    }
1870
1871    /**
1872     * Display a message to site editors and roles above when a block is no longer supported.
1873     * This is only displayed on the frontend.
1874     *
1875     * @since 12.3
1876     *
1877     * @param string $block_content The block content.
1878     * @param array  $block         The full block, including name and attributes.
1879     *
1880     * @return string
1881     */
1882    public static function display_deprecated_block_message( $block_content, $block ) {
1883        if ( isset( $block['blockName'] ) && in_array( $block['blockName'], self::$deprecated_blocks, true ) ) {
1884            if ( current_user_can( 'edit_posts' ) ) {
1885                $block_content = self::notice(
1886                    __( 'This block is no longer supported. Its contents will no longer be displayed to your visitors and as such this block should be removed.', 'jetpack' ),
1887                    'warning',
1888                    'jetpack-block-deprecated'
1889                );
1890            } else {
1891                $block_content = '';
1892            }
1893        }
1894
1895        return $block_content;
1896    }
1897
1898    /**
1899     * Register block metadata collection for Jetpack blocks.
1900     * This allows for more efficient block metadata loading by avoiding
1901     * individual block.json file reads at runtime.
1902     *
1903     * Uses wp_register_block_metadata_collection() if the manifest file
1904     * exists. The manifest file is auto-generated during the build process.
1905     *
1906     * Runs on plugins_loaded to ensure registration happens before individual
1907     * blocks register themselves on init.
1908     *
1909     * @static
1910     * @since 14.1
1911     * @return void
1912     */
1913    public static function register_block_metadata_collection() {
1914        $meta_file_path = JETPACK__PLUGIN_DIR . '_inc/blocks/blocks-manifest.php';
1915        if ( file_exists( $meta_file_path ) ) {
1916            wp_register_block_metadata_collection(
1917                JETPACK__PLUGIN_DIR . '_inc/blocks/',
1918                $meta_file_path
1919            );
1920        }
1921    }
1922
1923    /**
1924     * Set the JS loading strategy for a block.
1925     *
1926     * @param string     $block_name The block name.
1927     * @param array|bool $strategy   The JS loading strategy.
1928     *
1929     * @since 15.0
1930     */
1931    public static function set_block_js_loading_strategy( $block_name, $strategy ) {
1932        self::$block_js_loading_strategies[ $block_name ] = $strategy;
1933    }
1934
1935    /**
1936     * Get the JS loading strategy for a block.
1937     *
1938     * @param string $block_name The block name.
1939     *
1940     * @return array|bool The JS loading strategy for the block.
1941     *
1942     * @since 15.0
1943     */
1944    public static function get_block_js_loading_strategy( $block_name ) {
1945        $strategy = array(
1946            'strategy'  => 'defer',
1947            'in_footer' => true,
1948        );
1949
1950        if ( isset( self::$block_js_loading_strategies[ $block_name ] ) ) {
1951            $strategy = self::$block_js_loading_strategies[ $block_name ];
1952        }
1953
1954        return $strategy;
1955    }
1956}
1957
1958if ( ( new Host() )->is_woa_site() ) {
1959    /**
1960    * Enable upgrade nudge for Atomic sites.
1961     * This feature is false as default,
1962     * so let's enable it through this filter.
1963     *
1964     * More doc: https://github.com/Automattic/jetpack/blob/trunk/projects/plugins/jetpack/extensions/README.md#upgrades-for-blocks
1965     */
1966    add_filter( 'jetpack_block_editor_enable_upgrade_nudge', '__return_true' );
1967}