| 1 |
<?php |
| 2 |
/** |
| 3 |
* Functions to register client-side assets (scripts and stylesheets) specific |
| 4 |
* for the 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 |
/* |
| 58 |
* Force `wp-i18n` script to be registered in the <head> as a |
| 59 |
* temporary workaround for https://meta.trac.wordpress.org/ticket/6195. |
| 60 |
*/ |
| 61 |
$in_footer = 'wp-i18n' === $handle ? false : $in_footer; |
| 62 |
|
| 63 |
$script = $scripts->query( $handle, 'registered' ); |
| 64 |
if ( $script ) { |
| 65 |
/* |
| 66 |
* In many ways, this is a reimplementation of `wp_register_script` but |
| 67 |
* bypassing consideration of whether a script by the given handle had |
| 68 |
* already been registered. |
| 69 |
*/ |
| 70 |
|
| 71 |
// See: `_WP_Dependency::__construct` . |
| 72 |
$script->src = $src; |
| 73 |
$script->deps = $deps; |
| 74 |
$script->ver = $ver; |
| 75 |
$script->args = $in_footer ? 1 : null; |
| 76 |
} else { |
| 77 |
$scripts->add( $handle, $src, $deps, $ver, ( $in_footer ? 1 : null ) ); |
| 78 |
} |
| 79 |
|
| 80 |
/* |
| 81 |
* `WP_Dependencies::set_translations` will fall over on itself if setting |
| 82 |
* translations on the `wp-i18n` handle, since it internally adds `wp-i18n` |
| 83 |
* as a dependency of itself, exhausting memory. The same applies for the |
| 84 |
* polyfill and hooks scripts, which are dependencies _of_ `wp-i18n`. |
| 85 |
* |
| 86 |
* See: https://core.trac.wordpress.org/ticket/46089 |
| 87 |
*/ |
| 88 |
if ( ! in_array( $handle, array( 'wp-i18n', 'wp-polyfill', 'wp-hooks' ), true ) ) { |
| 89 |
$scripts->set_translations( $handle, 'default' ); |
| 90 |
} |
| 91 |
|
| 92 |
/* |
| 93 |
* Wp-editor module is exposed as window.wp.editor. |
| 94 |
* Problem: there is quite some code expecting window.wp.oldEditor object available under window.wp.editor. |
| 95 |
* Solution: fuse the two objects together to maintain backward compatibility. |
| 96 |
* For more context, see https://github.com/WordPress/gutenberg/issues/33203 |
| 97 |
*/ |
| 98 |
if ( 'wp-editor' === $handle ) { |
| 99 |
$scripts->add_inline_script( |
| 100 |
'wp-editor', |
| 101 |
'Object.assign( window.wp.editor, window.wp.oldEditor );', |
| 102 |
'after' |
| 103 |
); |
| 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 all the WordPress packages scripts that are in the standardized |
| 187 |
* `build/` location. |
| 188 |
* |
| 189 |
* @since 4.5.0 |
| 190 |
* |
| 191 |
* @param WP_Scripts $scripts WP_Scripts instance. |
| 192 |
*/ |
| 193 |
function gutenberg_register_packages_scripts( $scripts ) { |
| 194 |
// When in production, use the plugin's version as the default asset version; |
| 195 |
// else (for development or test) default to use the current time. |
| 196 |
$default_version = defined( 'GUTENBERG_VERSION' ) && ! ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? GUTENBERG_VERSION : time(); |
| 197 |
|
| 198 |
foreach ( glob( gutenberg_dir_path() . 'build/*/index.min.js' ) as $path ) { |
| 199 |
// Prefix `wp-` to package directory to get script handle. |
| 200 |
// For example, `…/build/a11y/index.min.js` becomes `wp-a11y`. |
| 201 |
$handle = 'wp-' . basename( dirname( $path ) ); |
| 202 |
|
| 203 |
// Replace extension with `.asset.php` to find the generated dependencies file. |
| 204 |
$asset_file = substr( $path, 0, -( strlen( '.js' ) ) ) . '.asset.php'; |
| 205 |
$asset = file_exists( $asset_file ) |
| 206 |
? require( $asset_file ) |
| 207 |
: null; |
| 208 |
$dependencies = isset( $asset['dependencies'] ) ? $asset['dependencies'] : array(); |
| 209 |
$version = isset( $asset['version'] ) ? $asset['version'] : $default_version; |
| 210 |
|
| 211 |
// Add dependencies that cannot be detected and generated by build tools. |
| 212 |
switch ( $handle ) { |
| 213 |
case 'wp-block-library': |
| 214 |
array_push( $dependencies, 'editor' ); |
| 215 |
break; |
| 216 |
|
| 217 |
case 'wp-edit-post': |
| 218 |
array_push( $dependencies, 'media-models', 'media-views', 'postbox' ); |
| 219 |
break; |
| 220 |
|
| 221 |
case 'wp-edit-site': |
| 222 |
array_push( $dependencies, 'wp-dom-ready' ); |
| 223 |
break; |
| 224 |
} |
| 225 |
|
| 226 |
// Get the path from Gutenberg directory as expected by `gutenberg_url`. |
| 227 |
$gutenberg_path = substr( $path, strlen( gutenberg_dir_path() ) ); |
| 228 |
|
| 229 |
gutenberg_override_script( |
| 230 |
$scripts, |
| 231 |
$handle, |
| 232 |
gutenberg_url( $gutenberg_path ), |
| 233 |
$dependencies, |
| 234 |
$version, |
| 235 |
true |
| 236 |
); |
| 237 |
} |
| 238 |
} |
| 239 |
add_action( 'wp_default_scripts', 'gutenberg_register_packages_scripts' ); |
| 240 |
|
| 241 |
/** |
| 242 |
* Registers all the WordPress packages styles that are in the standardized |
| 243 |
* `build/` location. |
| 244 |
* |
| 245 |
* @since 6.7.0 |
| 246 |
|
| 247 |
* @param WP_Styles $styles WP_Styles instance. |
| 248 |
*/ |
| 249 |
function gutenberg_register_packages_styles( $styles ) { |
| 250 |
// When in production, use the plugin's version as the asset version; |
| 251 |
// else (for development or test) default to use the current time. |
| 252 |
$version = defined( 'GUTENBERG_VERSION' ) && ! ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? GUTENBERG_VERSION : time(); |
| 253 |
|
| 254 |
// Editor Styles. |
| 255 |
gutenberg_override_style( |
| 256 |
$styles, |
| 257 |
'wp-block-editor', |
| 258 |
gutenberg_url( 'build/block-editor/style.css' ), |
| 259 |
array( 'wp-components' ), |
| 260 |
$version |
| 261 |
); |
| 262 |
$styles->add_data( 'wp-block-editor', 'rtl', 'replace' ); |
| 263 |
|
| 264 |
gutenberg_override_style( |
| 265 |
$styles, |
| 266 |
'wp-editor', |
| 267 |
gutenberg_url( 'build/editor/style.css' ), |
| 268 |
array( 'wp-components', 'wp-block-editor', 'wp-nux', 'wp-reusable-blocks' ), |
| 269 |
$version |
| 270 |
); |
| 271 |
$styles->add_data( 'wp-editor', 'rtl', 'replace' ); |
| 272 |
|
| 273 |
gutenberg_override_style( |
| 274 |
$styles, |
| 275 |
'wp-edit-post', |
| 276 |
gutenberg_url( 'build/edit-post/style.css' ), |
| 277 |
array( 'wp-components', 'wp-block-editor', 'wp-editor', 'wp-edit-blocks', 'wp-block-library', 'wp-nux' ), |
| 278 |
$version |
| 279 |
); |
| 280 |
$styles->add_data( 'wp-edit-post', 'rtl', 'replace' ); |
| 281 |
|
| 282 |
gutenberg_override_style( |
| 283 |
$styles, |
| 284 |
'wp-components', |
| 285 |
gutenberg_url( 'build/components/style.css' ), |
| 286 |
array( 'dashicons' ), |
| 287 |
$version |
| 288 |
); |
| 289 |
$styles->add_data( 'wp-components', 'rtl', 'replace' ); |
| 290 |
|
| 291 |
$block_library_filename = wp_should_load_separate_core_block_assets() ? 'common' : 'style'; |
| 292 |
gutenberg_override_style( |
| 293 |
$styles, |
| 294 |
'wp-block-library', |
| 295 |
gutenberg_url( 'build/block-library/' . $block_library_filename . '.css' ), |
| 296 |
array(), |
| 297 |
$version |
| 298 |
); |
| 299 |
$styles->add_data( 'wp-block-library', 'rtl', 'replace' ); |
| 300 |
$styles->add_data( 'wp-block-library', 'path', gutenberg_dir_path() . 'build/block-library/' . $block_library_filename . '.css' ); |
| 301 |
|
| 302 |
gutenberg_override_style( |
| 303 |
$styles, |
| 304 |
'wp-format-library', |
| 305 |
gutenberg_url( 'build/format-library/style.css' ), |
| 306 |
array( 'wp-block-editor', 'wp-components' ), |
| 307 |
$version |
| 308 |
); |
| 309 |
$styles->add_data( 'wp-format-library', 'rtl', 'replace' ); |
| 310 |
|
| 311 |
$wp_edit_blocks_dependencies = array( |
| 312 |
'wp-components', |
| 313 |
'wp-editor', |
| 314 |
// This need to be added before the block library styles, |
| 315 |
// The block library styles override the "reset" styles. |
| 316 |
'wp-reset-editor-styles', |
| 317 |
'wp-block-library', |
| 318 |
'wp-reusable-blocks', |
| 319 |
); |
| 320 |
|
| 321 |
// Only load the default layout and margin styles for themes without theme.json file. |
| 322 |
if ( ! WP_Theme_JSON_Resolver_Gutenberg::theme_has_support() ) { |
| 323 |
$wp_edit_blocks_dependencies[] = 'wp-editor-classic-layout-styles'; |
| 324 |
} |
| 325 |
|
| 326 |
global $editor_styles; |
| 327 |
if ( ! is_array( $editor_styles ) || count( $editor_styles ) === 0 ) { |
| 328 |
// Include opinionated block styles if no $editor_styles are declared, so the editor never appears broken. |
| 329 |
$wp_edit_blocks_dependencies[] = 'wp-block-library-theme'; |
| 330 |
} |
| 331 |
|
| 332 |
gutenberg_override_style( |
| 333 |
$styles, |
| 334 |
'wp-reset-editor-styles', |
| 335 |
gutenberg_url( 'build/block-library/reset.css' ), |
| 336 |
array( 'common', 'forms' ), // Make sure the reset is loaded after the default WP Admin styles. |
| 337 |
$version |
| 338 |
); |
| 339 |
$styles->add_data( 'wp-reset-editor-styles', 'rtl', 'replace' ); |
| 340 |
|
| 341 |
gutenberg_override_style( |
| 342 |
$styles, |
| 343 |
'wp-editor-classic-layout-styles', |
| 344 |
gutenberg_url( 'build/edit-post/classic.css' ), |
| 345 |
array(), |
| 346 |
$version |
| 347 |
); |
| 348 |
$styles->add_data( 'wp-editor-classic-layout-styles', 'rtl', 'replace' ); |
| 349 |
|
| 350 |
gutenberg_override_style( |
| 351 |
$styles, |
| 352 |
'wp-edit-blocks', |
| 353 |
gutenberg_url( 'build/block-library/editor.css' ), |
| 354 |
$wp_edit_blocks_dependencies, |
| 355 |
$version |
| 356 |
); |
| 357 |
$styles->add_data( 'wp-edit-blocks', 'rtl', 'replace' ); |
| 358 |
|
| 359 |
gutenberg_override_style( |
| 360 |
$styles, |
| 361 |
'wp-nux', |
| 362 |
gutenberg_url( 'build/nux/style.css' ), |
| 363 |
array( 'wp-components' ), |
| 364 |
$version |
| 365 |
); |
| 366 |
$styles->add_data( 'wp-nux', 'rtl', 'replace' ); |
| 367 |
|
| 368 |
gutenberg_override_style( |
| 369 |
$styles, |
| 370 |
'wp-block-library-theme', |
| 371 |
gutenberg_url( 'build/block-library/theme.css' ), |
| 372 |
array(), |
| 373 |
$version |
| 374 |
); |
| 375 |
$styles->add_data( 'wp-block-library-theme', 'rtl', 'replace' ); |
| 376 |
|
| 377 |
gutenberg_override_style( |
| 378 |
$styles, |
| 379 |
'wp-list-reusable-blocks', |
| 380 |
gutenberg_url( 'build/list-reusable-blocks/style.css' ), |
| 381 |
array( 'wp-components' ), |
| 382 |
$version |
| 383 |
); |
| 384 |
$styles->add_data( 'wp-list-reusable-block', 'rtl', 'replace' ); |
| 385 |
|
| 386 |
gutenberg_override_style( |
| 387 |
$styles, |
| 388 |
'wp-edit-navigation', |
| 389 |
gutenberg_url( 'build/edit-navigation/style.css' ), |
| 390 |
array( 'wp-components', 'wp-block-editor', 'wp-edit-blocks' ), |
| 391 |
$version |
| 392 |
); |
| 393 |
$styles->add_data( 'wp-edit-navigation', 'rtl', 'replace' ); |
| 394 |
|
| 395 |
gutenberg_override_style( |
| 396 |
$styles, |
| 397 |
'wp-edit-site', |
| 398 |
gutenberg_url( 'build/edit-site/style.css' ), |
| 399 |
array( 'wp-components', 'wp-block-editor', 'wp-edit-blocks' ), |
| 400 |
$version |
| 401 |
); |
| 402 |
$styles->add_data( 'wp-edit-site', 'rtl', 'replace' ); |
| 403 |
|
| 404 |
gutenberg_override_style( |
| 405 |
$styles, |
| 406 |
'wp-edit-widgets', |
| 407 |
gutenberg_url( 'build/edit-widgets/style.css' ), |
| 408 |
array( 'wp-components', 'wp-block-editor', 'wp-edit-blocks', 'wp-reusable-blocks', 'wp-widgets' ), |
| 409 |
$version |
| 410 |
); |
| 411 |
$styles->add_data( 'wp-edit-widgets', 'rtl', 'replace' ); |
| 412 |
|
| 413 |
gutenberg_override_style( |
| 414 |
$styles, |
| 415 |
'wp-block-directory', |
| 416 |
gutenberg_url( 'build/block-directory/style.css' ), |
| 417 |
array( 'wp-block-editor', 'wp-components' ), |
| 418 |
$version |
| 419 |
); |
| 420 |
$styles->add_data( 'wp-block-directory', 'rtl', 'replace' ); |
| 421 |
|
| 422 |
gutenberg_override_style( |
| 423 |
$styles, |
| 424 |
'wp-customize-widgets', |
| 425 |
gutenberg_url( 'build/customize-widgets/style.css' ), |
| 426 |
array( 'wp-components', 'wp-block-editor', 'wp-edit-blocks', 'wp-widgets' ), |
| 427 |
$version |
| 428 |
); |
| 429 |
$styles->add_data( 'wp-customize-widgets', 'rtl', 'replace' ); |
| 430 |
|
| 431 |
gutenberg_override_style( |
| 432 |
$styles, |
| 433 |
'wp-reusable-blocks', |
| 434 |
gutenberg_url( 'build/reusable-blocks/style.css' ), |
| 435 |
array( 'wp-components' ), |
| 436 |
$version |
| 437 |
); |
| 438 |
$styles->add_data( 'wp-reusable-block', 'rtl', 'replace' ); |
| 439 |
|
| 440 |
gutenberg_override_style( |
| 441 |
$styles, |
| 442 |
'wp-widgets', |
| 443 |
gutenberg_url( 'build/widgets/style.css' ), |
| 444 |
array( 'wp-components' ) |
| 445 |
); |
| 446 |
$styles->add_data( 'wp-widgets', 'rtl', 'replace' ); |
| 447 |
} |
| 448 |
add_action( 'wp_default_styles', 'gutenberg_register_packages_styles' ); |
| 449 |
|
