📌  相关文章
📜  wp_enqueue_script - PHP (1)

📅  最后修改于: 2023-12-03 15:21:15.436000             🧑  作者: Mango

介绍

wp_enqueue_script 是一个WordPress函数,用于在WordPress主题中添加脚本文件。该函数会根据您提供的参数自动加载所需的文件。这个函数就像一种指挥官,接收您的命令并执行您的操作。

该函数可以从主题的 functions.php 文件或插件中调用。

用途

wp_enqueue_script 函数用于为主题或插件加载JavaScript代码,例如jQuery库和您的自定义脚本。

WordPress核心的JavaScript资源(如jQuery、underscore、backbone等)是默认可用的,因此不需要在主题中调用 wp_enqueue_script 来加载它们。但是,任何自定义JavaScript代码需要通过该函数加载才能正常使用。

用法

这个函数有3个必须的参数和1个可选的参数:

wp_enqueue_script( $handle, $src, $deps, $ver, $in_footer );
  1. $handle - 脚本的名称,用于在主题中识别脚本。它应该是唯一的,不能包含空格或特殊字符。

  2. $src - 脚本的路径和文件名。对于主题内部脚本,可以使用 get_template_directory_uri() 函数来获取主题目录的URI,例如:

    wp_enqueue_script('myscript', get_template_directory_uri() . '/js/myscript.js');
    
  3. $deps - 脚本依赖的脚本句柄数组。如果您的脚本依赖于其他脚本(如jQuery),请在此处列出它们的脚本句柄。

  4. $ver - 脚本的版本号。如果您希望强制浏览器读取新版本的脚本,请在此处更改版本号。

  5. $in_footer - 布尔值,指定脚本文件是否应该在页面底部加载。如果是,则设置为 true,否则设置为 false

示例

以下是加载自定义脚本的示例,该示例列出了所有可选参数:

// Register and enqueue custom script
function my_custom_script() {
    wp_enqueue_script( 'myscript', get_template_directory_uri() . '/js/myscript.js', array( 'jquery' ), '1.0', true );
}
add_action( 'wp_enqueue_scripts', 'my_custom_script' );

上面的代码将加载一个名为 myscript.js 的自定义脚本文件。该脚本依赖于jQuery库,并且设置在页面底部加载。

结论

在WordPress主题或插件中使用 wp_enqueue_script 是一种良好的做法,它确保您的脚本与WordPress核心代码和其他第三方脚本正确地交互。使用该函数还可以避免脚本文件重复加载,从而提高网站的性能。