| @@ -1,8 +1,8 @@ | ||
| 1 | 1 | <?php |
| 2 | 2 | /** |
| 3 | - * Functions to register client-side assets (scripts and stylesheets) specific | |
| 4 | - * for the Gutenberg editor plugin. | |
| 3 | + * Functions to register client-side assets (scripts and stylesheets) for the | |
| 4 | + * Gutenberg editor plugin. | |
| 5 | 5 | * |
| 6 | 6 | * @package gutenberg |
| 7 | 7 | */ |
| 8 | 8 | |
| @@ -12,27 +12,90 @@ | ||
| 12 | 12 | |
| 13 | 13 | /** |
| 14 | 14 | * Retrieves the root plugin path. |
| 15 | 15 | * |
| 16 | + * @return string Root path to the gutenberg plugin. | |
| 17 | + * | |
| 16 | 18 | * @since 0.1.0 |
| 17 | - * | |
| 18 | - * @return string Root path to the gutenberg plugin. | |
| 19 | 19 | */ |
| 20 | 20 | function gutenberg_dir_path() { |
| 21 | - return plugin_dir_path( __DIR__ ); | |
| 21 | + return plugin_dir_path( dirname( __FILE__ ) ); | |
| 22 | 22 | } |
| 23 | 23 | |
| 24 | 24 | /** |
| 25 | 25 | * Retrieves a URL to a file in the gutenberg plugin. |
| 26 | 26 | * |
| 27 | + * @param string $path Relative path of the desired file. | |
| 28 | + * | |
| 29 | + * @return string Fully qualified URL pointing to the desired file. | |
| 30 | + * | |
| 27 | 31 | * @since 0.1.0 |
| 32 | + */ | |
| 33 | +function gutenberg_url( $path ) { | |
| 34 | + return plugins_url( $path, dirname( __FILE__ ) ); | |
| 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. | |
| 28 | 42 | * |
| 29 | - * @param string $path Relative path of the desired file. | |
| 43 | + * @since 4.1.0 | |
| 30 | 44 | * |
| 31 | - * @return string Fully qualified URL pointing to the desired file. | |
| 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'. | |
| 32 | 55 | */ |
| 33 | -function gutenberg_url( $path ) { | |
| 34 | - return plugins_url( $path, __DIR__ ); | |
| 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 script, which is a dependency _of_ `wp-i18n`. | |
| 92 | + * | |
| 93 | + * See: https://core.trac.wordpress.org/ticket/46089 | |
| 94 | + */ | |
| 95 | + if ( 'wp-i18n' !== $handle && 'wp-polyfill' !== $handle ) { | |
| 96 | + $scripts->set_translations( $handle, 'default' ); | |
| 97 | + } | |
| 35 | 98 | } |
| 36 | 99 | |
| 37 | 100 | /** |
| 38 | 101 | * Filters the default translation file load behavior to load the Gutenberg |
| @@ -51,14 +114,14 @@ | ||
| 51 | 114 | return $file; |
| 52 | 115 | } |
| 53 | 116 | |
| 54 | 117 | // Ignore scripts whose handle does not have the "wp-" prefix. |
| 55 | - if ( ! str_starts_with( $handle, 'wp-' ) ) { | |
| 118 | + if ( 'wp-' !== substr( $handle, 0, 3 ) ) { | |
| 56 | 119 | return $file; |
| 57 | 120 | } |
| 58 | 121 | |
| 59 | - // Ignore scripts that are not found in the expected `build/scripts/` location. | |
| 60 | - $script_path = gutenberg_dir_path() . 'build/scripts/' . substr( $handle, 3 ) . '/index.min.js'; | |
| 122 | + // Ignore scripts that are not found in the expected `build/` location. | |
| 123 | + $script_path = gutenberg_dir_path() . 'build/' . substr( $handle, 3 ) . '/index.js'; | |
| 61 | 124 | if ( ! file_exists( $script_path ) ) { |
| 62 | 125 | return $file; |
| 63 | 126 | } |
| 64 | 127 | |
| @@ -86,404 +149,601 @@ | ||
| 86 | 149 | } |
| 87 | 150 | add_filter( 'load_script_translation_file', 'gutenberg_override_translation_file', 10, 2 ); |
| 88 | 151 | |
| 89 | 152 | /** |
| 90 | - * Adds the 'editor' dependency to wp-block-library, required by the Classic block. | |
| 153 | + * Filters the default labels for common post types to change the case style | |
| 154 | + * from capitalized (e.g. "Featured Image") to sentence-style (e.g. "Featured | |
| 155 | + * image"). | |
| 91 | 156 | * |
| 92 | - * @param WP_Scripts $scripts WP_Scripts instance. | |
| 157 | + * See: https://github.com/WordPress/gutenberg/pull/18758 | |
| 158 | + * | |
| 159 | + * @param object $labels Object with all the labels as member variables. | |
| 160 | + * | |
| 161 | + * @return object Object with all the labels, including overridden ones. | |
| 93 | 162 | */ |
| 94 | -function gutenberg_register_block_library_script_special_case( $scripts ) { | |
| 95 | - $handle = 'wp-block-library'; | |
| 96 | - $script = $scripts->query( $handle, 'registered' ); | |
| 97 | - if ( ! in_array( 'editor', $script->deps, true ) ) { | |
| 98 | - $script->deps[] = 'editor'; | |
| 163 | +function gutenberg_override_posttype_labels( $labels ) { | |
| 164 | + $labels->featured_image = __( 'Featured image', 'gutenberg' ); | |
| 165 | + return $labels; | |
| 166 | +} | |
| 167 | +foreach ( array( 'post', 'page' ) as $post_type ) { | |
| 168 | + add_filter( "post_type_labels_{$post_type}", 'gutenberg_override_posttype_labels' ); | |
| 169 | +} | |
| 170 | + | |
| 171 | +/** | |
| 172 | + * Registers a style according to `wp_register_style`. Honors this request by | |
| 173 | + * deregistering any style by the same handler before registration. | |
| 174 | + * | |
| 175 | + * @since 4.1.0 | |
| 176 | + * | |
| 177 | + * @param WP_Styles $styles WP_Styles instance. | |
| 178 | + * @param string $handle Name of the stylesheet. Should be unique. | |
| 179 | + * @param string $src Full URL of the stylesheet, or path of the stylesheet relative to the WordPress root directory. | |
| 180 | + * @param array $deps Optional. An array of registered stylesheet handles this stylesheet depends on. Default empty array. | |
| 181 | + * @param string|bool|null $ver Optional. String specifying stylesheet version number, if it has one, which is added to the URL | |
| 182 | + * as a query string for cache busting purposes. If version is set to false, a version | |
| 183 | + * number is automatically added equal to current installed WordPress version. | |
| 184 | + * If set to null, no version is added. | |
| 185 | + * @param string $media Optional. The media for which this stylesheet has been defined. | |
| 186 | + * Default 'all'. Accepts media types like 'all', 'print' and 'screen', or media queries like | |
| 187 | + * '(orientation: portrait)' and '(max-width: 640px)'. | |
| 188 | + */ | |
| 189 | +function gutenberg_override_style( $styles, $handle, $src, $deps = array(), $ver = false, $media = 'all' ) { | |
| 190 | + $style = $styles->query( $handle, 'registered' ); | |
| 191 | + if ( $style ) { | |
| 192 | + $styles->remove( $handle ); | |
| 99 | 193 | } |
| 194 | + $styles->add( $handle, $src, $deps, $ver, $media ); | |
| 100 | 195 | } |
| 101 | -add_action( 'wp_default_scripts', 'gutenberg_register_block_library_script_special_case', 11 ); | |
| 102 | 196 | |
| 103 | 197 | /** |
| 104 | - * Registers WordPress package styles with complex requirements. | |
| 198 | + * Registers vendor JavaScript files to be used as dependencies of the editor | |
| 199 | + * and plugins. | |
| 105 | 200 | * |
| 106 | - * Simple styles (main style.css with inferred dependencies) are auto-registered | |
| 107 | - * via build/styles.php at default priority (10). This function runs at priority 15 to handle: | |
| 108 | - * - Multiple style files per package (content.css, classic.css, etc.) | |
| 109 | - * - Non-WordPress dependencies (dashicons, common, forms) | |
| 110 | - * - Custom handles that don't match wp-{package} pattern | |
| 111 | - * - Conditional dependencies based on theme/settings | |
| 112 | - * - Dynamic filename logic | |
| 201 | + * This function is called from a script during the plugin build process, so it | |
| 202 | + * should not call any WordPress PHP functions. | |
| 113 | 203 | * |
| 114 | - * These override calls will replace the auto-registered versions as needed. | |
| 204 | + * @since 0.1.0 | |
| 115 | 205 | * |
| 116 | - * @since 6.7.0 | |
| 206 | + * @param WP_Scripts $scripts WP_Scripts instance. | |
| 207 | + */ | |
| 208 | +function gutenberg_register_vendor_scripts( $scripts ) { | |
| 209 | + $suffix = SCRIPT_DEBUG ? '' : '.min'; | |
| 210 | + | |
| 211 | + /* | |
| 212 | + * This script registration and the corresponding function should be removed | |
| 213 | + * once the plugin is updated to support WordPress 5.4.0 and newer. | |
| 214 | + * | |
| 215 | + * See: `gutenberg_add_url_polyfill` | |
| 216 | + */ | |
| 217 | + gutenberg_register_vendor_script( | |
| 218 | + $scripts, | |
| 219 | + 'wp-polyfill-url', | |
| 220 | + 'https://unpkg.com/core-js-url-browser@3.6.4/url' . $suffix . '.js', | |
| 221 | + array(), | |
| 222 | + '3.6.4' | |
| 223 | + ); | |
| 224 | + | |
| 225 | + /* | |
| 226 | + * This script registration and the corresponding function should be removed | |
| 227 | + * removed once the plugin is updated to support WordPress 5.4.0 and newer. | |
| 228 | + * | |
| 229 | + * See: `gutenberg_add_dom_rect_polyfill` | |
| 230 | + */ | |
| 231 | + gutenberg_register_vendor_script( | |
| 232 | + $scripts, | |
| 233 | + 'wp-polyfill-dom-rect', | |
| 234 | + 'https://unpkg.com/polyfill-library@3.42.0/polyfills/DOMRect/polyfill.js', | |
| 235 | + array(), | |
| 236 | + '3.42.0' | |
| 237 | + ); | |
| 238 | +} | |
| 239 | +add_action( 'wp_default_scripts', 'gutenberg_register_vendor_scripts' ); | |
| 240 | + | |
| 241 | +/** | |
| 242 | + * Registers all the WordPress packages scripts that are in the standardized | |
| 243 | + * `build/` location. | |
| 117 | 244 | * |
| 118 | - * @global array $editor_styles | |
| 245 | + * @since 4.5.0 | |
| 119 | 246 | * |
| 120 | - * @param WP_Styles $styles WP_Styles instance. | |
| 247 | + * @param WP_Scripts $scripts WP_Scripts instance. | |
| 121 | 248 | */ |
| 122 | -function gutenberg_register_packages_styles( $styles ) { | |
| 123 | - // When in production, use the plugin's version as the asset version; | |
| 124 | - // else (for development or test) default to use the current time. | |
| 125 | - $version = defined( 'GUTENBERG_VERSION' ) && ! SCRIPT_DEBUG ? GUTENBERG_VERSION : time(); | |
| 126 | - $suffix = SCRIPT_DEBUG ? '' : '.min'; | |
| 249 | +function gutenberg_register_packages_scripts( $scripts ) { | |
| 250 | + foreach ( glob( gutenberg_dir_path() . 'build/*/index.js' ) as $path ) { | |
| 251 | + // Prefix `wp-` to package directory to get script handle. | |
| 252 | + // For example, `…/build/a11y/index.js` becomes `wp-a11y`. | |
| 253 | + $handle = 'wp-' . basename( dirname( $path ) ); | |
| 127 | 254 | |
| 128 | - // wp-components: add dashicons (icon font dependency) and design tokens. | |
| 129 | - $components_style = $styles->query( 'wp-components', 'registered' ); | |
| 130 | - $components_style->deps[] = 'dashicons'; | |
| 131 | - $components_style->deps[] = 'wp-theme'; | |
| 255 | + // Replace `.js` extension with `.asset.php` to find the generated dependencies file. | |
| 256 | + $asset_file = substr( $path, 0, -3 ) . '.asset.php'; | |
| 257 | + $asset = file_exists( $asset_file ) | |
| 258 | + ? require( $asset_file ) | |
| 259 | + : null; | |
| 260 | + $dependencies = isset( $asset['dependencies'] ) ? $asset['dependencies'] : array(); | |
| 261 | + $version = isset( $asset['version'] ) ? $asset['version'] : filemtime( $path ); | |
| 132 | 262 | |
| 133 | - // wp-edit-post: add wp-edit-blocks (custom handle not auto-inferred) | |
| 134 | - $styles->query( 'wp-edit-post', 'registered' )->deps[] = 'wp-edit-blocks'; | |
| 263 | + // Add dependencies that cannot be detected and generated by build tools. | |
| 264 | + switch ( $handle ) { | |
| 265 | + case 'wp-block-library': | |
| 266 | + array_push( $dependencies, 'editor' ); | |
| 267 | + break; | |
| 135 | 268 | |
| 136 | - // wp-edit-site: add core WP styles and custom handles | |
| 137 | - $edit_site_style = $styles->query( 'wp-edit-site', 'registered' ); | |
| 138 | - $edit_site_style->deps[] = 'common'; | |
| 139 | - $edit_site_style->deps[] = 'forms'; | |
| 140 | - $edit_site_style->deps[] = 'wp-block-library-editor'; | |
| 269 | + case 'wp-edit-post': | |
| 270 | + array_push( $dependencies, 'media-models', 'media-views', 'postbox' ); | |
| 271 | + break; | |
| 141 | 272 | |
| 142 | - // wp-edit-widgets: add wp-edit-blocks (custom handle not auto-inferred) | |
| 143 | - $styles->query( 'wp-edit-widgets', 'registered' )->deps[] = 'wp-edit-blocks'; | |
| 273 | + case 'wp-edit-site': | |
| 274 | + array_push( $dependencies, 'wp-dom-ready' ); | |
| 275 | + break; | |
| 276 | + } | |
| 144 | 277 | |
| 145 | - // wp-customize-widgets: add wp-edit-blocks (custom handle not auto-inferred) | |
| 146 | - $styles->query( 'wp-customize-widgets', 'registered' )->deps[] = 'wp-edit-blocks'; | |
| 278 | + // Get the path from Gutenberg directory as expected by `gutenberg_url`. | |
| 279 | + $gutenberg_path = substr( $path, strlen( gutenberg_dir_path() ) ); | |
| 147 | 280 | |
| 281 | + gutenberg_override_script( | |
| 282 | + $scripts, | |
| 283 | + $handle, | |
| 284 | + gutenberg_url( $gutenberg_path ), | |
| 285 | + $dependencies, | |
| 286 | + $version, | |
| 287 | + true | |
| 288 | + ); | |
| 289 | + } | |
| 290 | +} | |
| 291 | +add_action( 'wp_default_scripts', 'gutenberg_register_packages_scripts' ); | |
| 292 | + | |
| 293 | +/** | |
| 294 | + * Registers all the WordPress packages styles that are in the standardized | |
| 295 | + * `build/` location. | |
| 296 | + * | |
| 297 | + * @since 6.7.0 | |
| 298 | + | |
| 299 | + * @param WP_Styles $styles WP_Styles instance. | |
| 300 | + */ | |
| 301 | +function gutenberg_register_packages_styles( $styles ) { | |
| 302 | + // Editor Styles. | |
| 148 | 303 | gutenberg_override_style( |
| 149 | 304 | $styles, |
| 150 | - 'wp-theme', | |
| 151 | - gutenberg_url( 'build/styles/theme/design-tokens' . $suffix . '.css' ), | |
| 152 | - array(), | |
| 153 | - $version | |
| 305 | + 'wp-block-editor', | |
| 306 | + gutenberg_url( 'build/block-editor/style.css' ), | |
| 307 | + array( 'wp-components', 'wp-editor-font' ), | |
| 308 | + filemtime( gutenberg_dir_path() . 'build/editor/style.css' ) | |
| 154 | 309 | ); |
| 155 | - $styles->add_data( 'wp-theme', 'rtl', 'replace' ); | |
| 156 | - $styles->add_data( 'wp-theme', 'suffix', $suffix ); | |
| 157 | - $styles->add_data( 'wp-theme', 'path', gutenberg_dir_path() . 'build/styles/theme/design-tokens' . $suffix . '.css' ); | |
| 310 | + $styles->add_data( 'wp-block-editor', 'rtl', 'replace' ); | |
| 158 | 311 | |
| 159 | - // Register wp-base-styles and add it to the already registered wp-admin stylesheet | |
| 160 | 312 | gutenberg_override_style( |
| 161 | 313 | $styles, |
| 162 | - 'wp-base-styles', | |
| 163 | - gutenberg_url( 'build/styles/base-styles/admin-schemes' . $suffix . '.css' ), | |
| 164 | - array(), | |
| 165 | - $version | |
| 314 | + 'wp-editor', | |
| 315 | + gutenberg_url( 'build/editor/style.css' ), | |
| 316 | + array( 'wp-components', 'wp-block-editor', 'wp-nux' ), | |
| 317 | + filemtime( gutenberg_dir_path() . 'build/editor/style.css' ) | |
| 166 | 318 | ); |
| 167 | - $styles->add_data( 'wp-base-styles', 'rtl', 'replace' ); | |
| 168 | - $styles->add_data( 'wp-base-styles', 'suffix', $suffix ); | |
| 169 | - $styles->add_data( 'wp-base-styles', 'path', gutenberg_dir_path() . 'build/styles/base-styles/admin-schemes' . $suffix . '.css' ); | |
| 170 | - $styles->query( 'wp-admin', 'registered' )->deps[] = 'wp-base-styles'; | |
| 319 | + $styles->add_data( 'wp-editor', 'rtl', 'replace' ); | |
| 171 | 320 | |
| 172 | 321 | gutenberg_override_style( |
| 173 | 322 | $styles, |
| 174 | - 'wp-block-editor-content', | |
| 175 | - gutenberg_url( 'build/styles/block-editor/content' . $suffix . '.css' ), | |
| 176 | - array( 'wp-components' ), | |
| 177 | - $version | |
| 323 | + 'wp-edit-post', | |
| 324 | + gutenberg_url( 'build/edit-post/style.css' ), | |
| 325 | + array( 'wp-components', 'wp-block-editor', 'wp-editor', 'wp-edit-blocks', 'wp-block-library', 'wp-nux' ), | |
| 326 | + filemtime( gutenberg_dir_path() . 'build/edit-post/style.css' ) | |
| 178 | 327 | ); |
| 179 | - $styles->add_data( 'wp-block-editor-content', 'rtl', 'replace' ); | |
| 180 | - $styles->add_data( 'wp-block-editor-content', 'suffix', $suffix ); | |
| 328 | + $styles->add_data( 'wp-edit-post', 'rtl', 'replace' ); | |
| 181 | 329 | |
| 182 | - $block_library_filename = wp_should_load_separate_core_block_assets() ? 'common' : 'style'; | |
| 183 | 330 | gutenberg_override_style( |
| 184 | 331 | $styles, |
| 332 | + 'wp-components', | |
| 333 | + gutenberg_url( 'build/components/style.css' ), | |
| 334 | + array(), | |
| 335 | + filemtime( gutenberg_dir_path() . 'build/components/style.css' ) | |
| 336 | + ); | |
| 337 | + $styles->add_data( 'wp-components', 'rtl', 'replace' ); | |
| 338 | + | |
| 339 | + gutenberg_override_style( | |
| 340 | + $styles, | |
| 185 | 341 | 'wp-block-library', |
| 186 | - gutenberg_url( 'build/styles/block-library/' . $block_library_filename . $suffix . '.css' ), | |
| 342 | + gutenberg_url( 'build/block-library/style.css' ), | |
| 187 | 343 | array(), |
| 188 | - $version | |
| 344 | + filemtime( gutenberg_dir_path() . 'build/block-library/style.css' ) | |
| 189 | 345 | ); |
| 190 | 346 | $styles->add_data( 'wp-block-library', 'rtl', 'replace' ); |
| 191 | - $styles->add_data( 'wp-block-library', 'suffix', $suffix ); | |
| 192 | - $styles->add_data( 'wp-block-library', 'path', gutenberg_dir_path() . 'build/styles/block-library/' . $block_library_filename . $suffix . '.css' ); | |
| 193 | 347 | |
| 194 | - // Only add CONTENT styles here that should be enqueued in the iframe! | |
| 195 | - $wp_edit_blocks_dependencies = array( | |
| 196 | - // Design System tokens load first so the `:root` CSS custom | |
| 197 | - // properties are defined before any consuming stylesheet reads | |
| 198 | - // them inside the editor iframe. | |
| 199 | - 'wp-theme', | |
| 200 | - 'wp-components', | |
| 201 | - // This need to be added before the block library styles, | |
| 202 | - // The block library styles override the "reset" styles. | |
| 203 | - 'wp-reset-editor-styles', | |
| 204 | - 'wp-block-library', | |
| 205 | - // Until #37466, we can't specifically add them as editor styles yet, | |
| 206 | - // so we must hard-code it here as a dependency. | |
| 207 | - 'wp-block-editor-content', | |
| 208 | - 'wp-base-styles', | |
| 348 | + gutenberg_override_style( | |
| 349 | + $styles, | |
| 350 | + 'wp-format-library', | |
| 351 | + gutenberg_url( 'build/format-library/style.css' ), | |
| 352 | + array( 'wp-block-editor', 'wp-components' ), | |
| 353 | + filemtime( gutenberg_dir_path() . 'build/format-library/style.css' ) | |
| 209 | 354 | ); |
| 355 | + $styles->add_data( 'wp-format-library', 'rtl', 'replace' ); | |
| 210 | 356 | |
| 211 | - // Only load the default layout and margin styles for themes without theme.json file. | |
| 212 | - if ( ! wp_theme_has_theme_json() ) { | |
| 213 | - $wp_edit_blocks_dependencies[] = 'wp-editor-classic-layout-styles'; | |
| 214 | - } | |
| 357 | + gutenberg_override_style( | |
| 358 | + $styles, | |
| 359 | + 'wp-edit-blocks', | |
| 360 | + gutenberg_url( 'build/block-library/editor.css' ), | |
| 361 | + array( | |
| 362 | + 'wp-components', | |
| 363 | + 'wp-editor', | |
| 364 | + 'wp-block-library', | |
| 365 | + // Always include visual styles so the editor never appears broken. | |
| 366 | + 'wp-block-library-theme', | |
| 367 | + ), | |
| 368 | + filemtime( gutenberg_dir_path() . 'build/block-library/editor.css' ) | |
| 369 | + ); | |
| 370 | + $styles->add_data( 'wp-edit-blocks', 'rtl', 'replace' ); | |
| 215 | 371 | |
| 216 | - global $editor_styles; | |
| 217 | - if ( current_theme_supports( 'wp-block-styles' ) && ( ! is_array( $editor_styles ) || count( $editor_styles ) === 0 ) ) { | |
| 218 | - // Include opinionated block styles if the theme supports block styles and no $editor_styles are declared, so the editor never appears broken. | |
| 219 | - $wp_edit_blocks_dependencies[] = 'wp-block-library-theme'; | |
| 220 | - } | |
| 372 | + gutenberg_override_style( | |
| 373 | + $styles, | |
| 374 | + 'wp-nux', | |
| 375 | + gutenberg_url( 'build/nux/style.css' ), | |
| 376 | + array( 'wp-components' ), | |
| 377 | + filemtime( gutenberg_dir_path() . 'build/nux/style.css' ) | |
| 378 | + ); | |
| 379 | + $styles->add_data( 'wp-nux', 'rtl', 'replace' ); | |
| 221 | 380 | |
| 222 | 381 | gutenberg_override_style( |
| 223 | 382 | $styles, |
| 224 | - 'wp-reset-editor-styles', | |
| 225 | - gutenberg_url( 'build/styles/block-library/reset' . $suffix . '.css' ), | |
| 226 | - array( 'common', 'forms' ), // Make sure the reset is loaded after the default WP Admin styles. | |
| 227 | - $version | |
| 383 | + 'wp-block-library-theme', | |
| 384 | + gutenberg_url( 'build/block-library/theme.css' ), | |
| 385 | + array(), | |
| 386 | + filemtime( gutenberg_dir_path() . 'build/block-library/theme.css' ) | |
| 228 | 387 | ); |
| 229 | - $styles->add_data( 'wp-reset-editor-styles', 'rtl', 'replace' ); | |
| 230 | - $styles->add_data( 'wp-reset-editor-styles', 'suffix', $suffix ); | |
| 388 | + $styles->add_data( 'wp-block-library-theme', 'rtl', 'replace' ); | |
| 231 | 389 | |
| 232 | 390 | gutenberg_override_style( |
| 233 | 391 | $styles, |
| 234 | - 'wp-editor-classic-layout-styles', | |
| 235 | - gutenberg_url( 'build/styles/edit-post/classic' . $suffix . '.css' ), | |
| 236 | - array(), | |
| 237 | - $version | |
| 392 | + 'wp-list-reusable-blocks', | |
| 393 | + gutenberg_url( 'build/list-reusable-blocks/style.css' ), | |
| 394 | + array( 'wp-components' ), | |
| 395 | + filemtime( gutenberg_dir_path() . 'build/list-reusable-blocks/style.css' ) | |
| 238 | 396 | ); |
| 239 | - $styles->add_data( 'wp-editor-classic-layout-styles', 'rtl', 'replace' ); | |
| 240 | - $styles->add_data( 'wp-editor-classic-layout-styles', 'suffix', $suffix ); | |
| 397 | + $styles->add_data( 'wp-list-reusable-block', 'rtl', 'replace' ); | |
| 241 | 398 | |
| 242 | 399 | gutenberg_override_style( |
| 243 | 400 | $styles, |
| 244 | - 'wp-block-library-editor', | |
| 245 | - gutenberg_url( 'build/styles/block-library/editor' . $suffix . '.css' ), | |
| 246 | - array(), | |
| 247 | - $version | |
| 401 | + 'wp-edit-navigation', | |
| 402 | + gutenberg_url( 'build/edit-navigation/style.css' ), | |
| 403 | + array( 'wp-components', 'wp-block-editor', 'wp-edit-blocks' ), | |
| 404 | + filemtime( gutenberg_dir_path() . 'build/edit-navigation/style.css' ) | |
| 248 | 405 | ); |
| 249 | - $styles->add_data( 'wp-block-library-editor', 'rtl', 'replace' ); | |
| 250 | - $styles->add_data( 'wp-block-library-editor', 'suffix', $suffix ); | |
| 406 | + $styles->add_data( 'wp-edit-navigation', 'rtl', 'replace' ); | |
| 251 | 407 | |
| 252 | 408 | gutenberg_override_style( |
| 253 | 409 | $styles, |
| 254 | - 'wp-edit-blocks', | |
| 255 | - gutenberg_url( 'build/styles/block-library/editor' . $suffix . '.css' ), | |
| 256 | - $wp_edit_blocks_dependencies, | |
| 257 | - $version | |
| 410 | + 'wp-edit-site', | |
| 411 | + gutenberg_url( 'build/edit-site/style.css' ), | |
| 412 | + array( 'wp-components', 'wp-block-editor', 'wp-edit-blocks' ), | |
| 413 | + filemtime( gutenberg_dir_path() . 'build/edit-site/style.css' ) | |
| 258 | 414 | ); |
| 259 | - $styles->add_data( 'wp-edit-blocks', 'rtl', 'replace' ); | |
| 260 | - $styles->add_data( 'wp-edit-blocks', 'suffix', $suffix ); | |
| 415 | + $styles->add_data( 'wp-edit-site', 'rtl', 'replace' ); | |
| 261 | 416 | |
| 262 | 417 | gutenberg_override_style( |
| 263 | 418 | $styles, |
| 264 | - 'wp-block-library-theme', | |
| 265 | - gutenberg_url( 'build/styles/block-library/theme' . $suffix . '.css' ), | |
| 266 | - array(), | |
| 267 | - $version | |
| 419 | + 'wp-edit-widgets', | |
| 420 | + gutenberg_url( 'build/edit-widgets/style.css' ), | |
| 421 | + array( 'wp-components', 'wp-block-editor', 'wp-edit-blocks' ), | |
| 422 | + filemtime( gutenberg_dir_path() . 'build/edit-widgets/style.css' ) | |
| 268 | 423 | ); |
| 269 | - $styles->add_data( 'wp-block-library-theme', 'rtl', 'replace' ); | |
| 270 | - $styles->add_data( 'wp-block-library-theme', 'suffix', $suffix ); | |
| 424 | + $styles->add_data( 'wp-edit-widgets', 'rtl', 'replace' ); | |
| 271 | 425 | |
| 272 | 426 | gutenberg_override_style( |
| 273 | 427 | $styles, |
| 274 | - 'classic-theme-styles', | |
| 275 | - gutenberg_url( 'build/styles/block-library/classic' . $suffix . '.css' ), | |
| 276 | - array(), | |
| 277 | - $version | |
| 428 | + 'wp-block-directory', | |
| 429 | + gutenberg_url( 'build/block-directory/style.css' ), | |
| 430 | + array( 'wp-block-editor', 'wp-components' ), | |
| 431 | + filemtime( gutenberg_dir_path() . 'build/block-directory/style.css' ) | |
| 278 | 432 | ); |
| 279 | - $styles->add_data( 'classic-theme-styles', 'rtl', 'replace' ); | |
| 280 | - $styles->add_data( 'classic-theme-styles', 'suffix', $suffix ); | |
| 281 | - $styles->add_data( 'classic-theme-styles', 'path', gutenberg_dir_path() . 'build/styles/block-library/classic' . $suffix . '.css' ); | |
| 433 | + $styles->add_data( 'wp-block-directory', 'rtl', 'replace' ); | |
| 282 | 434 | } |
| 283 | -add_action( 'wp_default_styles', 'gutenberg_register_packages_styles', 15 ); | |
| 435 | +add_action( 'wp_default_styles', 'gutenberg_register_packages_styles' ); | |
| 284 | 436 | |
| 285 | 437 | /** |
| 286 | - * Fetches, processes and compiles stored core styles, then combines and renders them to the page. | |
| 287 | - * Styles are stored via the Style Engine API. | |
| 438 | + * Registers common scripts and styles to be used as dependencies of the editor | |
| 439 | + * and plugins. | |
| 288 | 440 | * |
| 289 | - * This hook also exists, and should be backported to Core in future versions. | |
| 290 | - * However, it is envisaged that Gutenberg will continue to use the Style Engine's `gutenberg_*` functions and `_Gutenberg` classes to aid continuous development. | |
| 441 | + * @since 0.1.0 | |
| 442 | + */ | |
| 443 | +function gutenberg_enqueue_block_editor_assets() { | |
| 444 | + if ( defined( 'GUTENBERG_LIVE_RELOAD' ) && GUTENBERG_LIVE_RELOAD ) { | |
| 445 | + $live_reload_url = ( GUTENBERG_LIVE_RELOAD === true ) ? 'http://localhost:35729/livereload.js' : GUTENBERG_LIVE_RELOAD; | |
| 446 | + | |
| 447 | + wp_enqueue_script( | |
| 448 | + 'gutenberg-live-reload', | |
| 449 | + $live_reload_url | |
| 450 | + ); | |
| 451 | + } | |
| 452 | +} | |
| 453 | +add_action( 'enqueue_block_editor_assets', 'gutenberg_enqueue_block_editor_assets' ); | |
| 454 | + | |
| 455 | +/** | |
| 456 | + * Retrieves a unique and reasonably short and human-friendly filename for a | |
| 457 | + * vendor script based on a URL and the script handle. | |
| 291 | 458 | * |
| 292 | - * @since 6.1 | |
| 459 | + * @param string $handle The name of the script. | |
| 460 | + * @param string $src Full URL of the external script. | |
| 293 | 461 | * |
| 294 | - * @link https://developer.wordpress.org/block-editor/reference-guides/packages/packages-style-engine/ | |
| 462 | + * @return string Script filename suitable for local caching. | |
| 295 | 463 | * |
| 296 | - * @param array $options { | |
| 297 | - * Optional. An array of options to pass to gutenberg_style_engine_get_stylesheet_from_context(). Default empty array. | |
| 464 | + * @since 0.1.0 | |
| 465 | + */ | |
| 466 | +function gutenberg_vendor_script_filename( $handle, $src ) { | |
| 467 | + $filename = basename( $src ); | |
| 468 | + $match = preg_match( | |
| 469 | + '/^' | |
| 470 | + . '(?P<ignore>.*?)' | |
| 471 | + . '(?P<suffix>\.min)?' | |
| 472 | + . '(?P<extension>\.js)' | |
| 473 | + . '(?P<extra>.*)' | |
| 474 | + . '$/', | |
| 475 | + $filename, | |
| 476 | + $filename_pieces | |
| 477 | + ); | |
| 478 | + | |
| 479 | + $prefix = $handle; | |
| 480 | + $suffix = $match ? $filename_pieces['suffix'] : ''; | |
| 481 | + $hash = substr( md5( $src ), 0, 8 ); | |
| 482 | + | |
| 483 | + return "${prefix}${suffix}.${hash}.js"; | |
| 484 | +} | |
| 485 | + | |
| 486 | +/** | |
| 487 | + * Registers a vendor script from a URL, preferring a locally cached version if | |
| 488 | + * possible, or downloading it if the cached version is unavailable or | |
| 489 | + * outdated. | |
| 298 | 490 | * |
| 299 | - * @type bool $optimize Whether to optimize the CSS output, e.g., combine rules. Default is `false`. | |
| 300 | - * @type bool $prettify Whether to add new lines and indents to output. Default is the test of whether the global constant `SCRIPT_DEBUG` is defined. | |
| 301 | - * } | |
| 491 | + * @param WP_Scripts $scripts WP_Scripts instance. | |
| 492 | + * @param string $handle Name of the script. | |
| 493 | + * @param string $src Full URL of the external script. | |
| 494 | + * @param array $deps Optional. An array of registered script handles this | |
| 495 | + * script depends on. | |
| 496 | + * @param string|bool|null $ver Optional. String specifying script version number, if it has one, which is added to the URL | |
| 497 | + * as a query string for cache busting purposes. If version is set to false, a version | |
| 498 | + * number is automatically added equal to current installed WordPress version. | |
| 499 | + * If set to null, no version is added. | |
| 500 | + * @param bool $in_footer Optional. Whether to enqueue the script before </body> instead of in the <head>. | |
| 501 | + * Default 'false'. | |
| 302 | 502 | * |
| 303 | - * @return void | |
| 503 | + * @since 0.1.0 | |
| 304 | 504 | */ |
| 305 | -function gutenberg_enqueue_stored_styles( $options = array() ) { | |
| 306 | - $is_block_theme = wp_is_block_theme(); | |
| 307 | - $is_classic_theme = ! $is_block_theme; | |
| 308 | - | |
| 309 | - /* | |
| 310 | - * For block themes, print stored styles in the header. | |
| 311 | - * For classic themes, in the footer. | |
| 312 | - */ | |
| 313 | - if ( | |
| 314 | - ( $is_block_theme && doing_action( 'wp_footer' ) ) || | |
| 315 | - ( $is_classic_theme && doing_action( 'wp_enqueue_scripts' ) ) | |
| 316 | - ) { | |
| 505 | +function gutenberg_register_vendor_script( $scripts, $handle, $src, $deps = array(), $ver = null, $in_footer = false ) { | |
| 506 | + if ( defined( 'GUTENBERG_LOAD_VENDOR_SCRIPTS' ) && ! GUTENBERG_LOAD_VENDOR_SCRIPTS ) { | |
| 317 | 507 | return; |
| 318 | 508 | } |
| 319 | 509 | |
| 320 | - $core_styles_keys = array( 'block-supports' ); | |
| 321 | - $compiled_core_stylesheet = ''; | |
| 322 | - $style_tag_id = 'core'; | |
| 323 | - foreach ( $core_styles_keys as $style_key ) { | |
| 324 | - // Adds comment if code is prettified to identify core styles sections in debugging. | |
| 325 | - $should_prettify = isset( $options['prettify'] ) ? true === $options['prettify'] : SCRIPT_DEBUG; | |
| 326 | - if ( $should_prettify ) { | |
| 327 | - $compiled_core_stylesheet .= "/**\n * Core styles: $style_key\n */\n"; | |
| 328 | - } | |
| 329 | - // Chains core store ids to signify what the styles contain. | |
| 330 | - $style_tag_id .= '-' . $style_key; | |
| 331 | - $compiled_core_stylesheet .= gutenberg_style_engine_get_stylesheet_from_context( $style_key, $options ); | |
| 332 | - } | |
| 510 | + $filename = gutenberg_vendor_script_filename( $handle, $src ); | |
| 333 | 511 | |
| 334 | - // Combines Core styles. | |
| 335 | - if ( ! empty( $compiled_core_stylesheet ) ) { | |
| 336 | - wp_register_style( $style_tag_id, false, array(), true ); | |
| 337 | - wp_add_inline_style( $style_tag_id, $compiled_core_stylesheet ); | |
| 338 | - wp_enqueue_style( $style_tag_id ); | |
| 512 | + if ( defined( 'GUTENBERG_LIST_VENDOR_ASSETS' ) && GUTENBERG_LIST_VENDOR_ASSETS ) { | |
| 513 | + echo "$src|$filename\n"; | |
| 514 | + return; | |
| 339 | 515 | } |
| 340 | 516 | |
| 341 | - // If there are any other stores registered by themes etc., print them out. | |
| 342 | - $additional_stores = WP_Style_Engine_CSS_Rules_Store_Gutenberg::get_stores(); | |
| 517 | + $full_path = gutenberg_dir_path() . 'vendor/' . $filename; | |
| 343 | 518 | |
| 344 | - /* | |
| 345 | - * Since the corresponding action hook in Core is removed below, | |
| 346 | - * this function should still honour any styles stored using the Core Style Engine store. | |
| 347 | - */ | |
| 348 | - if ( class_exists( 'WP_Style_Engine_CSS_Rules_Store' ) ) { | |
| 349 | - $additional_stores = array_merge( $additional_stores, WP_Style_Engine_CSS_Rules_Store::get_stores() ); | |
| 350 | - } | |
| 519 | + $needs_fetch = ( | |
| 520 | + defined( 'GUTENBERG_DEVELOPMENT_MODE' ) && GUTENBERG_DEVELOPMENT_MODE && ( | |
| 521 | + ! file_exists( $full_path ) || | |
| 522 | + time() - filemtime( $full_path ) >= DAY_IN_SECONDS | |
| 523 | + ) | |
| 524 | + ); | |
| 351 | 525 | |
| 352 | - foreach ( array_keys( $additional_stores ) as $store_name ) { | |
| 353 | - if ( in_array( $store_name, $core_styles_keys, true ) ) { | |
| 354 | - continue; | |
| 526 | + if ( $needs_fetch ) { | |
| 527 | + // Determine whether we can write to this file. If not, don't waste | |
| 528 | + // time doing a network request. | |
| 529 | + // @codingStandardsIgnoreStart | |
| 530 | + $f = @fopen( $full_path, 'a' ); | |
| 531 | + // @codingStandardsIgnoreEnd | |
| 532 | + if ( ! $f ) { | |
| 533 | + // Failed to open the file for writing, probably due to server | |
| 534 | + // permissions. Enqueue the script directly from the URL instead. | |
| 535 | + gutenberg_override_script( $scripts, $handle, $src, $deps, $ver, $in_footer ); | |
| 536 | + return; | |
| 355 | 537 | } |
| 356 | - $styles = gutenberg_style_engine_get_stylesheet_from_context( $store_name, $options ); | |
| 357 | - if ( ! empty( $styles ) ) { | |
| 358 | - $key = "wp-style-engine-$store_name"; | |
| 359 | - wp_register_style( $key, false, array(), true ); | |
| 360 | - wp_add_inline_style( $key, $styles ); | |
| 361 | - wp_enqueue_style( $key ); | |
| 538 | + fclose( $f ); | |
| 539 | + $response = wp_remote_get( $src ); | |
| 540 | + if ( wp_remote_retrieve_response_code( $response ) === 200 ) { | |
| 541 | + $f = fopen( $full_path, 'w' ); | |
| 542 | + fwrite( $f, wp_remote_retrieve_body( $response ) ); | |
| 543 | + fclose( $f ); | |
| 544 | + } elseif ( ! filesize( $full_path ) ) { | |
| 545 | + // The request failed. If the file is already cached, continue to | |
| 546 | + // use this file. If not, then unlink the 0 byte file, and enqueue | |
| 547 | + // the script directly from the URL. | |
| 548 | + gutenberg_override_script( $scripts, $handle, $src, $deps, $ver, $in_footer ); | |
| 549 | + unlink( $full_path ); | |
| 550 | + return; | |
| 362 | 551 | } |
| 363 | 552 | } |
| 553 | + gutenberg_override_script( | |
| 554 | + $scripts, | |
| 555 | + $handle, | |
| 556 | + gutenberg_url( 'vendor/' . $filename ), | |
| 557 | + $deps, | |
| 558 | + $ver, | |
| 559 | + $in_footer | |
| 560 | + ); | |
| 364 | 561 | } |
| 365 | 562 | |
| 366 | 563 | /** |
| 367 | - * Registers vendor JavaScript files to be used as dependencies of the editor | |
| 368 | - * and plugins. | |
| 564 | + * Extends block editor settings to include Gutenberg's `editor-styles.css` as | |
| 565 | + * taking precedent those styles shipped with core. | |
| 369 | 566 | * |
| 370 | - * This function is called from a script during the plugin build process, so it | |
| 371 | - * should not call any WordPress PHP functions. | |
| 567 | + * @param array $settings Default editor settings. | |
| 372 | 568 | * |
| 373 | - * @since 13.0 | |
| 374 | - * | |
| 375 | - * @param WP_Scripts $scripts WP_Scripts instance. | |
| 569 | + * @return array Filtered editor settings. | |
| 376 | 570 | */ |
| 377 | -function gutenberg_register_vendor_scripts( $scripts ) { | |
| 378 | - $extension = SCRIPT_DEBUG ? '.js' : '.min.js'; | |
| 379 | - $vendors_dir = gutenberg_dir_path() . 'build/scripts/vendors/'; | |
| 571 | +function gutenberg_extend_block_editor_styles( $settings ) { | |
| 572 | + $editor_styles_file = gutenberg_dir_path() . 'build/editor/editor-styles.css'; | |
| 380 | 573 | |
| 381 | - // When the React 19 experiment is enabled, register React 19 vendor | |
| 382 | - // scripts under the `react`, `react-dom`, and `react-jsx-runtime` handles. | |
| 383 | - $use_react_19 = gutenberg_is_experiment_enabled( 'gutenberg-react-19' ); | |
| 574 | + /* | |
| 575 | + * If, for whatever reason, the built editor styles do not exist, avoid | |
| 576 | + * override and fall back to the default. | |
| 577 | + */ | |
| 578 | + if ( ! file_exists( $editor_styles_file ) ) { | |
| 579 | + return $settings; | |
| 580 | + } | |
| 384 | 581 | |
| 385 | - $vendor_handles = array( 'react', 'react-dom', 'react-jsx-runtime' ); | |
| 582 | + if ( empty( $settings['styles'] ) ) { | |
| 583 | + $settings['styles'] = array(); | |
| 584 | + } else { | |
| 585 | + /* | |
| 586 | + * The styles setting is an array of CSS strings, so there is no direct | |
| 587 | + * way to find the default styles. To maximize stability, load (again) | |
| 588 | + * the default styles from disk and find its place in the array. | |
| 589 | + * | |
| 590 | + * See: https://github.com/WordPress/wordpress-develop/blob/5.0.3/src/wp-admin/edit-form-blocks.php#L168-L175 | |
| 591 | + */ | |
| 386 | 592 | |
| 387 | - foreach ( $vendor_handles as $handle ) { | |
| 388 | - $source = $use_react_19 ? $handle . '-19' : $handle; | |
| 389 | - $asset_file = $vendors_dir . $source . '.min.asset.php'; | |
| 390 | - $asset = file_exists( $asset_file ) ? require $asset_file : array(); | |
| 391 | - $dependencies = $asset['dependencies'] ?? array(); | |
| 392 | - $version = $asset['version'] ?? '0'; | |
| 593 | + $default_styles = file_get_contents( | |
| 594 | + ABSPATH . WPINC . '/css/dist/editor/editor-styles.css' | |
| 595 | + ); | |
| 393 | 596 | |
| 394 | - gutenberg_override_script( | |
| 395 | - $scripts, | |
| 396 | - $handle, | |
| 397 | - gutenberg_url( 'build/scripts/vendors/' . $source . $extension ), | |
| 398 | - $dependencies, | |
| 399 | - $version | |
| 400 | - ); | |
| 597 | + /* | |
| 598 | + * Iterate backwards from the end of the array since the preferred | |
| 599 | + * insertion point in case not found is prepended as first entry. | |
| 600 | + */ | |
| 601 | + for ( $i = count( $settings['styles'] ) - 1; $i >= 0; $i-- ) { | |
| 602 | + if ( isset( $settings['styles'][ $i ]['css'] ) && | |
| 603 | + $default_styles === $settings['styles'][ $i ]['css'] ) { | |
| 604 | + break; | |
| 605 | + } | |
| 606 | + } | |
| 401 | 607 | } |
| 402 | 608 | |
| 403 | - // WordPress Core in `wp_register_development_scripts` sets `wp-react-refresh-entry` | |
| 404 | - // as a dependency to `react` when `SCRIPT_DEBUG` is true. Preserve that here. | |
| 405 | - if ( SCRIPT_DEBUG ) { | |
| 406 | - $react = $scripts->query( 'react', 'registered' ); | |
| 407 | - if ( $react && ! in_array( 'wp-react-refresh-entry', $react->deps, true ) ) { | |
| 408 | - $react->deps[] = 'wp-react-refresh-entry'; | |
| 409 | - } | |
| 609 | + $editor_styles = array( | |
| 610 | + 'css' => file_get_contents( $editor_styles_file ), | |
| 611 | + ); | |
| 612 | + | |
| 613 | + // Substitute default styles if found. Otherwise, prepend to setting array. | |
| 614 | + if ( isset( $i ) && $i >= 0 ) { | |
| 615 | + $settings['styles'][ $i ] = $editor_styles; | |
| 616 | + } else { | |
| 617 | + array_unshift( $settings['styles'], $editor_styles ); | |
| 410 | 618 | } |
| 619 | + | |
| 620 | + return $settings; | |
| 411 | 621 | } |
| 412 | -add_action( 'wp_default_scripts', 'gutenberg_register_vendor_scripts' ); | |
| 622 | +add_filter( 'block_editor_settings', 'gutenberg_extend_block_editor_styles' ); | |
| 413 | 623 | |
| 414 | 624 | /** |
| 415 | - * Registers or re-registers Gutenberg Script Modules. | |
| 625 | + * Load a block pattern by name. | |
| 416 | 626 | * |
| 417 | - * Script modules that are registered by Core will be re-registered by Gutenberg. | |
| 627 | + * @param string $name Block Pattern File name. | |
| 418 | 628 | * |
| 419 | - * @since 19.3.0 | |
| 629 | + * @return array Block Pattern Array. | |
| 420 | 630 | */ |
| 421 | -function gutenberg_define_interactivity_modules_support() { | |
| 422 | - // Load the auto-generated module registry. | |
| 423 | - $modules_registry_file = gutenberg_dir_path() . 'build/modules/index.php'; | |
| 424 | - if ( ! file_exists( $modules_registry_file ) ) { | |
| 425 | - return; | |
| 631 | +function gutenberg_load_block_pattern( $name ) { | |
| 632 | + return require( __DIR__ . '/patterns/' . $name . '.php' ); | |
| 633 | +} | |
| 634 | + | |
| 635 | +/** | |
| 636 | + * Extends block editor settings to include a list of default patterns. | |
| 637 | + * | |
| 638 | + * @param array $settings Default editor settings. | |
| 639 | + * | |
| 640 | + * @return array Filtered editor settings. | |
| 641 | + */ | |
| 642 | +function gutenberg_extend_settings_block_patterns( $settings ) { | |
| 643 | + if ( empty( $settings['__experimentalBlockPatterns'] ) ) { | |
| 644 | + $settings['__experimentalBlockPatterns'] = array(); | |
| 426 | 645 | } |
| 427 | 646 | |
| 428 | - $modules = require $modules_registry_file; | |
| 647 | + $settings['__experimentalBlockPatterns'] = array_merge( | |
| 648 | + WP_Block_Patterns_Registry::get_instance()->get_all_registered(), | |
| 649 | + $settings['__experimentalBlockPatterns'] | |
| 650 | + ); | |
| 429 | 651 | |
| 430 | - // Add client navigation support to block library modules. | |
| 431 | - foreach ( $modules as $module ) { | |
| 432 | - if ( str_starts_with( $module['id'], '@wordpress/block-library' ) && method_exists( 'WP_Interactivity_API', 'add_client_navigation_support_to_script_module' ) ) { | |
| 433 | - wp_interactivity()->add_client_navigation_support_to_script_module( $module['id'] ); | |
| 434 | - } | |
| 652 | + if ( empty( $settings['__experimentalBlockPatternCategories'] ) ) { | |
| 653 | + $settings['__experimentalBlockPatternCategories'] = array(); | |
| 435 | 654 | } |
| 655 | + | |
| 656 | + $settings['__experimentalBlockPatternCategories'] = array_merge( | |
| 657 | + WP_Block_Pattern_Categories_Registry::get_instance()->get_all_registered(), | |
| 658 | + $settings['__experimentalBlockPatternCategories'] | |
| 659 | + ); | |
| 660 | + | |
| 661 | + return $settings; | |
| 436 | 662 | } |
| 437 | -remove_action( 'wp_default_scripts', 'wp_define_interactivity_modules_support' ); | |
| 438 | -add_action( 'wp_default_scripts', 'gutenberg_define_interactivity_modules_support' ); | |
| 663 | +add_filter( 'block_editor_settings', 'gutenberg_extend_settings_block_patterns', 0 ); | |
| 439 | 664 | |
| 440 | 665 | /** |
| 441 | - * Always remove the Core action hook while gutenberg_enqueue_stored_styles() exists to avoid styles being printed twice. | |
| 442 | - * This is also because gutenberg_enqueue_stored_styles uses the Style Engine's `gutenberg_*` functions and `_Gutenberg` classes, | |
| 443 | - * which are in continuous development and generally ahead of Core. | |
| 666 | + * Extends block editor settings to determine whether to use custom line height controls. | |
| 667 | + * | |
| 668 | + * @param array $settings Default editor settings. | |
| 669 | + * | |
| 670 | + * @return array Filtered editor settings. | |
| 444 | 671 | */ |
| 445 | -remove_action( 'wp_enqueue_scripts', 'wp_enqueue_stored_styles' ); | |
| 446 | -remove_action( 'wp_footer', 'wp_enqueue_stored_styles', 1 ); | |
| 672 | +function gutenberg_extend_settings_custom_line_height( $settings ) { | |
| 673 | + $settings['__experimentalDisableCustomLineHeight'] = get_theme_support( 'disable-custom-line-height' ); | |
| 674 | + return $settings; | |
| 675 | +} | |
| 676 | +add_filter( 'block_editor_settings', 'gutenberg_extend_settings_custom_line_height' ); | |
| 447 | 677 | |
| 448 | -// Enqueue stored styles. | |
| 449 | -add_action( 'wp_enqueue_scripts', 'gutenberg_enqueue_stored_styles' ); | |
| 450 | -add_action( 'wp_footer', 'gutenberg_enqueue_stored_styles', 1 ); | |
| 451 | - | |
| 452 | 678 | /** |
| 453 | - * Enqueues the LaTeX to MathML loader script module in the block editor. | |
| 679 | + * Extends block editor settings to determine whether to use custom unit controls. | |
| 680 | + * Currently experimental. | |
| 681 | + * | |
| 682 | + * @param array $settings Default editor settings. | |
| 683 | + * | |
| 684 | + * @return array Filtered editor settings. | |
| 454 | 685 | */ |
| 455 | -add_action( 'enqueue_block_editor_assets', 'gutenberg_enqueue_latex_to_mathml_loader' ); | |
| 456 | -function gutenberg_enqueue_latex_to_mathml_loader() { | |
| 457 | - wp_enqueue_script_module( '@wordpress/latex-to-mathml/loader' ); | |
| 686 | +function gutenberg_extend_settings_custom_units( $settings ) { | |
| 687 | + $settings['__experimentalDisableCustomUnits'] = get_theme_support( 'experimental-custom-units' ); | |
| 688 | + return $settings; | |
| 458 | 689 | } |
| 690 | +add_filter( 'block_editor_settings', 'gutenberg_extend_settings_custom_units' ); | |
| 459 | 691 | |
| 460 | 692 | /** |
| 461 | - * Enqueue the vips loader script module in the block editor. | |
| 693 | + * Extends block editor settings to determine whether to use custom spacing controls. | |
| 694 | + * Currently experimental. | |
| 462 | 695 | * |
| 463 | - * This registers @wordpress/vips/worker as a dynamic dependency in the import map, | |
| 464 | - * enabling on-demand loading of the ~3.8MB WASM-based image processing module | |
| 465 | - * when client-side media processing is triggered via @wordpress/upload-media. | |
| 696 | + * @param array $settings Default editor settings. | |
| 466 | 697 | * |
| 467 | - * @see packages/vips/src/loader.ts | |
| 698 | + * @return array Filtered editor settings. | |
| 468 | 699 | */ |
| 469 | -add_action( 'enqueue_block_editor_assets', 'gutenberg_enqueue_vips_loader' ); | |
| 470 | -function gutenberg_enqueue_vips_loader() { | |
| 471 | - wp_enqueue_script_module( '@wordpress/vips/loader' ); | |
| 700 | +function gutenberg_extend_settings_custom_spacing( $settings ) { | |
| 701 | + $settings['__experimentalEnableCustomSpacing'] = get_theme_support( 'experimental-custom-spacing' ); | |
| 702 | + return $settings; | |
| 472 | 703 | } |
| 704 | +add_filter( 'block_editor_settings', 'gutenberg_extend_settings_custom_spacing' ); | |
| 473 | 705 | |
| 706 | + | |
| 474 | 707 | /** |
| 475 | - * Enqueue the video-conversion loader script module in the block editor. | |
| 708 | + * Extends block editor settings to determine whether to use custom spacing controls. | |
| 709 | + * Currently experimental. | |
| 476 | 710 | * |
| 477 | - * This registers @wordpress/video-conversion/worker as a dynamic dependency | |
| 478 | - * in the import map, enabling on-demand loading of the WebCodecs-based | |
| 479 | - * GIF-to-video processing module when animated GIF conversion is triggered | |
| 480 | - * via @wordpress/upload-media. | |
| 711 | + * @param array $settings Default editor settings. | |
| 481 | 712 | * |
| 482 | - * @see packages/video-conversion/src/loader.ts | |
| 713 | + * @return array Filtered editor settings. | |
| 483 | 714 | */ |
| 484 | -if ( defined( 'IS_GUTENBERG_PLUGIN' ) && IS_GUTENBERG_PLUGIN ) { | |
| 485 | - add_action( 'enqueue_block_editor_assets', 'gutenberg_enqueue_video_conversion_loader' ); | |
| 715 | +function gutenberg_extend_settings_link_color( $settings ) { | |
| 716 | + $settings['__experimentalEnableLinkColor'] = get_theme_support( 'experimental-link-color' ); | |
| 717 | + return $settings; | |
| 486 | 718 | } |
| 487 | -function gutenberg_enqueue_video_conversion_loader() { | |
| 488 | - wp_enqueue_script_module( '@wordpress/video-conversion/loader' ); | |
| 719 | +add_filter( 'block_editor_settings', 'gutenberg_extend_settings_link_color' ); | |
| 720 | + | |
| 721 | +/* | |
| 722 | + * Register default patterns if not registered in Core already. | |
| 723 | + */ | |
| 724 | + | |
| 725 | +if ( class_exists( 'WP_Block_Patterns_Registry' ) && ! WP_Block_Patterns_Registry::get_instance()->is_registered( 'text-two-columns' ) ) { | |
| 726 | + register_block_pattern( 'core/text-two-columns', gutenberg_load_block_pattern( 'text-two-columns' ) ); | |
| 727 | + register_block_pattern( 'core/two-buttons', gutenberg_load_block_pattern( 'two-buttons' ) ); | |
| 728 | + register_block_pattern( 'core/cover-abc', gutenberg_load_block_pattern( 'cover-abc' ) ); | |
| 729 | + register_block_pattern( 'core/two-images', gutenberg_load_block_pattern( 'two-images' ) ); | |
| 730 | + register_block_pattern( 'core/hero-two-columns', gutenberg_load_block_pattern( 'hero-two-columns' ) ); | |
| 731 | + register_block_pattern( 'core/numbered-features', gutenberg_load_block_pattern( 'numbered-features' ) ); | |
| 732 | + register_block_pattern( 'core/its-time', gutenberg_load_block_pattern( 'its-time' ) ); | |
| 733 | + register_block_pattern( 'core/hero-right-column', gutenberg_load_block_pattern( 'hero-right-column' ) ); | |
| 734 | + register_block_pattern( 'core/testimonials', gutenberg_load_block_pattern( 'testimonials' ) ); | |
| 735 | + register_block_pattern( 'core/features-services', gutenberg_load_block_pattern( 'features-services' ) ); | |
| 736 | +} | |
| 737 | + | |
| 738 | +/* | |
| 739 | + * Register default pattern categories if not registered in Core already. | |
| 740 | + */ | |
| 741 | +if ( class_exists( 'WP_Block_Pattern_Categories_Registry' ) ) { | |
| 742 | + register_block_pattern_category( 'text', array( 'label' => _x( 'Text', 'Block pattern category', 'gutenberg' ) ) ); | |
| 743 | + register_block_pattern_category( 'hero', array( 'label' => _x( 'Hero', 'Block pattern category', 'gutenberg' ) ) ); | |
| 744 | + register_block_pattern_category( 'columns', array( 'label' => _x( 'Columns', 'Block pattern category', 'gutenberg' ) ) ); | |
| 745 | + register_block_pattern_category( 'buttons', array( 'label' => _x( 'Buttons', 'Block pattern category', 'gutenberg' ) ) ); | |
| 746 | + register_block_pattern_category( 'gallery', array( 'label' => _x( 'Gallery', 'Block pattern category', 'gutenberg' ) ) ); | |
| 747 | + register_block_pattern_category( 'features', array( 'label' => _x( 'Features', 'Block pattern category', 'gutenberg' ) ) ); | |
| 748 | + register_block_pattern_category( 'testimonials', array( 'label' => _x( 'Testimonials', 'Block pattern category', 'gutenberg' ) ) ); | |
| 489 | 749 | } |
