jetpack / class.jetpack-gutenberg.php

class.jetpack-gutenberg.php in Jetpack – WP Security, Backup, Speed, & Growth 16.2, at class.jetpack-gutenberg.php

1,927 lines 66.4 KB

Raw Download Zip

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