wp_default_script_modules()
云策文档标注
概述
wp_default_script_modules() 函数用于注册所有默认的 WordPress Script Modules。它从 assets/script-modules-packages.php 文件加载资产数据,并根据文件名构建 Script Module ID,然后通过 wp_register_script_module() 进行注册。
关键要点
- 函数从 assets/script-modules-packages.php 文件加载多维数组资产数据,包含依赖和版本信息。
- 通过正则表达式从文件名构建 Script Module ID,例如 '@wordpress/interactivity',并处理调试和索引文件。
- 根据 SCRIPT_DEBUG 常量条件处理 '@wordpress/interactivity' 和 '@wordpress/interactivity/debug' 入口点。
- 为特定 Script Module ID(如 '@wordpress/interactivity'、'@wordpress/block-library'、'@wordpress/a11y')设置 fetchpriority 为 'low' 和 in_footer 为 true。
- 为 '@wordpress/block-library' 开头的 Script Module ID 添加客户端导航支持。
- 使用 includes_url() 构建路径,并调用 wp_register_script_module() 完成注册。
代码示例
source function wp_default_script_modules() {
$suffix = defined( 'WP_RUN_CORE_TESTS' ) ? '.min' : wp_scripts_get_suffix();
$assets = include ABSPATH . WPINC . "/assets/script-modules-packages{$suffix}.php";
foreach ( $assets as $file_name => $script_module_data ) {
$script_module_id = '@wordpress/' . preg_replace( '~(?:/index)?(?:.min)?\.js$~D', '', $file_name, 1 );
switch ( $script_module_id ) {
case '@wordpress/interactivity/debug':
if ( ! SCRIPT_DEBUG ) {
continue 2;
}
$script_module_id = '@wordpress/interactivity';
break;
case '@wordpress/interactivity':
if ( SCRIPT_DEBUG ) {
continue 2;
}
break;
}
$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;
}
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}" );
wp_register_script_module( $script_module_id, $path, $script_module_data['dependencies'], $script_module_data['version'], $args );
}
}注意事项
- 函数在 WordPress 6.7.0 版本中引入。
- Interactivity API 设计以服务器端渲染为主要目标,因此其 Script Modules 应设置低 fetchpriority 并在页脚打印。
- @wordpress/a11y Script Module 通常用作动态导入依赖,fetchpriority 可能无关紧要,但作为静态依赖时也设置为 'low'。
原文内容
Registers all the default WordPress Script Modules.
Source
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 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}" );
wp_register_script_module( $script_module_id, $path, $script_module_data['dependencies'], $script_module_data['version'], $args );
}
}
Changelog
| Version | Description |
|---|---|
| 6.7.0 | Introduced. |