1. 首页
  2. WordPress 函数手册

wp_register_script()

wp_register_script( string $handle, string|bool $src, string[] $deps = array(), string|bool|null $ver = false, bool $in_footer = false )

注册一个新脚本。
Register a new script.

目录锚点:#说明#参数#源码#笔记


说明(Description)

使用wp_enqueue_script()函数注册以后要排队的脚本。另请参阅WP_Dependencies::add()WP_Dependencies::add_data()


参数(Parameters)

参数 类型 说明
$handle (string) 脚本的名称。应该是独一无二的。
$src (string | bool) 脚本的完整URL,或脚本相对于WordPress根目录的路径。如果source设置为false,则脚本是它所依赖的其他脚本的别名。
$deps (string[]) 已注册脚本的数组处理此脚本所依赖的。
$ver (string | bool | null) 指定脚本版本号的字符串(如果有),该版本号作为查询字符串添加到URL中,以用于缓存破坏。如果version设置为false,则会自动添加与当前安装的WordPress版本相同的版本号。如果设置为null,则不添加任何版本。
$in_footer (bool) 是否在之前而不是在中对脚本进行排队。默认为“false”。

源码(Source)

/**
 * Register a new script.
 *
 * Registers a script to be linked later using the wp_enqueue_script() function.
 *
 * @see WP_Dependencies::add(), WP_Dependencies::add_data()
 *
 * @since 2.6.0
 * @since 4.3.0 A return value was added.
 *
 * @param string      $handle    Name of the script. Should be unique.
 * @param string      $src       Path to the script from the WordPress root directory. Example: '/js/myscript.js'.
 * @param array       $deps      Optional. An array of registered script handles this script depends on. Set to false if there
 *                               are no dependencies. Default empty array.
 * @param string|bool $ver       Optional. String specifying script version number, if it has one, which is concatenated
 *                               to end of path as a query string. If no version is specified or set to false, a version
 *                               number is automatically added equal to current installed WordPress version.
 *                               If set to null, no version is added. Default 'false'. Accepts 'false', 'null', or 'string'.
 * @param bool        $in_footer Optional. Whether to enqueue the script before  or before .
 *                               Default 'false'. Accepts 'false' or 'true'.
 * @return bool Whether the script has been registered. True on success, false on failure.
 */
function wp_register_script( $handle, $src, $deps = array(), $ver = false, $in_footer = false ) {
	$wp_scripts = wp_scripts();
	_wp_scripts_maybe_doing_it_wrong( __FUNCTION__ );

	$registered = $wp_scripts->add( $handle, $src, $deps, $ver );
	if ( $in_footer ) {
		$wp_scripts->add_data( $handle, 'group', 1 );
	}

	return $registered;
}
更新版本 源码位置 使用 被使用
4.3.0 wp-includes/functions.wp-scripts.php 4 2

笔记(Notes)

链接到外部JS库并在项目中轻松使用的简单方法:

wp_register_script() 为WP2原创文章,链接:https://www.wp2.cn/functions/wp_register_script/