PluginProbe
Gutenberg / 11.0.0
Gutenberg v11.0.0
23.9.1 23.9.0 23.8.0 23.7.2 23.7.1 23.7.0 23.6.1 23.6.2 23.6.0 23.5.3 23.5.2 23.5.1 23.5.0 23.4.0 23.3.2 23.3.1 23.3.0 23.2.0 23.2.1 23.2.2 23.1.1 23.1.0 23.0.1 12.6.0 7.4.0 All 402 releases
gutenberg / lib / client-assets.php

client-assets.php in Gutenberg 11.0.0, at lib/client-assets.php

805 lines 25.7 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /**
3 * Functions to register client-side assets (scripts and stylesheets) for the
4 * Gutenberg editor plugin.
5 *
6 * @package gutenberg
7 */
8
9 if ( ! defined( 'ABSPATH' ) ) {
10 die( 'Silence is golden.' );
11 }
12
13 /**
14 * Retrieves the root plugin path.
15 *
16 * @return string Root path to the gutenberg plugin.
17 *
18 * @since 0.1.0
19 */
20 function gutenberg_dir_path() {
21 return plugin_dir_path( __DIR__ );
22 }
23
24 /**
25 * Retrieves a URL to a file in the gutenberg plugin.
26 *
27 * @param string $path Relative path of the desired file.
28 *
29 * @return string Fully qualified URL pointing to the desired file.
30 *
31 * @since 0.1.0
32 */
33 function gutenberg_url( $path ) {
34 return plugins_url( $path, __DIR__ );
35 }
36
37 /**
38 * Registers a script according to `wp_register_script`. Honors this request by
39 * reassigning internal dependency properties of any script handle already
40 * registered by that name. It does not deregister the original script, to
41 * avoid losing inline scripts which may have been attached.
42 *
43 * @since 4.1.0
44 *
45 * @param WP_Scripts $scripts WP_Scripts instance.
46 * @param string $handle Name of the script. Should be unique.
47 * @param string $src Full URL of the script, or path of the script relative to the WordPress root directory.
48 * @param array $deps Optional. An array of registered script handles this script depends on. Default empty array.
49 * @param string|bool|null $ver Optional. String specifying script version number, if it has one, which is added to the URL
50 * as a query string for cache busting purposes. If version is set to false, a version
51 * number is automatically added equal to current installed WordPress version.
52 * If set to null, no version is added.
53 * @param bool $in_footer Optional. Whether to enqueue the script before </body> instead of in the <head>.
54 * Default 'false'.
55 */
56 function gutenberg_override_script( $scripts, $handle, $src, $deps = array(), $ver = false, $in_footer = false ) {
57 $script = $scripts->query( $handle, 'registered' );
58 if ( $script ) {
59 /*
60 * In many ways, this is a reimplementation of `wp_register_script` but
61 * bypassing consideration of whether a script by the given handle had
62 * already been registered.
63 */
64
65 // See: `_WP_Dependency::__construct` .
66 $script->src = $src;
67 $script->deps = $deps;
68 $script->ver = $ver;
69 $script->args = $in_footer;
70
71 /*
72 * The script's `group` designation is an indication of whether it is
73 * to be printed in the header or footer. The behavior here defers to
74 * the arguments as passed. Specifically, group data is not assigned
75 * for a script unless it is designated to be printed in the footer.
76 */
77
78 // See: `wp_register_script` .
79 unset( $script->extra['group'] );
80 if ( $in_footer ) {
81 $script->add_data( 'group', 1 );
82 }
83 } else {
84 $scripts->add( $handle, $src, $deps, $ver, $in_footer );
85 }
86
87 /*
88 * `WP_Dependencies::set_translations` will fall over on itself if setting
89 * translations on the `wp-i18n` handle, since it internally adds `wp-i18n`
90 * as a dependency of itself, exhausting memory. The same applies for the
91 * polyfill and hooks scripts, which are dependencies _of_ `wp-i18n`.
92 *
93 * See: https://core.trac.wordpress.org/ticket/46089
94 */
95 if ( ! in_array( $handle, array( 'wp-i18n', 'wp-polyfill', 'wp-hooks' ), true ) ) {
96 $scripts->set_translations( $handle, 'default' );
97 }
98
99 // Remove this check once the minimum supported WordPress version is at least 5.7.
100 if ( 'wp-i18n' === $handle ) {
101 $ltr = 'rtl' === _x( 'ltr', 'text direction', 'default' ) ? 'rtl' : 'ltr';
102 $output = sprintf( "wp.i18n.setLocaleData( { 'text direction\u0004ltr': [ '%s' ] }, 'default' );", $ltr );
103 $scripts->add_inline_script( 'wp-i18n', $output, 'after' );
104 }
105 }
106
107 /**
108 * Filters the default translation file load behavior to load the Gutenberg
109 * plugin translation file, if available.
110 *
111 * @param string|false $file Path to the translation file to load. False if
112 * there isn't one.
113 * @param string $handle Name of the script to register a translation
114 * domain to.
115 *
116 * @return string|false Filtered path to the Gutenberg translation file, if
117 * available.
118 */
119 function gutenberg_override_translation_file( $file, $handle ) {
120 if ( ! $file ) {
121 return $file;
122 }
123
124 // Ignore scripts whose handle does not have the "wp-" prefix.
125 if ( 'wp-' !== substr( $handle, 0, 3 ) ) {
126 return $file;
127 }
128
129 // Ignore scripts that are not found in the expected `build/` location.
130 $script_path = gutenberg_dir_path() . 'build/' . substr( $handle, 3 ) . '/index.min.js';
131 if ( ! file_exists( $script_path ) ) {
132 return $file;
133 }
134
135 /*
136 * The default file will be in the plugins language directory, omitting the
137 * domain since Gutenberg assigns the script translations as the default.
138 *
139 * Example: /www/wp-content/languages/plugins/de_DE-07d88e6a803e01276b9bfcc1203e862e.json
140 *
141 * The logic of `load_script_textdomain` is such that it will assume to
142 * search in the plugins language directory, since the assigned source of
143 * the overridden Gutenberg script originates in the plugins directory.
144 *
145 * The plugin translation files each begin with the slug of the plugin, so
146 * it's a simple matter of prepending the Gutenberg plugin slug.
147 */
148 $path_parts = pathinfo( $file );
149 $plugin_translation_file = (
150 $path_parts['dirname'] .
151 '/gutenberg-' .
152 $path_parts['basename']
153 );
154
155 return $plugin_translation_file;
156 }
157 add_filter( 'load_script_translation_file', 'gutenberg_override_translation_file', 10, 2 );
158
159 /**
160 * Registers a style according to `wp_register_style`. Honors this request by
161 * deregistering any style by the same handler before registration.
162 *
163 * @since 4.1.0
164 *
165 * @param WP_Styles $styles WP_Styles instance.
166 * @param string $handle Name of the stylesheet. Should be unique.
167 * @param string $src Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory.
168 * @param array $deps Optional. An array of registered stylesheet handles this stylesheet depends on. Default empty array.
169 * @param string|bool|null $ver Optional. String specifying stylesheet version number, if it has one, which is added to the URL
170 * as a query string for cache busting purposes. If version is set to false, a version
171 * number is automatically added equal to current installed WordPress version.
172 * If set to null, no version is added.
173 * @param string $media Optional. The media for which this stylesheet has been defined.
174 * Default 'all'. Accepts media types like 'all', 'print' and 'screen', or media queries like
175 * '(orientation: portrait)' and '(max-width: 640px)'.
176 */
177 function gutenberg_override_style( $styles, $handle, $src, $deps = array(), $ver = false, $media = 'all' ) {
178 $style = $styles->query( $handle, 'registered' );
179 if ( $style ) {
180 $styles->remove( $handle );
181 }
182 $styles->add( $handle, $src, $deps, $ver, $media );
183 }
184
185 /**
186 * Registers vendor JavaScript files to be used as dependencies of the editor
187 * and plugins.
188 *
189 * This function is called from a script during the plugin build process, so it
190 * should not call any WordPress PHP functions.
191 *
192 * @since 0.1.0
193 *
194 * @param WP_Scripts $scripts WP_Scripts instance.
195 */
196 function gutenberg_register_vendor_scripts( $scripts ) {
197 $suffix = SCRIPT_DEBUG ? '' : '.min';
198
199 $react_suffix = ( SCRIPT_DEBUG ? '.development' : '.production' ) . $suffix;
200 gutenberg_register_vendor_script(
201 $scripts,
202 'react',
203 'https://unpkg.com/react@17.0.1/umd/react' . $react_suffix . '.js',
204 array( 'wp-polyfill' )
205 );
206 gutenberg_register_vendor_script(
207 $scripts,
208 'react-dom',
209 'https://unpkg.com/react-dom@17.0.1/umd/react-dom' . $react_suffix . '.js',
210 array( 'react' )
211 );
212
213 /*
214 * This script registration and the corresponding function should be removed
215 * removed once the plugin is updated to support WordPress 5.7.0 and newer.
216 */
217 gutenberg_register_vendor_script(
218 $scripts,
219 'object-fit-polyfill',
220 'https://unpkg.com/objectFitPolyfill@2.3.5/dist/objectFitPolyfill.min.js',
221 array(),
222 '2.3.5'
223 );
224 }
225 add_action( 'wp_default_scripts', 'gutenberg_register_vendor_scripts' );
226
227 /**
228 * Registers all the WordPress packages scripts that are in the standardized
229 * `build/` location.
230 *
231 * @since 4.5.0
232 *
233 * @param WP_Scripts $scripts WP_Scripts instance.
234 */
235 function gutenberg_register_packages_scripts( $scripts ) {
236 // When in production, use the plugin's version as the default asset version;
237 // else (for development or test) default to use the current time.
238 $default_version = defined( 'GUTENBERG_VERSION' ) && ! ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? GUTENBERG_VERSION : time();
239
240 foreach ( glob( gutenberg_dir_path() . 'build/*/index.min.js' ) as $path ) {
241 // Prefix `wp-` to package directory to get script handle.
242 // For example, `…/build/a11y/index.min.js` becomes `wp-a11y`.
243 $handle = 'wp-' . basename( dirname( $path ) );
244
245 // Replace extension with `.asset.php` to find the generated dependencies file.
246 $asset_file = substr( $path, 0, -( strlen( '.js' ) ) ) . '.asset.php';
247 $asset = file_exists( $asset_file )
248 ? require( $asset_file )
249 : null;
250 $dependencies = isset( $asset['dependencies'] ) ? $asset['dependencies'] : array();
251 $version = isset( $asset['version'] ) ? $asset['version'] : $default_version;
252
253 // Add dependencies that cannot be detected and generated by build tools.
254 switch ( $handle ) {
255 case 'wp-block-library':
256 array_push( $dependencies, 'editor' );
257 break;
258
259 case 'wp-edit-post':
260 array_push( $dependencies, 'media-models', 'media-views', 'postbox' );
261 break;
262
263 case 'wp-edit-site':
264 array_push( $dependencies, 'wp-dom-ready' );
265 break;
266 }
267
268 // Get the path from Gutenberg directory as expected by `gutenberg_url`.
269 $gutenberg_path = substr( $path, strlen( gutenberg_dir_path() ) );
270
271 gutenberg_override_script(
272 $scripts,
273 $handle,
274 gutenberg_url( $gutenberg_path ),
275 $dependencies,
276 $version,
277 true
278 );
279 }
280 }
281 add_action( 'wp_default_scripts', 'gutenberg_register_packages_scripts' );
282
283 /**
284 * Registers all the WordPress packages styles that are in the standardized
285 * `build/` location.
286 *
287 * @since 6.7.0
288
289 * @param WP_Styles $styles WP_Styles instance.
290 */
291 function gutenberg_register_packages_styles( $styles ) {
292 // When in production, use the plugin's version as the asset version;
293 // else (for development or test) default to use the current time.
294 $version = defined( 'GUTENBERG_VERSION' ) && ! ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? GUTENBERG_VERSION : time();
295
296 // Editor Styles.
297 gutenberg_override_style(
298 $styles,
299 'wp-block-editor',
300 gutenberg_url( 'build/block-editor/style.css' ),
301 array( 'wp-components' ),
302 $version
303 );
304 $styles->add_data( 'wp-block-editor', 'rtl', 'replace' );
305
306 gutenberg_override_style(
307 $styles,
308 'wp-editor',
309 gutenberg_url( 'build/editor/style.css' ),
310 array( 'wp-components', 'wp-block-editor', 'wp-nux', 'wp-reusable-blocks' ),
311 $version
312 );
313 $styles->add_data( 'wp-editor', 'rtl', 'replace' );
314
315 gutenberg_override_style(
316 $styles,
317 'wp-edit-post',
318 gutenberg_url( 'build/edit-post/style.css' ),
319 array( 'wp-components', 'wp-block-editor', 'wp-editor', 'wp-edit-blocks', 'wp-block-library', 'wp-nux' ),
320 $version
321 );
322 $styles->add_data( 'wp-edit-post', 'rtl', 'replace' );
323
324 gutenberg_override_style(
325 $styles,
326 'wp-components',
327 gutenberg_url( 'build/components/style.css' ),
328 array( 'dashicons' ),
329 $version
330 );
331 $styles->add_data( 'wp-components', 'rtl', 'replace' );
332
333 $block_library_filename = wp_should_load_separate_core_block_assets() ? 'common' : 'style';
334 gutenberg_override_style(
335 $styles,
336 'wp-block-library',
337 gutenberg_url( 'build/block-library/' . $block_library_filename . '.css' ),
338 array(),
339 $version
340 );
341 $styles->add_data( 'wp-block-library', 'rtl', 'replace' );
342 $styles->add_data( 'wp-block-library', 'path', gutenberg_dir_path() . 'build/block-library/' . $block_library_filename . '.css' );
343
344 gutenberg_override_style(
345 $styles,
346 'wp-format-library',
347 gutenberg_url( 'build/format-library/style.css' ),
348 array( 'wp-block-editor', 'wp-components' ),
349 $version
350 );
351 $styles->add_data( 'wp-format-library', 'rtl', 'replace' );
352
353 $wp_edit_blocks_dependencies = array(
354 'wp-components',
355 'wp-editor',
356 // This need to be added before the block library styles,
357 // The block library styles override the "reset" styles.
358 'wp-reset-editor-styles',
359 'wp-block-library',
360 'wp-reusable-blocks',
361 );
362
363 // Only load the default layout and margin styles for themes without theme.json file.
364 if ( ! WP_Theme_JSON_Resolver_Gutenberg::theme_has_support() ) {
365 $wp_edit_blocks_dependencies[] = 'wp-editor-classic-layout-styles';
366 }
367
368 global $editor_styles;
369 if ( ! is_array( $editor_styles ) || count( $editor_styles ) === 0 ) {
370 // Include opinionated block styles if no $editor_styles are declared, so the editor never appears broken.
371 $wp_edit_blocks_dependencies[] = 'wp-block-library-theme';
372 }
373
374 gutenberg_override_style(
375 $styles,
376 'wp-reset-editor-styles',
377 gutenberg_url( 'build/block-library/reset.css' ),
378 array( 'common', 'forms' ), // Make sure the reset is loaded after the default WP Adminn styles.
379 $version
380 );
381 $styles->add_data( 'wp-reset-editor-styles', 'rtl', 'replace' );
382
383 gutenberg_override_style(
384 $styles,
385 'wp-editor-classic-layout-styles',
386 gutenberg_url( 'build/edit-post/classic.css' ),
387 array(),
388 $version
389 );
390 $styles->add_data( 'wp-editor-classic-layout-styles', 'rtl', 'replace' );
391
392 gutenberg_override_style(
393 $styles,
394 'wp-edit-blocks',
395 gutenberg_url( 'build/block-library/editor.css' ),
396 $wp_edit_blocks_dependencies,
397 $version
398 );
399 $styles->add_data( 'wp-edit-blocks', 'rtl', 'replace' );
400
401 gutenberg_override_style(
402 $styles,
403 'wp-nux',
404 gutenberg_url( 'build/nux/style.css' ),
405 array( 'wp-components' ),
406 $version
407 );
408 $styles->add_data( 'wp-nux', 'rtl', 'replace' );
409
410 gutenberg_override_style(
411 $styles,
412 'wp-block-library-theme',
413 gutenberg_url( 'build/block-library/theme.css' ),
414 array(),
415 $version
416 );
417 $styles->add_data( 'wp-block-library-theme', 'rtl', 'replace' );
418
419 gutenberg_override_style(
420 $styles,
421 'wp-list-reusable-blocks',
422 gutenberg_url( 'build/list-reusable-blocks/style.css' ),
423 array( 'wp-components' ),
424 $version
425 );
426 $styles->add_data( 'wp-list-reusable-block', 'rtl', 'replace' );
427
428 gutenberg_override_style(
429 $styles,
430 'wp-edit-navigation',
431 gutenberg_url( 'build/edit-navigation/style.css' ),
432 array( 'wp-components', 'wp-block-editor', 'wp-edit-blocks' ),
433 $version
434 );
435 $styles->add_data( 'wp-edit-navigation', 'rtl', 'replace' );
436
437 gutenberg_override_style(
438 $styles,
439 'wp-edit-site',
440 gutenberg_url( 'build/edit-site/style.css' ),
441 array( 'wp-components', 'wp-block-editor', 'wp-edit-blocks' ),
442 $version
443 );
444 $styles->add_data( 'wp-edit-site', 'rtl', 'replace' );
445
446 gutenberg_override_style(
447 $styles,
448 'wp-edit-widgets',
449 gutenberg_url( 'build/edit-widgets/style.css' ),
450 array( 'wp-components', 'wp-block-editor', 'wp-edit-blocks', 'wp-reusable-blocks', 'wp-widgets' ),
451 $version
452 );
453 $styles->add_data( 'wp-edit-widgets', 'rtl', 'replace' );
454
455 gutenberg_override_style(
456 $styles,
457 'wp-block-directory',
458 gutenberg_url( 'build/block-directory/style.css' ),
459 array( 'wp-block-editor', 'wp-components' ),
460 $version
461 );
462 $styles->add_data( 'wp-block-directory', 'rtl', 'replace' );
463
464 gutenberg_override_style(
465 $styles,
466 'wp-customize-widgets',
467 gutenberg_url( 'build/customize-widgets/style.css' ),
468 array( 'wp-components', 'wp-block-editor', 'wp-edit-blocks', 'wp-widgets' ),
469 $version
470 );
471 $styles->add_data( 'wp-customize-widgets', 'rtl', 'replace' );
472
473 gutenberg_override_style(
474 $styles,
475 'wp-reusable-blocks',
476 gutenberg_url( 'build/reusable-blocks/style.css' ),
477 array( 'wp-components' ),
478 $version
479 );
480 $styles->add_data( 'wp-reusable-block', 'rtl', 'replace' );
481
482 gutenberg_override_style(
483 $styles,
484 'wp-widgets',
485 gutenberg_url( 'build/widgets/style.css' ),
486 array( 'wp-components' )
487 );
488 $styles->add_data( 'wp-widgets', 'rtl', 'replace' );
489 }
490 add_action( 'wp_default_styles', 'gutenberg_register_packages_styles' );
491
492 /**
493 * Registers common scripts and styles to be used as dependencies of the editor
494 * and plugins.
495 *
496 * @since 0.1.0
497 */
498 function gutenberg_enqueue_block_editor_assets() {
499 if ( defined( 'GUTENBERG_LIVE_RELOAD' ) && GUTENBERG_LIVE_RELOAD ) {
500 $live_reload_url = ( GUTENBERG_LIVE_RELOAD === true ) ? 'http://localhost:35729/livereload.js' : GUTENBERG_LIVE_RELOAD;
501
502 wp_enqueue_script(
503 'gutenberg-live-reload',
504 $live_reload_url
505 );
506 }
507 }
508 add_action( 'enqueue_block_editor_assets', 'gutenberg_enqueue_block_editor_assets' );
509
510 /**
511 * Retrieves a unique and reasonably short and human-friendly filename for a
512 * vendor script based on a URL and the script handle.
513 *
514 * @param string $handle The name of the script.
515 * @param string $src Full URL of the external script.
516 *
517 * @return string Script filename suitable for local caching.
518 *
519 * @since 0.1.0
520 */
521 function gutenberg_vendor_script_filename( $handle, $src ) {
522 $filename = basename( $src );
523 $match = preg_match(
524 '/^'
525 . '(?P<ignore>.*?)'
526 . '(?P<suffix>\.min)?'
527 . '(?P<extension>\.js)'
528 . '(?P<extra>.*)'
529 . '$/',
530 $filename,
531 $filename_pieces
532 );
533
534 $prefix = $handle;
535 $suffix = $match ? $filename_pieces['suffix'] : '';
536 $hash = substr( md5( $src ), 0, 8 );
537
538 return "${prefix}${suffix}.${hash}.js";
539 }
540
541 /**
542 * Registers a vendor script from a URL, preferring a locally cached version if
543 * possible, or downloading it if the cached version is unavailable or
544 * outdated.
545 *
546 * @param WP_Scripts $scripts WP_Scripts instance.
547 * @param string $handle Name of the script.
548 * @param string $src Full URL of the external script.
549 * @param array $deps Optional. An array of registered script handles this
550 * script depends on.
551 * @param string|bool|null $ver Optional. String specifying script version number, if it has one, which is added to the URL
552 * as a query string for cache busting purposes. If version is set to false, a version
553 * number is automatically added equal to current installed WordPress version.
554 * If set to null, no version is added.
555 * @param bool $in_footer Optional. Whether to enqueue the script before </body> instead of in the <head>.
556 * Default 'false'.
557 *
558 * @since 0.1.0
559 */
560 function gutenberg_register_vendor_script( $scripts, $handle, $src, $deps = array(), $ver = null, $in_footer = false ) {
561 if ( defined( 'GUTENBERG_LOAD_VENDOR_SCRIPTS' ) && ! GUTENBERG_LOAD_VENDOR_SCRIPTS ) {
562 return;
563 }
564
565 $filename = gutenberg_vendor_script_filename( $handle, $src );
566
567 if ( defined( 'GUTENBERG_LIST_VENDOR_ASSETS' ) && GUTENBERG_LIST_VENDOR_ASSETS ) {
568 echo "$src|$filename\n";
569 return;
570 }
571
572 $full_path = gutenberg_dir_path() . 'vendor/' . $filename;
573
574 $needs_fetch = (
575 defined( 'GUTENBERG_DEVELOPMENT_MODE' ) && GUTENBERG_DEVELOPMENT_MODE && (
576 ! file_exists( $full_path ) ||
577 time() - filemtime( $full_path ) >= DAY_IN_SECONDS
578 )
579 );
580
581 if ( $needs_fetch ) {
582 // Determine whether we can write to this file. If not, don't waste
583 // time doing a network request.
584 // @codingStandardsIgnoreStart
585
586 $is_writable = is_writable( $full_path );
587 if ( $is_writable ) {
588 $f = @fopen( $full_path, 'a' );
589 if ( ! $f ) {
590 $is_writable = false;
591 } else {
592 fclose( $f );
593 }
594 }
595
596 // @codingStandardsIgnoreEnd
597 if ( ! $is_writable ) {
598 // Failed to open the file for writing, probably due to server
599 // permissions. Enqueue the script directly from the URL instead.
600 gutenberg_override_script( $scripts, $handle, $src, $deps, $ver, $in_footer );
601 return;
602 }
603
604 $response = wp_remote_get( $src );
605 if ( wp_remote_retrieve_response_code( $response ) === 200 ) {
606 $f = fopen( $full_path, 'w' );
607 fwrite( $f, wp_remote_retrieve_body( $response ) );
608 fclose( $f );
609 } elseif ( ! filesize( $full_path ) ) {
610 // The request failed. If the file is already cached, continue to
611 // use this file. If not, then unlink the 0 byte file, and enqueue
612 // the script directly from the URL.
613 gutenberg_override_script( $scripts, $handle, $src, $deps, $ver, $in_footer );
614 unlink( $full_path );
615 return;
616 }
617 }
618 gutenberg_override_script(
619 $scripts,
620 $handle,
621 gutenberg_url( 'vendor/' . $filename ),
622 $deps,
623 $ver,
624 $in_footer
625 );
626 }
627
628 /**
629 * Extends block editor settings to remove the Gutenberg's `editor-styles.css`;
630 *
631 * This can be removed when plugin support requires WordPress 5.8.0+.
632 *
633 * @param array $settings Default editor settings.
634 *
635 * @return array Filtered editor settings.
636 */
637 function gutenberg_extend_block_editor_styles( $settings ) {
638 if ( empty( $settings['styles'] ) ) {
639 $settings['styles'] = array();
640 } else {
641 /*
642 * WordPress versions prior to 5.8 include a legacy editor styles file
643 * that need to be removed.
644 * This code can be removed from the Gutenberg plugin when the supported WP
645 * version is 5.8
646 */
647 $default_styles_file = is_rtl() ?
648 ABSPATH . WPINC . '/css/dist/editor/editor-styles-rtl.css' :
649 ABSPATH . WPINC . '/css/dist/editor/editor-styles.css';
650
651 if ( file_exists( $default_styles_file ) ) {
652 $default_styles = file_get_contents(
653 $default_styles_file
654 );
655
656 /*
657 * Iterate backwards from the end of the array since the preferred
658 * insertion point in case not found is prepended as first entry.
659 */
660 for ( $i = count( $settings['styles'] ) - 1; $i >= 0; $i-- ) {
661 if ( isset( $settings['styles'][ $i ]['css'] ) &&
662 $default_styles === $settings['styles'][ $i ]['css'] ) {
663 break;
664 }
665 }
666
667 if ( isset( $i ) && $i >= 0 ) {
668 unset( $settings['styles'][ $i ] );
669 }
670 }
671 }
672
673 // Remove the default font editor styles for FSE themes.
674 if ( WP_Theme_JSON_Resolver_Gutenberg::theme_has_support() ) {
675 foreach ( $settings['styles'] as $j => $style ) {
676 if ( 0 === strpos( $style['css'], 'body { font-family:' ) ) {
677 unset( $settings['styles'][ $j ] );
678 }
679 }
680 }
681
682 return $settings;
683 }
684 // This can be removed when plugin support requires WordPress 5.8.0+.
685 if ( function_exists( 'get_block_editor_settings' ) ) {
686 add_filter( 'block_editor_settings_all', 'gutenberg_extend_block_editor_styles' );
687 } else {
688 add_filter( 'block_editor_settings', 'gutenberg_extend_block_editor_styles' );
689 }
690
691 /**
692 * Adds a flag to the editor settings to know whether we're in FSE theme or not.
693 *
694 * This can be removed when plugin support requires WordPress 5.8.0+.
695 *
696 * @param array $settings Default editor settings.
697 *
698 * @return array Filtered editor settings.
699 */
700 function gutenberg_extend_block_editor_settings_with_fse_theme_flag( $settings ) {
701 $settings['supportsTemplateMode'] = gutenberg_supports_block_templates();
702
703 // Enable the new layout options for themes with a theme.json file.
704 $settings['supportsLayout'] = WP_Theme_JSON_Resolver_Gutenberg::theme_has_support();
705
706 return $settings;
707 }
708 // This can be removed when plugin support requires WordPress 5.8.0+.
709 if ( function_exists( 'get_block_editor_settings' ) ) {
710 add_filter( 'block_editor_settings_all', 'gutenberg_extend_block_editor_settings_with_fse_theme_flag' );
711 } else {
712 add_filter( 'block_editor_settings', 'gutenberg_extend_block_editor_settings_with_fse_theme_flag' );
713 }
714
715 /**
716 * Sets the editor styles to be consumed by JS.
717 */
718 function gutenberg_extend_block_editor_styles_html() {
719 $script_handles = array();
720 $style_handles = array(
721 'wp-block-editor',
722 'wp-block-library',
723 'wp-block-library-theme',
724 'wp-edit-blocks',
725 );
726
727 $block_registry = WP_Block_Type_Registry::get_instance();
728
729 foreach ( $block_registry->get_all_registered() as $block_type ) {
730 if ( ! empty( $block_type->style ) ) {
731 $style_handles[] = $block_type->style;
732 }
733
734 if ( ! empty( $block_type->editor_style ) ) {
735 $style_handles[] = $block_type->editor_style;
736 }
737
738 if ( ! empty( $block_type->script ) ) {
739 $script_handles[] = $block_type->script;
740 }
741 }
742
743 $style_handles = array_unique( $style_handles );
744 $done = wp_styles()->done;
745
746 ob_start();
747
748 wp_styles()->done = array();
749 wp_styles()->do_items( $style_handles );
750 wp_styles()->done = $done;
751
752 $styles = ob_get_clean();
753
754 $script_handles = array_unique( $script_handles );
755 $done = wp_scripts()->done;
756
757 ob_start();
758
759 wp_scripts()->done = array();
760 wp_scripts()->do_items( $script_handles );
761 wp_scripts()->done = $done;
762
763 $scripts = ob_get_clean();
764
765 $editor_assets = wp_json_encode(
766 array(
767 'styles' => $styles,
768 'scripts' => $scripts,
769 )
770 );
771
772 echo "<script>window.__editorAssets = $editor_assets</script>";
773 }
774 add_action( 'admin_footer-toplevel_page_gutenberg-edit-site', 'gutenberg_extend_block_editor_styles_html' );
775 add_action( 'admin_footer-post.php', 'gutenberg_extend_block_editor_styles_html' );
776 add_action( 'admin_footer-post-new.php', 'gutenberg_extend_block_editor_styles_html' );
777
778 /**
779 * Adds a polyfill for object-fit in environments which do not support it.
780 *
781 * The script registration occurs in `gutenberg_register_vendor_scripts`, which
782 * should be removed in coordination with this function.
783 *
784 * Remove this when the minimum supported version is WordPress 5.7
785 *
786 * @see gutenberg_register_vendor_scripts
787 * @see https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit
788 *
789 * @since 9.1.0
790 *
791 * @param WP_Scripts $scripts WP_Scripts object.
792 */
793 function gutenberg_add_object_fit_polyfill( $scripts ) {
794 did_action( 'init' ) && $scripts->add_inline_script(
795 'wp-polyfill',
796 wp_get_script_polyfill(
797 $scripts,
798 array(
799 '"objectFit" in document.documentElement.style' => 'object-fit-polyfill',
800 )
801 )
802 );
803 }
804 add_action( 'wp_default_scripts', 'gutenberg_add_object_fit_polyfill', 20 );
805