PluginProbe ʕ •ᴥ•ʔ
Jetpack – WP Security, Backup, Speed, & Growth / 14.5.1
Jetpack – WP Security, Backup, Speed, & Growth v14.5.1
12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 13.9.2 14.0.1 14.1.1 14.2.2 14.3.1 14.4.2 14.5.1 14.6.1 14.7.1 14.8.1 14.9.2 15.0.3 15.1.2 15.2.1 15.3.2 15.4.1 15.5.1 15.6.1 15.7.2 15.8.1 15.9.2 16.0.2 16.1.3 16.2-a.5 16.2-a.3 16.1.2 16.2-a.1 16.1.1 16.1 16.1-beta 16.1-beta.2 16.1-beta.3 16.1-a.5 16.1-a.3 16.0.1 16.1-a.1 16.0 16.0-beta 16.0-a.7 16.0-a.5 15.9.1 16.0-a.3 16.0-a.1 15.9 15.9-beta 15.9-a.7 15.9-a.5 15.9-a.3 15.9-a.1 15.8 15.8-beta 15.8-a.7 15.8-a.5 5.2.5 5.3.4 5.4.4 5.5.5 5.6.5 5.7.5 5.8.4 5.9.4 6.0.4 6.1 6.1.1 6.1.2 6.1.3 6.1.4 6.1.5 6.2 6.2.1 6.2.2 6.2.3 6.2.4 6.2.5 6.3 6.3.1 6.3.2 6.3.3 6.3.4 6.3.5 6.3.6 6.3.7 6.4 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.5 6.5.1 6.5.2 6.5.3 6.5.4 6.6 6.6.1 6.6.2 6.6.3 6.6.4 6.6.5 6.7 6.7.1 6.7.2 6.7.3 6.7.4 6.8 6.8.1 6.8.2 6.8.3 6.8.4 6.8.5 6.9 6.9.1 6.9.2 6.9.3 6.9.4 7.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.1 7.1.1 7.1.2 7.1.3 7.1.4 7.1.5 7.2 7.2.1 7.2.1.1 7.2.2 7.2.3 7.2.4 7.2.5 7.3 7.3.0.1 7.3.1 7.3.1.1 7.3.2 7.3.3 7.3.4 7.3.5 7.4 7.4.1 7.4.2 7.4.3 7.4.4 7.4.5 7.5 7.5.0.1 7.5.1 7.5.2 7.5.3 7.5.4 7.5.5 7.5.6 7.5.7 7.6 7.6.1 7.6.2 7.6.3 7.6.4 7.7 7.7.1 7.7.2 7.7.3 7.7.4 7.7.5 7.7.6 7.8 7.8.1 7.8.2 7.8.3 7.8.4 7.9 7.9.1 7.9.2 7.9.3 7.9.4 8.0 8.0.1 8.0.2 8.0.3 8.1 8.1.1 8.1.2 8.1.3 8.1.4 8.2 8.2.0.1 8.2.1 8.2.2 8.2.3 8.2.4 8.2.5 8.2.6 8.3 8.3.1 8.3.2 8.3.3 8.4 8.4.1 8.4.2 8.4.3 8.4.4 8.4.5 8.5 8.5.1 8.5.2 8.5.3 8.6 8.6.1 8.6.2 8.6.3 8.6.4 8.7 8.7.0.1 8.7.1 8.7.2 8.7.3 8.7.4 8.8 8.8.1 8.8.2 8.8.3 8.8.4 8.8.5 8.9 8.9.1 8.9.2 8.9.3 8.9.4 9.0 9.0.1 9.0.2 9.0.3 9.0.4 9.0.5 9.1 9.1.1 9.1.2 9.1.3 9.2 9.2.1 9.2.2 9.2.3 9.2.4 9.3 9.3.1 9.3.2 9.3.3 9.3.4 9.3.5 9.4 9.4.1 9.4.2 9.4.3 9.4.4 9.5 9.5.1 9.5.2 9.5.3 9.5.4 9.5.5 9.6 9.6.1 9.6.2 9.6.3 9.6.4 9.7 9.7.1 9.7.2 15.7-beta.2 9.7.3 15.7.1 9.8 15.8-a.1 9.8.1 15.8-a.3 9.8.2 2.0.9 9.8.3 2.1.7 9.9 2.2.10 9.9.1 2.3.10 9.9.2 2.4.7 9.9.3 2.5.5 2.6.6 2.7.5 2.8.5 2.9.6 3.0.6 3.1.5 3.2.5 3.3.6 3.4.6 3.5.6 3.6.4 3.7.5 3.8.5 3.9.10 4.0.7 4.1.4 4.2.5 4.3.5 4.4.5 4.5.3 4.6.3 4.7.4 4.8.5 4.9.3 5.0.3 5.1.4 trunk 10.0 10.0.1 10.0.2 10.1 10.1.1 10.1.2 10.2 10.2.1 10.2.2 10.2.3 10.3 10.3.1 10.3.2 10.4 10.4.1 10.4.2 10.5 10.5.1 10.5.2 10.5.3 10.6 10.6.1 10.6.2 10.7 10.7.1 10.7.2 10.8 10.8.1 10.8.2 10.9 10.9.1 10.9.2 10.9.3 11.0 11.0.1 11.0.2 11.1 11.1.1 11.1.2 11.1.3 11.1.4 11.2 11.2.1 11.2.2 11.3 11.3.1 11.3.2 11.3.3 11.3.4 11.4 11.4.1 11.4.2 11.5 11.5.1 11.5.2 11.5.3 11.6 11.6.1 11.6.2 11.7 11.7.1 11.7.2 11.7.3 11.8 11.8.3 11.8.4 11.8.5 11.8.6 11.9 11.9.1 11.9.2 11.9.3 12.0 12.0.1 12.0.2 12.1 12.1.1 12.1.2 12.2 12.2.1 12.2.2 12.3 12.3.1 12.4 12.4.1 12.5 12.5.1 12.6 12.6.1 12.6.2 12.6.3 12.7 12.7.1 12.7.2 12.8 12.8.1 12.8.2 12.9 12.9.1 12.9.2 12.9.3 12.9.4 13.0 13.0.1 13.1 13.1.1 13.1.2 13.1.3 13.1.4 13.2 13.2.1 13.2.2 13.2.3 13.3 13.3.1 13.3.2 13.4 13.4.1 13.4.2 13.4.3 13.4.4 13.5 13.5.1 13.6 13.6.1 13.7 13.7.1 13.8 13.8.1 13.8.2 13.9 13.9.1 14.0 14.1 14.2 14.2.1 14.3 14.4 14.4.1 14.5 14.6 14.7 14.8 14.9 14.9.1 15.0 15.0.1 15.0.2 15.1 15.1.1 15.2 15.3 15.3.1 15.4 15.5 15.6 15.7 15.7-a.1 15.7-a.3 15.7-a.5 15.7-a.7 15.7-beta
jetpack / class.jetpack-gutenberg.php
jetpack Last commit date
3rd-party 1 year ago _inc 1 day ago css 1 year ago extensions 1 year ago images 1 year ago jetpack_vendor 1 day ago json-endpoints 1 year ago modules 1 year ago sal 1 year ago src 1 year ago vendor 1 year ago views 2 years ago CHANGELOG.md 1 year ago LICENSE.txt 5 years ago SECURITY.md 2 years ago class-jetpack-connection-status.php 2 years ago class-jetpack-gallery-settings.php 3 years ago class-jetpack-newsletter-dashboard-widget.php 1 year ago class-jetpack-pre-connection-jitms.php 2 years ago class-jetpack-stats-dashboard-widget.php 1 year ago class-jetpack-xmlrpc-methods.php 1 year ago class.frame-nonce-preview.php 1 year ago class.jetpack-admin.php 1 year ago class.jetpack-affiliate.php 2 years ago class.jetpack-autoupdate.php 2 years ago class.jetpack-bbpress-json-api.compat.php 2 years ago class.jetpack-cli.php 1 year ago class.jetpack-client-server.php 2 years ago class.jetpack-gutenberg.php 1 year ago class.jetpack-heartbeat.php 2 years ago class.jetpack-modules-list-table.php 2 years ago class.jetpack-network-sites-list-table.php 2 years ago class.jetpack-network.php 1 year ago class.jetpack-plan.php 3 years ago class.jetpack-post-images.php 1 year ago class.jetpack-twitter-cards.php 2 years ago class.jetpack-user-agent.php 2 years ago class.jetpack.php 1 year ago class.json-api-endpoints.php 1 year ago class.json-api.php 1 year ago class.photon.php 3 years ago composer.json 1 year ago enhanced-open-graph.php 3 years ago functions.compat.php 2 years ago functions.cookies.php 2 years ago functions.global.php 1 year ago functions.is-mobile.php 2 years ago functions.opengraph.php 1 year ago functions.photon.php 2 years ago global.d.ts 2 years ago jetpack.php 1 day ago json-api-config.php 3 years ago json-endpoints.php 2 years ago load-jetpack.php 1 year ago locales.php 4 years ago readme.txt 1 day ago uninstall.php 1 year ago wpml-config.xml 4 years ago
class.jetpack-gutenberg.php
1361 lines
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\Blocks;
11 use Automattic\Jetpack\Connection\Initial_State as Connection_Initial_State;
12 use Automattic\Jetpack\Connection\Manager as Connection_Manager;
13 use Automattic\Jetpack\Constants;
14 use Automattic\Jetpack\Current_Plan as Jetpack_Plan;
15 use Automattic\Jetpack\Modules;
16 use Automattic\Jetpack\My_Jetpack\Initializer as My_Jetpack_Initializer;
17 use Automattic\Jetpack\Status;
18 use Automattic\Jetpack\Status\Host;
19
20 // phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move the functions and such to some other file.
21
22 /**
23 * General Gutenberg editor specific functionality
24 */
25 class Jetpack_Gutenberg {
26
27 /**
28 * Only these extensions can be registered. Used to control availability of beta blocks.
29 *
30 * @var array|null Extensions allowed list or `null` if not initialized yet.
31 * @see static::get_extensions()
32 */
33 private static $extensions = null;
34
35 /**
36 * Keeps track of the reasons why a given extension is unavailable.
37 *
38 * @var array Extensions availability information
39 */
40 private static $availability = array();
41
42 /**
43 * A cached array of the fully processed availability data. Keeps track of
44 * reasons why an extension is unavailable or missing.
45 *
46 * @var array Extensions availability information.
47 */
48 private static $cached_availability = null;
49
50 /**
51 * Site-specific features available.
52 * Their calculation can be expensive and slow, so we're caching it for the request.
53 *
54 * @var array Site-specific features
55 */
56 private static $site_specific_features = array();
57
58 /**
59 * List of deprecated blocks.
60 *
61 * @var array List of deprecated blocks.
62 */
63 private static $deprecated_blocks = array(
64 'jetpack/revue',
65 );
66
67 /**
68 * Storing the contents of the preset file.
69 *
70 * Already been json_decode.
71 *
72 * @var null|object JSON decoded object after first usage.
73 */
74 private static $preset_cache = null;
75
76 /**
77 * Check to see if a minimum version of Gutenberg is available. Because a Gutenberg version is not available in
78 * php if the Gutenberg plugin is not installed, if we know which minimum WP release has the required version we can
79 * optionally fall back to that.
80 *
81 * @param array $version_requirements An array containing the required Gutenberg version and, if known, the WordPress version that was released with this minimum version.
82 * @param string $slug The slug of the block or plugin that has the gutenberg version requirement.
83 *
84 * @since 8.3.0
85 *
86 * @return boolean True if the version of gutenberg required by the block or plugin is available.
87 */
88 public static function is_gutenberg_version_available( $version_requirements, $slug ) {
89 global $wp_version;
90
91 // Bail if we don't at least have the gutenberg version requirement, the WP version is optional.
92 if ( empty( $version_requirements['gutenberg'] ) ) {
93 return false;
94 }
95
96 // If running a local dev build of gutenberg plugin GUTENBERG_DEVELOPMENT_MODE is set so assume correct version.
97 if ( defined( 'GUTENBERG_DEVELOPMENT_MODE' ) && GUTENBERG_DEVELOPMENT_MODE ) {
98 return true;
99 }
100
101 $version_available = false;
102
103 // If running a production build of the gutenberg plugin then GUTENBERG_VERSION is set, otherwise if WP version
104 // with required version of Gutenberg is known check that.
105 if ( defined( 'GUTENBERG_VERSION' ) ) {
106 $version_available = version_compare( GUTENBERG_VERSION, $version_requirements['gutenberg'], '>=' );
107 } elseif ( ! empty( $version_requirements['wp'] ) ) {
108 $version_available = version_compare( $wp_version, $version_requirements['wp'], '>=' );
109 }
110
111 if ( ! $version_available ) {
112 $slug = self::remove_extension_prefix( $slug );
113 self::set_extension_unavailable(
114 $slug,
115 'incorrect_gutenberg_version',
116 array(
117 'required_feature' => $slug,
118 'required_version' => $version_requirements,
119 'current_version' => array(
120 'wp' => $wp_version,
121 'gutenberg' => defined( 'GUTENBERG_VERSION' ) ? GUTENBERG_VERSION : null,
122 ),
123 )
124 );
125 }
126
127 return $version_available;
128 }
129
130 /**
131 * Prepend the 'jetpack/' prefix to a block name
132 *
133 * @param string $block_name The block name.
134 *
135 * @return string The prefixed block name.
136 */
137 private static function prepend_block_prefix( $block_name ) {
138 return 'jetpack/' . $block_name;
139 }
140
141 /**
142 * Remove the 'jetpack/' or jetpack-' prefix from an extension name
143 *
144 * @param string $extension_name The extension name.
145 *
146 * @return string The unprefixed extension name.
147 */
148 public static function remove_extension_prefix( $extension_name ) {
149 if ( str_starts_with( $extension_name, 'jetpack/' ) || str_starts_with( $extension_name, 'jetpack-' ) ) {
150 return substr( $extension_name, strlen( 'jetpack/' ) );
151 }
152 return $extension_name;
153 }
154
155 /**
156 * Whether two arrays share at least one item
157 *
158 * @param array $a An array.
159 * @param array $b Another array.
160 *
161 * @return boolean True if $a and $b share at least one item
162 */
163 protected static function share_items( $a, $b ) {
164 return array_intersect( $a, $b ) !== array();
165 }
166
167 /**
168 * Set a (non-block) extension as available
169 *
170 * @param string $slug Slug of the extension.
171 */
172 public static function set_extension_available( $slug ) {
173 $slug = self::remove_extension_prefix( $slug );
174 self::$availability[ $slug ] = true;
175 }
176
177 /**
178 * Set the reason why an extension (block or plugin) is unavailable
179 *
180 * @param string $slug Slug of the extension.
181 * @param string $reason A string representation of why the extension is unavailable.
182 * @param array $details A free-form array containing more information on why the extension is unavailable.
183 */
184 public static function set_extension_unavailable( $slug, $reason, $details = array() ) {
185 if (
186 // Extensions that require a plan may be eligible for upgrades.
187 'missing_plan' === $reason
188 && (
189 /**
190 * Filter 'jetpack_block_editor_enable_upgrade_nudge' with `true` to enable or `false`
191 * to disable paid feature upgrade nudges in the block editor.
192 *
193 * When this is changed to default to `true`, you should also update `modules/memberships/class-jetpack-memberships.php`
194 * See https://github.com/Automattic/jetpack/pull/13394#pullrequestreview-293063378
195 *
196 * @since 7.7.0
197 *
198 * @param boolean
199 */
200 ! apply_filters( 'jetpack_block_editor_enable_upgrade_nudge', false )
201 /** This filter is documented in _inc/lib/admin-pages/class.jetpack-react-page.php */
202 || ! apply_filters( 'jetpack_show_promotions', true )
203 )
204 ) {
205 // The block editor may apply an upgrade nudge if `missing_plan` is the reason.
206 // Add a descriptive suffix to disable behavior but provide informative reason.
207 $reason .= '__nudge_disabled';
208 }
209 $slug = self::remove_extension_prefix( $slug );
210 self::$availability[ $slug ] = array(
211 'reason' => $reason,
212 'details' => $details,
213 );
214 }
215
216 /**
217 * Used to initialize the class, no longer in use.
218 *
219 * @return void
220 * @deprecated 12.2 No longer needed.
221 */
222 public static function init() {
223 _deprecated_function( __METHOD__, '12.2' );
224 }
225
226 /**
227 * Resets the class to its original state
228 *
229 * Used in unit tests
230 *
231 * @return void
232 */
233 public static function reset() {
234 self::$extensions = null;
235 self::$availability = array();
236 self::$cached_availability = null;
237 }
238
239 /**
240 * Return the Gutenberg extensions (blocks and plugins) directory
241 *
242 * @return string The Gutenberg extensions directory
243 */
244 public static function get_blocks_directory() {
245 /**
246 * Filter to select Gutenberg blocks directory
247 *
248 * @since 6.9.0
249 *
250 * @param string default: '_inc/blocks/'
251 */
252 return apply_filters( 'jetpack_blocks_directory', '_inc/blocks/' );
253 }
254
255 /**
256 * Checks for a given .json file in the blocks folder.
257 *
258 * @deprecated 14.3
259 *
260 * @param string $preset The name of the .json file to look for.
261 *
262 * @return bool True if the file is found.
263 */
264 public static function preset_exists( $preset ) {
265 _deprecated_function( __METHOD__, '14.3' );
266 return file_exists( JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $preset . '.json' );
267 }
268
269 /**
270 * Decodes JSON loaded from the preset file in the blocks folder
271 *
272 * @since 14.3 Deprecated argument. Only one value is ever used.
273 *
274 * @param null $deprecated No longer used.
275 *
276 * @return mixed Returns an object if the file is present, or false if a valid .json file is not present.
277 */
278 public static function get_preset( $deprecated = null ) {
279 if ( $deprecated ) {
280 _deprecated_argument( __METHOD__, '$$next-version', 'The $preset argument is no longer needed or used.' );
281 }
282
283 if ( self::$preset_cache ) {
284 return self::$preset_cache;
285 }
286
287 self::$preset_cache = json_decode(
288 // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
289 file_get_contents( JETPACK__PLUGIN_DIR . self::get_blocks_directory() . 'index.json' )
290 );
291 return self::$preset_cache;
292 }
293
294 /**
295 * Returns a list of Jetpack Gutenberg extensions (blocks and plugins), based on index.json
296 *
297 * @return array A list of blocks: eg [ 'publicize', 'markdown' ]
298 */
299 public static function get_jetpack_gutenberg_extensions_allowed_list() {
300 $preset_extensions_manifest = ( defined( 'TESTING_IN_JETPACK' ) && TESTING_IN_JETPACK ) ? array() : self::get_preset();
301 $blocks_variation = self::blocks_variation();
302
303 return self::get_extensions_preset_for_variation( $preset_extensions_manifest, $blocks_variation );
304 }
305
306 /**
307 * Returns a diff from a combined list of allowed extensions and extensions determined to be excluded
308 *
309 * @param array $allowed_extensions An array of allowed extensions.
310 *
311 * @return array A list of blocks: eg array( 'publicize', 'markdown' )
312 */
313 public static function get_available_extensions( $allowed_extensions = null ) {
314 $exclusions = get_option( 'jetpack_excluded_extensions', array() );
315 $allowed_extensions = $allowed_extensions === null ? self::get_jetpack_gutenberg_extensions_allowed_list() : $allowed_extensions;
316
317 return array_diff( $allowed_extensions, $exclusions );
318 }
319
320 /**
321 * Return true if the extension has been registered and there's nothing in the availablilty array.
322 *
323 * @param string $extension The name of the extension.
324 *
325 * @return bool whether the extension has been registered and there's nothing in the availablilty array.
326 */
327 public static function is_registered_and_no_entry_in_availability( $extension ) {
328 return self::is_registered( 'jetpack/' . $extension ) && ! isset( self::$availability[ $extension ] );
329 }
330
331 /**
332 * Return true if the extension has a true entry in the availablilty array.
333 *
334 * @param string $extension The name of the extension.
335 *
336 * @return bool whether the extension has a true entry in the availablilty array.
337 */
338 public static function is_available( $extension ) {
339 return isset( self::$availability[ $extension ] ) && true === self::$availability[ $extension ];
340 }
341
342 /**
343 * Get the availability of each block / plugin, or return the cached availability
344 * if it has already been calculated. Avoids re-registering extensions when not
345 * necessary.
346 *
347 * @return array A list of block and plugins and their availability status.
348 */
349 public static function get_cached_availability() {
350 if ( null === self::$cached_availability ) {
351 self::$cached_availability = self::get_availability();
352 }
353 return self::$cached_availability;
354 }
355
356 /**
357 * Get availability of each block / plugin.
358 *
359 * @return array A list of block and plugins and their availablity status
360 */
361 public static function get_availability() {
362 /**
363 * Fires before Gutenberg extensions availability is computed.
364 *
365 * In the function call you supply, use `Blocks::jetpack_register_block()` to set a block as available.
366 * Alternatively, use `Jetpack_Gutenberg::set_extension_available()` (for a non-block plugin), and
367 * `Jetpack_Gutenberg::set_extension_unavailable()` (if the block or plugin should not be registered
368 * but marked as unavailable).
369 *
370 * @since 7.0.0
371 */
372 do_action( 'jetpack_register_gutenberg_extensions' );
373
374 $available_extensions = array();
375
376 foreach ( static::get_extensions() as $extension ) {
377 $is_available = self::is_registered_and_no_entry_in_availability( $extension ) || self::is_available( $extension );
378 $available_extensions[ $extension ] = array(
379 'available' => $is_available,
380 );
381
382 if ( ! $is_available ) {
383 $reason = isset( self::$availability[ $extension ] ) ? self::$availability[ $extension ]['reason'] : 'missing_module';
384 $details = isset( self::$availability[ $extension ] ) ? self::$availability[ $extension ]['details'] : array();
385 $available_extensions[ $extension ]['unavailable_reason'] = $reason;
386 $available_extensions[ $extension ]['details'] = $details;
387 }
388 }
389
390 return $available_extensions;
391 }
392
393 /**
394 * Return the list of extensions that are available.
395 *
396 * @since 11.9
397 *
398 * @return array A list of block and plugins and their availability status.
399 */
400 public static function get_extensions() {
401 if ( ! static::should_load() ) {
402 return array();
403 }
404
405 if ( null === self::$extensions ) {
406 /**
407 * Filter the list of block editor extensions that are available through Jetpack.
408 *
409 * @since 7.0.0
410 *
411 * @param array
412 */
413 self::$extensions = apply_filters( 'jetpack_set_available_extensions', self::get_available_extensions() );
414 }
415
416 return self::$extensions;
417 }
418
419 /**
420 * Check if an extension/block is already registered
421 *
422 * @since 7.2
423 *
424 * @param string $slug Name of extension/block to check.
425 *
426 * @return bool
427 */
428 public static function is_registered( $slug ) {
429 return WP_Block_Type_Registry::get_instance()->is_registered( $slug );
430 }
431
432 /**
433 * Check if Gutenberg editor is available
434 *
435 * @since 6.7.0
436 *
437 * @return bool
438 */
439 public static function is_gutenberg_available() {
440 return true;
441 }
442
443 /**
444 * Check whether conditions indicate Gutenberg Extensions (blocks and plugins) should be loaded
445 *
446 * Loading blocks and plugins is enabled by default and may be disabled via filter:
447 * add_filter( 'jetpack_gutenberg', '__return_false' );
448 *
449 * @since 6.9.0
450 *
451 * @return bool
452 */
453 public static function should_load() {
454 if ( ! Jetpack::is_connection_ready() && ! ( new Status() )->is_offline_mode() ) {
455 return false;
456 }
457
458 $return = true;
459
460 if ( ! ( new Modules() )->is_active( 'blocks' ) ) {
461 $return = false;
462 }
463
464 /**
465 * Filter to enable Gutenberg blocks.
466 *
467 * Defaults to true if (connected or in offline mode) and the Blocks module is active.
468 *
469 * @since 6.5.0
470 * @since 13.9 Filter is able to activate or deactivate Gutenberg blocks.
471 *
472 * @param bool true Whether to load Gutenberg blocks
473 */
474 return (bool) apply_filters( 'jetpack_gutenberg', $return );
475 }
476
477 /**
478 * Queue a script to set `Jetpack_Block_Assets_Base_Url`.
479 *
480 * In certain cases Webpack needs to know a base to load additional assets from.
481 * Normally it can determine that itself, but when JS concatenation is involved that tends to confuse it.
482 * We work around that by explicitly outputting a variable with the correct URL.
483 * We set that as its own "script" so we can reliably only output it once.
484 */
485 private static function register_blocks_assets_base_url() {
486 if ( ! wp_script_is( 'jetpack-blocks-assets-base-url', 'registered' ) ) {
487 // phpcs:ignore WordPress.WP.EnqueuedResourceParameters.MissingVersion -- No actual script, so no version needed.
488 wp_register_script( 'jetpack-blocks-assets-base-url', false, array(), null, array( 'in_footer' => false ) );
489 $json_encode_flags = JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP;
490 if ( get_option( 'blog_charset' ) === 'UTF-8' ) {
491 $json_encode_flags |= JSON_UNESCAPED_UNICODE;
492 }
493 wp_add_inline_script(
494 'jetpack-blocks-assets-base-url',
495 'var Jetpack_Block_Assets_Base_Url=' . wp_json_encode( plugins_url( self::get_blocks_directory(), JETPACK__PLUGIN_FILE ), $json_encode_flags ) . ';',
496 'before'
497 );
498 }
499 }
500
501 /**
502 * Only enqueue block assets when needed.
503 *
504 * @param string $type Slug of the block or absolute path to the block source code directory.
505 * @param array $script_dependencies Script dependencies. Will be merged with automatically
506 * detected script dependencies from the webpack build.
507 *
508 * @return void
509 */
510 public static function load_assets_as_required( $type, $script_dependencies = array() ) {
511 if ( is_admin() ) {
512 // A block's view assets will not be required in wp-admin.
513 return;
514 }
515
516 // Retrieve the feature from block.json if a path is passed.
517 if ( path_is_absolute( $type ) ) {
518 $metadata = Blocks::get_block_metadata_from_file( Blocks::get_path_to_block_metadata( $type ) );
519 $feature = Blocks::get_block_feature_from_metadata( $metadata );
520
521 if ( ! empty( $feature ) ) {
522 $type = $feature;
523 }
524 }
525
526 $type = sanitize_title_with_dashes( $type );
527 self::load_styles_as_required( $type );
528 self::load_scripts_as_required( $type, $script_dependencies );
529 }
530
531 /**
532 * Only enqueue block sytles when needed.
533 *
534 * @param string $type Slug of the block.
535 *
536 * @since 7.2.0
537 *
538 * @return void
539 */
540 public static function load_styles_as_required( $type ) {
541 if ( is_admin() ) {
542 // A block's view assets will not be required in wp-admin.
543 return;
544 }
545
546 // Enqueue styles.
547 $style_relative_path = self::get_blocks_directory() . $type . '/view' . ( is_rtl() ? '.rtl' : '' ) . '.css';
548 if ( self::block_has_asset( $style_relative_path ) ) {
549 $style_version = self::get_asset_version( $style_relative_path );
550 $view_style = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
551 $view_style = add_query_arg( 'minify', 'false', $view_style );
552
553 // If this is a customizer preview, render the style directly to the preview after autosave.
554 // phpcs:ignore WordPress.Security.NonceVerification.Recommended
555 if ( is_customize_preview() && ! empty( $_GET['customize_autosaved'] ) ) {
556 // phpcs:ignore WordPress.WP.EnqueuedResources.NonEnqueuedStylesheet
557 echo '<link rel="stylesheet" id="jetpack-block-' . esc_attr( $type ) . '" href="' . esc_attr( $view_style ) . '&amp;ver=' . esc_attr( $style_version ) . '" media="all">';
558 } else {
559 wp_enqueue_style( 'jetpack-block-' . $type, $view_style, array(), $style_version );
560 wp_style_add_data( 'jetpack-block-' . $type, 'path', JETPACK__PLUGIN_DIR . $style_relative_path );
561 }
562 }
563 }
564
565 /**
566 * Only enqueue block scripts when needed.
567 *
568 * @param string $type Slug of the block.
569 * @param array $script_dependencies Script dependencies. Will be merged with automatically
570 * detected script dependencies from the webpack build.
571 *
572 * @since 7.2.0
573 *
574 * @return void
575 */
576 public static function load_scripts_as_required( $type, $script_dependencies = array() ) {
577 if ( is_admin() ) {
578 // A block's view assets will not be required in wp-admin.
579 return;
580 }
581
582 self::register_blocks_assets_base_url();
583
584 // Enqueue script.
585 $script_relative_path = self::get_blocks_directory() . $type . '/view.js';
586 $script_deps_path = JETPACK__PLUGIN_DIR . self::get_blocks_directory() . $type . '/view.asset.php';
587 $script_dependencies[] = 'jetpack-blocks-assets-base-url';
588 if ( file_exists( $script_deps_path ) ) {
589 $asset_manifest = include $script_deps_path;
590 $script_dependencies = array_unique( array_merge( $script_dependencies, $asset_manifest['dependencies'] ) );
591 }
592
593 if ( ! Blocks::is_amp_request() && self::block_has_asset( $script_relative_path ) ) {
594 $script_version = self::get_asset_version( $script_relative_path );
595 $view_script = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
596 $view_script = add_query_arg( 'minify', 'false', $view_script );
597
598 // Enqueue dependencies.
599 wp_enqueue_script( 'jetpack-block-' . $type, $view_script, $script_dependencies, $script_version, false );
600
601 // If this is a customizer preview, enqueue the dependencies and render the script directly to the preview after autosave.
602 // phpcs:ignore WordPress.Security.NonceVerification.Recommended
603 if ( is_customize_preview() && ! empty( $_GET['customize_autosaved'] ) ) {
604 // The Map block is dependent on wp-element, and it doesn't appear to to be possible to load
605 // this dynamically into the customizer iframe currently.
606 if ( 'map' === $type ) {
607 echo '<div>' . esc_html_e( 'No map preview available. Publish and refresh to see this widget.', 'jetpack' ) . '</div>';
608 echo '<script>';
609 echo 'Array.from(document.getElementsByClassName(\'wp-block-jetpack-map\')).forEach(function(element){element.style.display = \'none\';})';
610 echo '</script>';
611 } else {
612 echo '<script id="jetpack-block-' . esc_attr( $type ) . '" src="' . esc_attr( $view_script ) . '&amp;ver=' . esc_attr( $script_version ) . '"></script>';
613 }
614 }
615 }
616 }
617
618 /**
619 * Check if an asset exists for a block.
620 *
621 * @param string $file Path of the file we are looking for.
622 *
623 * @return bool $block_has_asset Does the file exist.
624 */
625 public static function block_has_asset( $file ) {
626 return file_exists( JETPACK__PLUGIN_DIR . $file );
627 }
628
629 /**
630 * Get the version number to use when loading the file. Allows us to bypass cache when developing.
631 *
632 * @param string $file Path of the file we are looking for.
633 *
634 * @return string $script_version Version number.
635 */
636 public static function get_asset_version( $file ) {
637 return Jetpack::is_development_version() && self::block_has_asset( $file )
638 ? filemtime( JETPACK__PLUGIN_DIR . $file )
639 : JETPACK__VERSION;
640 }
641
642 /**
643 * Load Gutenberg editor assets
644 *
645 * @since 6.7.0
646 *
647 * @return void
648 */
649 public static function enqueue_block_editor_assets() {
650 if ( ! self::should_load() ) {
651 return;
652 }
653
654 /**
655 * This can be called multiple times per page load in the admin, during the `enqueue_block_assets` action.
656 * These assets are necessary for the admin for editing but are not necessary for each pattern preview.
657 * Therefore we dequeue them, so they don't load for each pattern preview iframe.
658 */
659 if ( ! wp_should_load_block_editor_scripts_and_styles() ) {
660 wp_dequeue_script( 'jp-tracks' );
661 wp_dequeue_script( 'jetpack-blocks-editor' );
662
663 return;
664 }
665
666 $status = new Status();
667
668 // Required for Analytics. See _inc/lib/admin-pages/class.jetpack-admin-page.php.
669 if ( ! $status->is_offline_mode() && Jetpack::is_connection_ready() ) {
670 wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
671 }
672
673 $blocks_dir = self::get_blocks_directory();
674 $blocks_variation = self::blocks_variation();
675
676 if ( 'production' !== $blocks_variation ) {
677 $blocks_env = '-' . esc_attr( $blocks_variation );
678 } else {
679 $blocks_env = '';
680 }
681
682 self::register_blocks_assets_base_url();
683
684 Assets::register_script(
685 'jetpack-blocks-editor',
686 "{$blocks_dir}editor{$blocks_env}.js",
687 JETPACK__PLUGIN_FILE,
688 array(
689 'textdomain' => 'jetpack',
690 'dependencies' => array( 'jetpack-blocks-assets-base-url' ),
691 )
692 );
693
694 // Hack around #20357 (specifically, that the editor bundle depends on
695 // wp-edit-post but wp-edit-post's styles break the Widget Editor and
696 // Site Editor) until a real fix gets unblocked.
697 // @todo Remove this once #20357 is properly fixed.
698 $wp_styles_fix = wp_styles()->query( 'jetpack-blocks-editor', 'registered' );
699 if ( empty( $wp_styles_fix ) ) {
700 wp_die( 'Your installation of Jetpack is incomplete. Please run "jetpack build plugins/jetpack" in your dev env.' );
701 }
702 wp_styles()->query( 'jetpack-blocks-editor', 'registered' )->deps = array();
703
704 Assets::enqueue_script( 'jetpack-blocks-editor' );
705
706 if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
707 $user = wp_get_current_user();
708 $user_data = array(
709 'email' => $user->user_email,
710 'userid' => $user->ID,
711 'username' => $user->user_login,
712 );
713 $blog_id = get_current_blog_id();
714 $is_current_user_connected = true;
715 } else {
716 $user_data = Jetpack_Tracks_Client::get_connected_user_tracks_identity();
717 $blog_id = Jetpack_Options::get_option( 'id', 0 );
718 $is_current_user_connected = ( new Connection_Manager( 'jetpack' ) )->is_user_connected();
719 }
720
721 if ( $blocks_variation === 'beta' && $is_current_user_connected ) {
722 wp_enqueue_style( 'recoleta-font', '//s1.wp.com/i/fonts/recoleta/css/400.min.css', array(), Constants::get_constant( 'JETPACK__VERSION' ) );
723 }
724 // AI Assistant
725 $ai_assistant_state = array(
726 'is-enabled' => apply_filters( 'jetpack_ai_enabled', true ),
727 );
728
729 $screen_base = null;
730 if ( function_exists( 'get_current_screen' ) ) {
731 $screen_base = get_current_screen()->base;
732 }
733
734 $modules = array();
735 if ( class_exists( 'Jetpack_Core_API_Module_List_Endpoint' ) ) {
736 $module_list_endpoint = new Jetpack_Core_API_Module_List_Endpoint();
737 $modules = $module_list_endpoint->get_modules();
738 }
739
740 $jetpack_plan = Jetpack_Plan::get();
741 $initial_state = array(
742 'available_blocks' => self::get_availability(),
743 'blocks_variation' => $blocks_variation,
744 'modules' => $modules,
745 'jetpack' => array(
746 'is_active' => Jetpack::is_connection_ready(),
747 'is_current_user_connected' => $is_current_user_connected,
748 /** This filter is documented in class.jetpack-gutenberg.php */
749 'enable_upgrade_nudge' => apply_filters( 'jetpack_block_editor_enable_upgrade_nudge', false ),
750 'is_private_site' => $status->is_private_site(),
751 'is_coming_soon' => $status->is_coming_soon(),
752 'is_offline_mode' => $status->is_offline_mode(),
753 'is_newsletter_feature_enabled' => class_exists( '\Jetpack_Memberships' ),
754 // this is the equivalent of JP initial state siteData.showMyJetpack (class-jetpack-redux-state-helper)
755 // used to determine if we can link to My Jetpack from the block editor
756 'is_my_jetpack_available' => My_Jetpack_Initializer::should_initialize(),
757 'jetpack_plan' => array(
758 'data' => $jetpack_plan['product_slug'],
759 ),
760 /**
761 * Enable the RePublicize UI in the block editor context.
762 *
763 * @module publicize
764 *
765 * @since 10.3.0
766 * @deprecated 11.5 This is a feature flag that is no longer used.
767 *
768 * @param bool true Enable the RePublicize UI in the block editor context. Defaults to true.
769 */
770 'republicize_enabled' => apply_filters( 'jetpack_block_editor_republicize_feature', true ),
771 ),
772 'siteFragment' => $status->get_site_suffix(),
773 'adminUrl' => esc_url( admin_url() ),
774 'tracksUserData' => $user_data,
775 'wpcomBlogId' => $blog_id,
776 'allowedMimeTypes' => wp_get_mime_types(),
777 'siteLocale' => str_replace( '_', '-', get_locale() ),
778 'ai-assistant' => $ai_assistant_state,
779 'screenBase' => $screen_base,
780 'pluginBasePath' => plugins_url( '', Constants::get_constant( 'JETPACK__PLUGIN_FILE' ) ),
781 );
782
783 wp_localize_script(
784 'jetpack-blocks-editor',
785 'Jetpack_Editor_Initial_State',
786 $initial_state
787 );
788
789 // Adds Connection package initial state.
790 Connection_Initial_State::render_script( 'jetpack-blocks-editor' );
791 }
792
793 /**
794 * Some blocks do not depend on a specific module,
795 * and can consequently be loaded outside of the usual modules.
796 * We will look for such modules in the extensions/ directory.
797 *
798 * @since 7.1.0
799 * @see wp_common_block_scripts_and_styles()
800 */
801 public static function load_independent_blocks() {
802 if ( self::should_load() ) {
803 /**
804 * Look for files that match our list of available Jetpack Gutenberg extensions (blocks and plugins).
805 * If available, load them.
806 */
807 $directories = array( 'blocks', 'plugins', 'extended-blocks' );
808
809 foreach ( static::get_extensions() as $extension ) {
810 foreach ( $directories as $dirname ) {
811 $path = JETPACK__PLUGIN_DIR . "extensions/{$dirname}/{$extension}/{$extension}.php";
812
813 if ( file_exists( $path ) ) {
814 include_once $path;
815 continue 2;
816 }
817 }
818 }
819 }
820 }
821
822 /**
823 * Loads PHP components of block editor extensions.
824 *
825 * @since 8.9.0
826 */
827 public static function load_block_editor_extensions() {
828 if ( self::should_load() ) {
829 // Block editor extensions to load.
830 $extensions_to_load = array(
831 'extended-blocks',
832 'plugins',
833 );
834
835 // Collect the extension paths.
836 foreach ( $extensions_to_load as $extension_to_load ) {
837 $extensions_folder = glob( JETPACK__PLUGIN_DIR . 'extensions/' . $extension_to_load . '/*' );
838
839 // Require each of the extension files, in case it exists.
840 foreach ( $extensions_folder as $extension_folder ) {
841 $name = basename( $extension_folder );
842 $extension_file_path = JETPACK__PLUGIN_DIR . 'extensions/' . $extension_to_load . '/' . $name . '/' . $name . '.php';
843
844 if ( file_exists( $extension_file_path ) ) {
845 include_once $extension_file_path;
846 }
847 }
848 }
849 }
850 }
851
852 /**
853 * Determine whether a site should use the default set of blocks, or a custom set.
854 * Possible variations are currently beta, experimental, and production.
855 *
856 * @since 8.1.0
857 *
858 * @return string $block_varation production|beta|experimental
859 */
860 public static function blocks_variation() {
861 // Default to production blocks.
862 $block_varation = 'production';
863
864 /*
865 * Prefer to use this JETPACK_BLOCKS_VARIATION constant
866 * or the jetpack_blocks_variation filter
867 * to set the block variation in your code.
868 */
869 $default = Constants::get_constant( 'JETPACK_BLOCKS_VARIATION' );
870 if ( ! empty( $default ) && in_array( $default, array( 'beta', 'experimental', 'production' ), true ) ) {
871 $block_varation = $default;
872 }
873
874 /**
875 * Alternative to `JETPACK_BETA_BLOCKS`, set to `true` to load Beta Blocks.
876 *
877 * @since 6.9.0
878 * @deprecated 11.8.0 Use jetpack_blocks_variation filter instead.
879 *
880 * @param boolean
881 */
882 $is_beta = apply_filters_deprecated(
883 'jetpack_load_beta_blocks',
884 array( false ),
885 'jetpack-11.8.0',
886 'jetpack_blocks_variation'
887 );
888
889 /*
890 * Switch to beta blocks if you use the JETPACK_BETA_BLOCKS constant
891 * or the deprecated jetpack_load_beta_blocks filter.
892 * This only applies when not using the newer JETPACK_BLOCKS_VARIATION constant.
893 */
894 if (
895 empty( $default )
896 && (
897 $is_beta
898 || Constants::is_true( 'JETPACK_BETA_BLOCKS' )
899 )
900 ) {
901 $block_varation = 'beta';
902 }
903
904 /**
905 * Alternative to `JETPACK_EXPERIMENTAL_BLOCKS`, set to `true` to load Experimental Blocks.
906 *
907 * @since 6.9.0
908 * @deprecated 11.8.0 Use jetpack_blocks_variation filter instead.
909 *
910 * @param boolean
911 */
912 $is_experimental = apply_filters_deprecated(
913 'jetpack_load_experimental_blocks',
914 array( false ),
915 'jetpack-11.8.0',
916 'jetpack_blocks_variation'
917 );
918
919 /*
920 * Switch to experimental blocks if you use the JETPACK_EXPERIMENTAL_BLOCKS constant
921 * or the deprecated jetpack_load_experimental_blocks filter.
922 * This only applies when not using the newer JETPACK_BLOCKS_VARIATION constant.
923 */
924 if (
925 empty( $default )
926 && (
927 $is_experimental
928 || Constants::is_true( 'JETPACK_EXPERIMENTAL_BLOCKS' )
929 )
930 ) {
931 $block_varation = 'experimental';
932 }
933
934 /**
935 * Allow customizing the variation of blocks in use on a site.
936 * Overwrites any previously set values, whether by constant or filter.
937 *
938 * @since 8.1.0
939 *
940 * @param string $block_variation Can be beta, experimental, and production. Defaults to production.
941 */
942 return apply_filters( 'jetpack_blocks_variation', $block_varation );
943 }
944
945 /**
946 * Get a list of extensions available for the variation you chose.
947 *
948 * @since 8.1.0
949 *
950 * @param object $preset_extensions_manifest List of extensions available in Jetpack.
951 * @param string $blocks_variation Subset of blocks. production|beta|experimental.
952 *
953 * @return array $preset_extensions Array of extensions for that variation
954 */
955 public static function get_extensions_preset_for_variation( $preset_extensions_manifest, $blocks_variation ) {
956 $preset_extensions = isset( $preset_extensions_manifest->{ $blocks_variation } )
957 ? (array) $preset_extensions_manifest->{ $blocks_variation }
958 : array();
959
960 /*
961 * Experimental and Beta blocks need the production blocks as well.
962 */
963 if (
964 'experimental' === $blocks_variation
965 || 'beta' === $blocks_variation
966 ) {
967 $production_extensions = isset( $preset_extensions_manifest->production )
968 ? (array) $preset_extensions_manifest->production
969 : array();
970
971 $preset_extensions = array_unique( array_merge( $preset_extensions, $production_extensions ) );
972 }
973
974 /*
975 * Beta blocks need the experimental blocks as well.
976 *
977 * If you've chosen to see Beta blocks,
978 * we want to make all blocks available to you:
979 * - Production
980 * - Experimental
981 * - Beta
982 */
983 if ( 'beta' === $blocks_variation ) {
984 $production_extensions = isset( $preset_extensions_manifest->experimental )
985 ? (array) $preset_extensions_manifest->experimental
986 : array();
987
988 $preset_extensions = array_unique( array_merge( $preset_extensions, $production_extensions ) );
989 }
990
991 return $preset_extensions;
992 }
993
994 /**
995 * Validate a URL used in a SSR block.
996 *
997 * @since 8.3.0
998 *
999 * @param string $url URL saved as an attribute in block.
1000 * @param array $allowed Array of allowed hosts for that block, or regexes to check against.
1001 * @param bool $is_regex Array of regexes matching the URL that could be used in block.
1002 *
1003 * @return bool|string
1004 */
1005 public static function validate_block_embed_url( $url, $allowed = array(), $is_regex = false ) {
1006 if (
1007 empty( $url )
1008 || ! is_array( $allowed )
1009 || empty( $allowed )
1010 ) {
1011 return false;
1012 }
1013
1014 $url_components = wp_parse_url( $url );
1015
1016 // Bail early if we cannot find a host.
1017 if ( empty( $url_components['host'] ) ) {
1018 return false;
1019 }
1020
1021 // Normalize URL.
1022 $url = sprintf(
1023 '%s://%s%s%s',
1024 isset( $url_components['scheme'] ) ? $url_components['scheme'] : 'https',
1025 $url_components['host'],
1026 isset( $url_components['path'] ) ? $url_components['path'] : '/',
1027 isset( $url_components['query'] ) ? '?' . $url_components['query'] : ''
1028 );
1029
1030 if ( ! empty( $url_components['fragment'] ) ) {
1031 $url = $url . '#' . rawurlencode( $url_components['fragment'] );
1032 }
1033
1034 /*
1035 * If we're using an allowed list of hosts,
1036 * check if the URL belongs to one of the domains allowed for that block.
1037 */
1038 if (
1039 false === $is_regex
1040 && in_array( $url_components['host'], $allowed, true )
1041 ) {
1042 return $url;
1043 }
1044
1045 /*
1046 * If we are using an array of regexes to check against,
1047 * loop through that.
1048 */
1049 if ( true === $is_regex ) {
1050 foreach ( $allowed as $regex ) {
1051 if ( 1 === preg_match( $regex, $url ) ) {
1052 return $url;
1053 }
1054 }
1055 }
1056
1057 return false;
1058 }
1059
1060 /**
1061 * Determines whether a preview of the block with an upgrade nudge should
1062 * be displayed for admins on the site frontend.
1063 *
1064 * @since 8.4.0
1065 *
1066 * @param array $availability_for_block The availability for the block.
1067 *
1068 * @return bool
1069 */
1070 public static function should_show_frontend_preview( $availability_for_block ) {
1071 return (
1072 isset( $availability_for_block['details']['required_plan'] )
1073 && current_user_can( 'manage_options' )
1074 && ! is_feed()
1075 );
1076 }
1077
1078 /**
1079 * Output an UpgradeNudge Component on the frontend of a site.
1080 *
1081 * @since 8.4.0
1082 *
1083 * @param string $plan The plan that users need to purchase to make the block work.
1084 *
1085 * @return string
1086 */
1087 public static function upgrade_nudge( $plan ) {
1088 require_once JETPACK__PLUGIN_DIR . '_inc/lib/components.php';
1089 return Jetpack_Components::render_upgrade_nudge(
1090 array(
1091 'plan' => $plan,
1092 )
1093 );
1094 }
1095
1096 /**
1097 * Output a notice within a block.
1098 *
1099 * @since 8.6.0
1100 *
1101 * @param string $message Notice we want to output.
1102 * @param string $status Status of the notice. Can be one of success, info, warning, error. info by default.
1103 * @param string $classes List of CSS classes.
1104 *
1105 * @return string
1106 */
1107 public static function notice( $message, $status = 'info', $classes = '' ) {
1108 if (
1109 empty( $message )
1110 || ! in_array( $status, array( 'success', 'info', 'warning', 'error' ), true )
1111 ) {
1112 return '';
1113 }
1114
1115 $color = '';
1116 switch ( $status ) {
1117 case 'success':
1118 $color = '#00a32a';
1119 break;
1120 case 'warning':
1121 $color = '#dba617';
1122 break;
1123 case 'error':
1124 $color = '#d63638';
1125 break;
1126 case 'info':
1127 default:
1128 $color = '#72aee6';
1129 break;
1130 }
1131
1132 return sprintf(
1133 '<div class="jetpack-block__notice %1$s %3$s" style="border-left:5px solid %4$s;padding:1em;background-color:#f8f9f9;">%2$s</div>',
1134 esc_attr( $status ),
1135 wp_kses(
1136 $message,
1137 array(
1138 'br' => array(),
1139 'p' => array(),
1140 'a' => array(
1141 'href' => array(),
1142 'target' => array(),
1143 'rel' => array(),
1144 ),
1145 )
1146 ),
1147 esc_attr( $classes ),
1148 sanitize_hex_color( $color )
1149 );
1150 }
1151
1152 /**
1153 * Retrieve site-specific features for Simple sites.
1154 *
1155 * We're caching the data for the lifetime of the request, because it can be slow to calculate,
1156 * and it can be called multiple times per single request.
1157 *
1158 * We intentionally don't use object caching or any other type of persistent caching,
1159 * in order to avoid complex cache invalidation on subscription addition or removal.
1160 *
1161 * @since 10.7
1162 *
1163 * @return array
1164 */
1165 private static function get_site_specific_features() {
1166 $current_blog_id = get_current_blog_id();
1167
1168 if ( isset( self::$site_specific_features[ $current_blog_id ] ) ) {
1169 return self::$site_specific_features[ $current_blog_id ];
1170 }
1171
1172 if ( ! class_exists( 'Store_Product_List' ) ) {
1173 require WP_CONTENT_DIR . '/admin-plugins/wpcom-billing/store-product-list.php';
1174 }
1175
1176 $site_specific_features = Store_Product_List::get_site_specific_features_data( $current_blog_id );
1177 self::$site_specific_features[ $current_blog_id ] = $site_specific_features;
1178
1179 return $site_specific_features;
1180 }
1181
1182 /**
1183 * Set the availability of the block as the editor
1184 * is loaded.
1185 *
1186 * @param string $slug Slug of the block.
1187 */
1188 public static function set_availability_for_plan( $slug ) {
1189 $slug = self::remove_extension_prefix( $slug );
1190
1191 if ( Jetpack_Plan::supports( $slug ) ) {
1192 self::set_extension_available( $slug );
1193 return;
1194 }
1195
1196 // Check what's the minimum plan where the feature is available.
1197 $plan = '';
1198 $features_data = array();
1199 $is_simple_site = defined( 'IS_WPCOM' ) && IS_WPCOM;
1200 $is_atomic_site = ( new Host() )->is_woa_site();
1201
1202 if ( $is_simple_site || $is_atomic_site ) {
1203 // Simple sites.
1204 if ( $is_simple_site ) {
1205 $features_data = self::get_site_specific_features();
1206 } else {
1207 // Atomic sites.
1208 $option = get_option( 'jetpack_active_plan' );
1209 if ( isset( $option['features'] ) ) {
1210 $features_data = $option['features'];
1211 }
1212 }
1213
1214 if ( ! empty( $features_data['available'][ $slug ] ) ) {
1215 $plan = $features_data['available'][ $slug ][0];
1216 }
1217 } else {
1218 // Jetpack sites.
1219 $plan = Jetpack_Plan::get_minimum_plan_for_feature( $slug );
1220 }
1221
1222 self::set_extension_unavailable(
1223 $slug,
1224 'missing_plan',
1225 array(
1226 'required_feature' => $slug,
1227 'required_plan' => $plan,
1228 )
1229 );
1230 }
1231
1232 /**
1233 * Wraps the suplied render_callback in a function to check
1234 * the availability of the block before rendering it.
1235 *
1236 * @param string $slug The block slug, used to check for availability.
1237 * @param callable $render_callback The render_callback that will be called if the block is available.
1238 */
1239 public static function get_render_callback_with_availability_check( $slug, $render_callback ) {
1240 return function ( $prepared_attributes, $block_content, $block ) use ( $render_callback, $slug ) {
1241 $availability = self::get_cached_availability();
1242 $bare_slug = self::remove_extension_prefix( $slug );
1243 if ( isset( $availability[ $bare_slug ] ) && $availability[ $bare_slug ]['available'] ) {
1244 return call_user_func( $render_callback, $prepared_attributes, $block_content );
1245 }
1246
1247 // A preview of the block is rendered for admins on the frontend with an upgrade nudge.
1248 if ( isset( $availability[ $bare_slug ] ) ) {
1249 if ( self::should_show_frontend_preview( $availability[ $bare_slug ] ) ) {
1250 $block_preview = call_user_func( $render_callback, $prepared_attributes, $block_content );
1251
1252 // If the upgrade nudge isn't already being displayed by a parent block, display the nudge.
1253 if ( isset( $block->attributes['shouldDisplayFrontendBanner'] ) && $block->attributes['shouldDisplayFrontendBanner'] ) {
1254 $upgrade_nudge = self::upgrade_nudge( $availability[ $bare_slug ]['details']['required_plan'] );
1255 return $upgrade_nudge . $block_preview;
1256 }
1257
1258 return $block_preview;
1259 }
1260 }
1261
1262 return null;
1263 };
1264 }
1265
1266 /**
1267 * Display a message to site editors and roles above when a block is no longer supported.
1268 * This is only displayed on the frontend.
1269 *
1270 * @since 12.3
1271 *
1272 * @param string $block_content The block content.
1273 * @param array $block The full block, including name and attributes.
1274 *
1275 * @return string
1276 */
1277 public static function display_deprecated_block_message( $block_content, $block ) {
1278 if ( in_array( $block['blockName'], self::$deprecated_blocks, true ) ) {
1279 if ( current_user_can( 'edit_posts' ) ) {
1280 $block_content = self::notice(
1281 __( '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' ),
1282 'warning',
1283 'jetpack-block-deprecated'
1284 );
1285 } else {
1286 $block_content = '';
1287 }
1288 }
1289
1290 return $block_content;
1291 }
1292
1293 /**
1294 * Temporarily bypasses _doing_it_wrong() notices for block metadata collection registration.
1295 *
1296 * WordPress 6.7 introduced block metadata collections (with strict path validation).
1297 * Any sites using symlinks for plugins will fail the validation which causes the metadata
1298 * collection to not be registered. However, the blocks will still fall back to the regular
1299 * registration and no functionality is affected.
1300 * While this validation is being discussed in WordPress Core (#62140),
1301 * this method allows registration to proceed by temporarily disabling
1302 * the relevant notice.
1303 *
1304 * @since 14.2
1305 *
1306 * @param bool $trigger Whether to trigger the error.
1307 * @param string $function The function that was called.
1308 * @param string $message A message explaining what was done incorrectly.
1309 * @param string $version The version of WordPress where the message was added.
1310 * @return bool Whether to trigger the error.
1311 */
1312 public static function bypass_block_metadata_doing_it_wrong( $trigger, $function, $message, $version ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
1313 if ( $function === 'WP_Block_Metadata_Registry::register_collection' ) {
1314 return false;
1315 }
1316 return $trigger;
1317 }
1318
1319 /**
1320 * Register block metadata collection for Jetpack blocks.
1321 * This allows for more efficient block metadata loading by avoiding
1322 * individual block.json file reads at runtime.
1323 *
1324 * Uses wp_register_block_metadata_collection() if available (WordPress 6.7+)
1325 * and if the manifest file exists. The manifest file is auto-generated
1326 * during the build process.
1327 *
1328 * Runs on plugins_loaded to ensure registration happens before individual
1329 * blocks register themselves on init.
1330 *
1331 * @static
1332 * @since 14.1
1333 * @return void
1334 */
1335 public static function register_block_metadata_collection() {
1336 $meta_file_path = JETPACK__PLUGIN_DIR . '_inc/blocks/blocks-manifest.php';
1337 if ( function_exists( 'wp_register_block_metadata_collection' ) && file_exists( $meta_file_path ) ) {
1338 add_filter( 'doing_it_wrong_trigger_error', array( __CLASS__, 'bypass_block_metadata_doing_it_wrong' ), 10, 4 );
1339
1340 // @phan-suppress-next-line PhanUndeclaredFunction -- New in WP 6.7. We're checking if it exists first. @phan-suppress-current-line UnusedPluginSuppression
1341 wp_register_block_metadata_collection(
1342 JETPACK__PLUGIN_DIR . '_inc/blocks/',
1343 $meta_file_path
1344 );
1345
1346 remove_filter( 'doing_it_wrong_trigger_error', array( __CLASS__, 'bypass_block_metadata_doing_it_wrong' ), 10 );
1347 }
1348 }
1349 }
1350
1351 if ( ( new Host() )->is_woa_site() ) {
1352 /**
1353 * Enable upgrade nudge for Atomic sites.
1354 * This feature is false as default,
1355 * so let's enable it through this filter.
1356 *
1357 * More doc: https://github.com/Automattic/jetpack/blob/trunk/projects/plugins/jetpack/extensions/README.md#upgrades-for-blocks
1358 */
1359 add_filter( 'jetpack_block_editor_enable_upgrade_nudge', '__return_true' );
1360 }
1361