c97bb4a4bd
* Allow scripts and script modules to be registered with a `fetchpriority` of `auto` (default), `high`, `low`: * When registering a script, add a `fetchpriority` arg to go alongside the `strategy` arg which was added for loading scripts with the `defer` and `async` loading strategies. See #12009. * For script modules, introduce an `$args` array parameter with a `fetchpriority` key to the `wp_register_script_module()`, and `wp_enqueue_script_module()` functions (and their respective underlying `WP_Script_Modules::register()` and `WP_Script_Modules::enqueue()` methods). This `$args` parameter corresponds with the same parameter used when registering non-module scripts. * Also for script modules, introduce `WP_Script_Modules::set_fetchpriority()` to override the `fetchpriority` for what was previously registered. * Emit a `_doing_it_wrong()` warning when an invalid `fetchpriority` value is used, and when `fetchpriority` is added to a script alias. * Include `fetchpriority` as an attribute on printed `SCRIPT` tags as well as on preload `LINK` tags for static script module dependencies. * Use a `fetchpriority` of `low` by default for: * Script modules used with the Interactivity API. For overriding this default in blocks, see [https://github.com/WordPress/gutenberg/issues/71366 Gutenberg#71366]. * The `comment-reply` script. * Improve type checks and type hints. Developed in [https://github.com/WordPress/wordpress-develop/pull/8815 GitHub PR], with [https://github.com/WordPress/gutenberg/pull/70173 companion for Gutenberg]. Props westonruter, jonsurrell, swissspidy, luisherranz, kraftbj, audrasjb, dennysdionigi. Fixes #61734. Built from https://develop.svn.wordpress.org/trunk@60704 git-svn-id: http://core.svn.wordpress.org/trunk@60040 1a063a9b-81f0-0310-95a4-ce76da25c4cd
194 lines
8.5 KiB
PHP
194 lines
8.5 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 $deps {
|
|
* Optional. List of dependencies.
|
|
*
|
|
* @type string|array ...$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 $args {
|
|
* Optional. An array of additional args. Default empty array.
|
|
*
|
|
* @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 $deps {
|
|
* Optional. List of dependencies.
|
|
*
|
|
* @type string|array ...$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 $args {
|
|
* Optional. An array of additional args. Default empty array.
|
|
*
|
|
* @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/debug.min.js' => array('dependencies' => array(…), 'version' => '…'),
|
|
* 'interactivity-router/index.min.js' => …
|
|
*/
|
|
$assets = include ABSPATH . WPINC . "/assets/script-modules-packages{$suffix}.php";
|
|
|
|
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/debug.min.js => @wordpress/interactivity/debug
|
|
* - block-library/query/view.js => @wordpress/block-library/query/view
|
|
*/
|
|
$script_module_id = '@wordpress/' . preg_replace( '~(?:/index)?(?:\.min)?\.js$~D', '', $file_name, 1 );
|
|
|
|
switch ( $script_module_id ) {
|
|
/*
|
|
* Interactivity exposes two entrypoints, "/index" and "/debug".
|
|
* "/debug" should replace "/index" in development.
|
|
*/
|
|
case '@wordpress/interactivity/debug':
|
|
if ( ! SCRIPT_DEBUG ) {
|
|
continue 2;
|
|
}
|
|
$script_module_id = '@wordpress/interactivity';
|
|
break;
|
|
case '@wordpress/interactivity':
|
|
if ( SCRIPT_DEBUG ) {
|
|
continue 2;
|
|
}
|
|
break;
|
|
}
|
|
|
|
// The Interactivity API is designed with server-side rendering as its primary goal, so all of its script modules should be loaded with low fetch priority since they should not be needed in the critical rendering path.
|
|
$args = array();
|
|
if ( str_starts_with( $script_module_id, '@wordpress/interactivity' ) || str_starts_with( $script_module_id, '@wordpress/block-library' ) ) {
|
|
$args['fetchpriority'] = 'low';
|
|
}
|
|
|
|
$path = includes_url( "js/dist/script-modules/{$file_name}" );
|
|
wp_register_script_module( $script_module_id, $path, $script_module_data['dependencies'], $script_module_data['version'], $args );
|
|
}
|
|
}
|