7b752c237e
This allows classic scripts to declare dependencies on script modules by passing `module_dependencies` in the `$args` param for `wp_register_script()` or `wp_enqueue_script()`. The `WP_Script_Modules::get_import_map()` method is updated to traverse the dependency tree of all enqueued classic scripts to find any associated script module dependencies and include them in the `importmap`, enabling dynamic imports of modules within classic scripts. A `_wp_scripts_add_args_data()` helper function is introduced to consolidate argument validation and processing for `wp_register_script()` and `wp_enqueue_script()`, reducing code duplication. This function validates that the `$args` array only contains recognized keys (`strategy`, `in_footer`, `fetchpriority`, `module_dependencies`) and triggers a `_doing_it_wrong()` notice for any unrecognized keys. Similarly, `WP_Scripts::add_data()` is updated to do early type checking for the data passed to `$args`. The script modules in `module_dependencies` may be referenced by a module ID string or by an array that has an `id` key, following the same pattern as dependencies in `WP_Script_Modules`. When a script module is added to the `module_dependencies` for a classic script, but it does not exist at the time the `importmap` is printed, a `_doing_it_wrong()` notice is emitted. Developed in https://github.com/WordPress/wordpress-develop/pull/8024 Follow-up to [61323]. Props sirreal, westonruter. See #64229. Fixes #61500. Built from https://develop.svn.wordpress.org/trunk@61587 git-svn-id: http://core.svn.wordpress.org/trunk@60898 1a063a9b-81f0-0310-95a4-ce76da25c4cd
211 lines
11 KiB
PHP
211 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* Script Modules API: Script Module functions
|
|
*
|
|
* @since 6.5.0
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Script Modules
|
|
*/
|
|
|
|
/**
|
|
* Retrieves the main WP_Script_Modules instance.
|
|
*
|
|
* This function provides access to the WP_Script_Modules instance, creating one
|
|
* if it doesn't exist yet.
|
|
*
|
|
* @since 6.5.0
|
|
*
|
|
* @global WP_Script_Modules $wp_script_modules
|
|
*
|
|
* @return WP_Script_Modules The main WP_Script_Modules instance.
|
|
*/
|
|
function wp_script_modules(): WP_Script_Modules {
|
|
global $wp_script_modules;
|
|
|
|
if ( ! ( $wp_script_modules instanceof WP_Script_Modules ) ) {
|
|
$wp_script_modules = new WP_Script_Modules();
|
|
}
|
|
|
|
return $wp_script_modules;
|
|
}
|
|
|
|
/**
|
|
* Registers the script module if no script module with that script module
|
|
* identifier has already been registered.
|
|
*
|
|
* @since 6.5.0
|
|
* @since 6.9.0 Added the $args parameter.
|
|
*
|
|
* @param string $id The identifier of the script module. Should be unique. It will be used in the
|
|
* final import map.
|
|
* @param string $src Optional. Full URL of the script module, or path of the script module relative
|
|
* to the WordPress root directory. If it is provided and the script module has
|
|
* not been registered yet, it will be registered.
|
|
* @param array<string|array<string, string>> $deps {
|
|
* Optional. List of dependencies.
|
|
*
|
|
* @type string|array<string, string> ...$0 {
|
|
* An array of script module identifiers of the dependencies of this script
|
|
* module. The dependencies can be strings or arrays. If they are arrays,
|
|
* they need an `id` key with the script module identifier, and can contain
|
|
* an `import` key with either `static` or `dynamic`. By default,
|
|
* dependencies that don't contain an `import` key are considered static.
|
|
*
|
|
* @type string $id The script module identifier.
|
|
* @type string $import Optional. Import type. May be either `static` or
|
|
* `dynamic`. Defaults to `static`.
|
|
* }
|
|
* }
|
|
* @param string|false|null $version Optional. String specifying the script module version number. Defaults to false.
|
|
* It is added to the URL as a query string for cache busting purposes. If $version
|
|
* is set to false, the version number is the currently installed WordPress version.
|
|
* If $version is set to null, no version is added.
|
|
* @param array<string, string|bool> $args {
|
|
* Optional. An array of additional args. Default empty array.
|
|
*
|
|
* @type bool $in_footer Whether to print the script module in the footer. Only relevant to block themes. Default 'false'. Optional.
|
|
* @type 'auto'|'low'|'high' $fetchpriority Fetch priority. Default 'auto'. Optional.
|
|
* }
|
|
*/
|
|
function wp_register_script_module( string $id, string $src, array $deps = array(), $version = false, array $args = array() ) {
|
|
wp_script_modules()->register( $id, $src, $deps, $version, $args );
|
|
}
|
|
|
|
/**
|
|
* Marks the script module to be enqueued in the page.
|
|
*
|
|
* If a src is provided and the script module has not been registered yet, it
|
|
* will be registered.
|
|
*
|
|
* @since 6.5.0
|
|
* @since 6.9.0 Added the $args parameter.
|
|
*
|
|
* @param string $id The identifier of the script module. Should be unique. It will be used in the
|
|
* final import map.
|
|
* @param string $src Optional. Full URL of the script module, or path of the script module relative
|
|
* to the WordPress root directory. If it is provided and the script module has
|
|
* not been registered yet, it will be registered.
|
|
* @param array<string|array<string, string>> $deps {
|
|
* Optional. List of dependencies.
|
|
*
|
|
* @type string|array<string, string> ...$0 {
|
|
* An array of script module identifiers of the dependencies of this script
|
|
* module. The dependencies can be strings or arrays. If they are arrays,
|
|
* they need an `id` key with the script module identifier, and can contain
|
|
* an `import` key with either `static` or `dynamic`. By default,
|
|
* dependencies that don't contain an `import` key are considered static.
|
|
*
|
|
* @type string $id The script module identifier.
|
|
* @type string $import Optional. Import type. May be either `static` or
|
|
* `dynamic`. Defaults to `static`.
|
|
* }
|
|
* }
|
|
* @param string|false|null $version Optional. String specifying the script module version number. Defaults to false.
|
|
* It is added to the URL as a query string for cache busting purposes. If $version
|
|
* is set to false, the version number is the currently installed WordPress version.
|
|
* If $version is set to null, no version is added.
|
|
* @param array<string, string|bool> $args {
|
|
* Optional. An array of additional args. Default empty array.
|
|
*
|
|
* @type bool $in_footer Whether to print the script module in the footer. Only relevant to block themes. Default 'false'. Optional.
|
|
* @type 'auto'|'low'|'high' $fetchpriority Fetch priority. Default 'auto'. Optional.
|
|
* }
|
|
*/
|
|
function wp_enqueue_script_module( string $id, string $src = '', array $deps = array(), $version = false, array $args = array() ) {
|
|
wp_script_modules()->enqueue( $id, $src, $deps, $version, $args );
|
|
}
|
|
|
|
/**
|
|
* Unmarks the script module so it is no longer enqueued in the page.
|
|
*
|
|
* @since 6.5.0
|
|
*
|
|
* @param string $id The identifier of the script module.
|
|
*/
|
|
function wp_dequeue_script_module( string $id ) {
|
|
wp_script_modules()->dequeue( $id );
|
|
}
|
|
|
|
/**
|
|
* Deregisters the script module.
|
|
*
|
|
* @since 6.5.0
|
|
*
|
|
* @param string $id The identifier of the script module.
|
|
*/
|
|
function wp_deregister_script_module( string $id ) {
|
|
wp_script_modules()->deregister( $id );
|
|
}
|
|
|
|
/**
|
|
* Registers all the default WordPress Script Modules.
|
|
*
|
|
* @since 6.7.0
|
|
*/
|
|
function wp_default_script_modules() {
|
|
$suffix = defined( 'WP_RUN_CORE_TESTS' ) ? '.min' : wp_scripts_get_suffix();
|
|
|
|
/*
|
|
* Expects multidimensional array like:
|
|
*
|
|
* 'interactivity/index.min.js' => array('dependencies' => array(…), 'version' => '…'),
|
|
* 'interactivity-router/index.min.js' => array('dependencies' => array(…), 'version' => '…'),
|
|
* 'block-library/navigation/view.min.js' => …
|
|
*/
|
|
$assets_file = ABSPATH . WPINC . "/assets/script-modules-packages{$suffix}.php";
|
|
$assets = file_exists( $assets_file ) ? include $assets_file : array();
|
|
|
|
foreach ( $assets as $file_name => $script_module_data ) {
|
|
/*
|
|
* Build the WordPress Script Module ID from the file name.
|
|
* Prepend `@wordpress/` and remove extensions and `/index` if present:
|
|
* - interactivity/index.min.js => @wordpress/interactivity
|
|
* - interactivity-router/index.min.js => @wordpress/interactivity-router
|
|
* - block-library/navigation/view.js => @wordpress/block-library/navigation/view
|
|
*/
|
|
$script_module_id = '@wordpress/' . preg_replace( '~(?:/index)?(?:\.min)?\.js$~D', '', $file_name, 1 );
|
|
|
|
/*
|
|
* The Interactivity API is designed with server-side rendering as its primary goal, so all of its script modules
|
|
* should be loaded with low fetchpriority and printed in the footer since they should not be needed in the
|
|
* critical rendering path. Also, the @wordpress/a11y script module is intended to be used as a dynamic import
|
|
* dependency, in which case the fetchpriority is irrelevant. See <https://make.wordpress.org/core/2024/10/14/updates-to-script-modules-in-6-7/>.
|
|
* However, in case it is added as a static import dependency, the fetchpriority is explicitly set to be 'low'
|
|
* since the module should not be involved in the critical rendering path, and if it is, its fetchpriority will
|
|
* be bumped to match the fetchpriority of the dependent script.
|
|
*/
|
|
$args = array();
|
|
if (
|
|
str_starts_with( $script_module_id, '@wordpress/interactivity' ) ||
|
|
str_starts_with( $script_module_id, '@wordpress/block-library' ) ||
|
|
'@wordpress/a11y' === $script_module_id
|
|
) {
|
|
$args['fetchpriority'] = 'low';
|
|
$args['in_footer'] = true;
|
|
}
|
|
|
|
// Marks all Core blocks as compatible with client-side navigation.
|
|
if ( str_starts_with( $script_module_id, '@wordpress/block-library' ) ) {
|
|
wp_interactivity()->add_client_navigation_support_to_script_module( $script_module_id );
|
|
}
|
|
|
|
$path = includes_url( "js/dist/script-modules/{$file_name}" );
|
|
$module_deps = $script_module_data['module_dependencies'] ?? array();
|
|
wp_register_script_module( $script_module_id, $path, $module_deps, $script_module_data['version'], $args );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Enqueues script modules required by the block editor.
|
|
*
|
|
* @since 6.9.0
|
|
*/
|
|
function wp_enqueue_block_editor_script_modules() {
|
|
/*
|
|
* Enqueue the LaTeX to MathML loader for the math block editor.
|
|
* The loader dynamically imports the main LaTeX to MathML module when needed.
|
|
*/
|
|
wp_enqueue_script_module( '@wordpress/latex-to-mathml/loader' );
|
|
}
|