阐述 WordPress `wp_deregister_script()` 函数的源码：如何从脚本队列中移除已注册的脚本。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众，晚上好！今天咱们来聊聊WordPress的wp_deregister_script()函数，这个函数就像一个默默无闻的清洁工，负责把那些我们不需要的脚本从WordPress的脚本队列中扫地出门。听起来很简单，但要理解它的工作原理，还得深入源码探个究竟。

什么是脚本队列？

在开始解剖wp_deregister_script()之前，我们先来搞清楚什么是WordPress的脚本队列。简单来说，它就像一个等待播放的歌曲列表，WordPress会按照一定的顺序加载并执行这些脚本。这个队列的存在是为了保证脚本的依赖关系和加载顺序，避免出现“鸡还没下蛋，就想吃鸡蛋羹”的尴尬情况。

wp_deregister_script()：脚本移除大师

wp_deregister_script()函数的作用，就是从这个脚本队列中移除已经注册的脚本。它的基本语法如下：

<?php
wp_deregister_script( string $handle )
?>

只有一个参数$handle，它指定了要移除的脚本的唯一标识符（handle）。这个handle是在使用wp_register_script()函数注册脚本时定义的。

源码剖析：wp-includes/functions.wp-scripts.php

让我们打开WordPress的源码，找到wp-includes/functions.wp-scripts.php文件，这里面藏着wp_deregister_script()的真面目。

function wp_deregister_script( $handle ) {
    global $wp_scripts;

    if ( ! is_a( $wp_scripts, 'WP_Scripts' ) ) {
        return;
    }

    $wp_scripts->remove( $handle );
}

这段代码看起来是不是比想象中还要简单？

全局变量$wp_scripts: 首先，它声明了一个全局变量$wp_scripts。这个变量是WP_Scripts类的一个实例，负责管理所有的脚本。
类型检查: 接着，它使用is_a()函数检查$wp_scripts是否是WP_Scripts类的实例。如果不是，说明WordPress的脚本管理系统还没有初始化，函数直接返回，啥也不干。这就像保安检查身份证，没身份证直接拦住，不让进。
$wp_scripts->remove( $handle ): 最后，也是最关键的一步，它调用了$wp_scripts对象的remove()方法，并将要移除的脚本的handle作为参数传递进去。

WP_Scripts::remove()：移除的核心

现在，我们要深入WP_Scripts类，看看remove()方法是如何工作的。WP_Scripts类的定义位于wp-includes/class.wp-scripts.php文件中。

public function remove( $handles ) {
    $handles = (array) $handles;

    foreach ( $handles as $handle ) {
        unset( $this->registered[ $handle ] );
        unset( $this->queue[ array_search( $handle, $this->queue, true ) ] );
        unset( $this->done[ array_search( $handle, $this->done, true ) ] );
        unset( $this->to_do[ array_search( $handle, $this->to_do, true ) ] );
    }
}

这个方法接受一个或多个handle作为参数，并进行以下操作：

类型转换: 将传入的$handles参数转换为数组，以便处理单个或多个handle的情况。
循环处理: 遍历$handles数组，对每个handle执行以下操作：
- unset( $this->registered[ $handle ] ): 从$this->registered数组中移除以该handle为键的元素。$this->registered数组存储了所有已注册的脚本的信息。
- unset( $this->queue[ array_search( $handle, $this->queue, true ) ] ): 从$this->queue数组中移除该handle。$this->queue数组存储了等待加载的脚本的handle列表。这里使用array_search()函数找到handle在队列中的位置，然后使用unset()函数将其移除。true参数保证了严格类型比较，避免出现意外的匹配。
- unset( $this->done[ array_search( $handle, $this->done, true ) ] ): 从$this->done数组中移除该handle。$this->done数组存储了已经加载的脚本的handle列表。
- unset( $this->to_do[ array_search( $handle, $this->to_do, true ) ] ): 从$this->to_do数组中移除该handle。 $this->to_do数组存储了需要输出到页面的脚本的handle列表。

总结：wp_deregister_script()的运作流程

现在，我们来总结一下wp_deregister_script()的运作流程：

获取全局的WP_Scripts对象。
调用WP_Scripts对象的remove()方法，传入要移除的脚本的handle。
remove()方法从$registered、$queue、$done和$to_do数组中移除该handle，从而阻止该脚本被加载和执行。

使用场景：告别不需要的脚本

wp_deregister_script()函数在实际开发中有很多用途。以下是一些常见的场景：

移除主题或插件自带的脚本: 某些主题或插件可能会加载一些你并不需要的脚本，比如一些过时的jQuery插件或者一些你没有使用的功能相关的脚本。使用wp_deregister_script()可以移除这些脚本，减少页面加载时间。
替换默认脚本: 你可能想要替换WordPress默认加载的某些脚本，比如jQuery。你可以先使用wp_deregister_script()移除默认的jQuery，然后再使用wp_register_script()和wp_enqueue_script()注册并加载你自己的jQuery版本。
条件加载脚本: 你可能只需要在特定的页面或文章中加载某个脚本。你可以在其他页面中使用wp_deregister_script()移除该脚本，避免不必要的加载。

代码示例：移除Contact Form 7的脚本

假设你使用了Contact Form 7插件，但你只想在特定的页面使用它，不想在其他页面加载它的脚本。你可以这样做：

<?php
function my_deregister_scripts() {
    if ( ! is_page( 'contact' ) ) { // 假设你的联系页面slug是"contact"
        wp_deregister_script( 'contact-form-7' );
        wp_deregister_style( 'contact-form-7' ); // 同时移除样式
    }
}
add_action( 'wp_enqueue_scripts', 'my_deregister_scripts', 100 );
?>

这段代码会在除了"contact"页面之外的所有页面移除Contact Form 7的脚本和样式。注意，这里使用了wp_deregister_style()函数来移除样式，因为Contact Form 7也会加载一些样式文件。add_action()的第三个参数100是为了确保在Contact Form 7的脚本注册之后再执行移除操作。

注意事项：小心驶得万年船

在使用wp_deregister_script()函数时，需要注意以下几点：

确认handle: 确保你使用的handle是正确的。错误的handle会导致你移除错误的脚本，可能会导致网站功能出现问题。
依赖关系: 移除脚本时，要考虑脚本的依赖关系。如果其他脚本依赖于你移除的脚本，那么这些脚本也可能无法正常工作。
加载顺序: 移除脚本后，可能会影响其他脚本的加载顺序。确保你的网站在移除脚本后仍然能够正常工作。
主题和插件更新: 主题和插件更新可能会改变脚本的handle或者依赖关系。你需要定期检查你的代码，确保它仍然能够正常工作。

深入理解：$registered、$queue、$done 和 $to_do

为了更深入地理解wp_deregister_script()的工作原理，我们来详细了解一下WP_Scripts类中的 $registered、$queue、$done 和 $to_do 这四个重要的属性。

属性	描述	存储内容	作用
`$registered`	存储所有已注册的脚本信息。	一个关联数组，键是脚本的handle，值是一个 `_WP_Dependency` 对象，包含了脚本的URL、依赖关系、版本号等信息。	记录所有注册的脚本，方便后续的加载和管理。
`$queue`	存储等待加载的脚本的handle列表。	一个索引数组，包含了需要加载的脚本的handle。	维护脚本的加载顺序，确保脚本的依赖关系得到满足。
`$done`	存储已经加载的脚本的handle列表。	一个索引数组，包含了已经加载的脚本的handle。	记录已经加载的脚本，避免重复加载。
`$to_do`	存储需要输出到页面的脚本的handle列表。	一个索引数组，包含了需要输出到页面的脚本的handle。	最终确定需要在页面中加载的脚本。在 `wp_head` 和 `wp_footer` 钩子中，WordPress会遍历这个数组，生成相应的HTML代码，将脚本加载到页面中。

_WP_Dependency 类：脚本信息的载体

在 $registered 数组中，每个脚本的信息都存储在一个 _WP_Dependency 对象中。这个类定义了脚本的基本属性，例如：

src: 脚本的URL。
deps: 脚本的依赖关系，一个包含了依赖脚本的handle的数组。
ver: 脚本的版本号。
handle: 脚本的handle。

当你使用 wp_register_script() 函数注册一个脚本时，WordPress会创建一个 _WP_Dependency 对象，并将脚本的信息存储到该对象中。然后，将该对象添加到 $registered 数组中。

高级用法：条件移除，更灵活的控制

除了简单的移除脚本之外，你还可以根据不同的条件来移除脚本，例如：

根据用户角色移除: 你可以根据当前用户的角色来移除脚本。例如，你可以只允许管理员加载某些脚本。
根据浏览器类型移除: 你可以根据用户的浏览器类型来移除脚本。例如，你可以为旧版本的浏览器加载一些兼容性脚本，而为新版本的浏览器移除这些脚本。
根据设备类型移除: 你可以根据用户的设备类型来移除脚本。例如，你可以为移动设备加载一些优化过的脚本，而为桌面设备移除这些脚本。

代码示例：根据用户角色移除脚本

<?php
function my_deregister_scripts() {
    if ( ! current_user_can( 'administrator' ) ) { // 只有管理员才能加载这个脚本
        wp_deregister_script( 'my-admin-script' );
    }
}
add_action( 'wp_enqueue_scripts', 'my_deregister_scripts', 100 );
?>

这段代码会检查当前用户是否是管理员。如果不是，则移除名为 "my-admin-script" 的脚本。

总结：wp_deregister_script()，你的脚本管理利器

wp_deregister_script() 函数是一个强大的工具，可以让你更好地控制WordPress的脚本加载。通过理解它的工作原理，你可以移除不需要的脚本，替换默认脚本，以及根据不同的条件加载脚本，从而优化你的网站性能，提升用户体验。

记住，在使用这个函数时，一定要小心谨慎，确保你移除的是正确的脚本，并且不会影响网站的正常功能。只有这样，才能让 wp_deregister_script() 真正成为你的脚本管理利器！

今天的讲座就到这里，希望对大家有所帮助。下次再见！

发表回复 取消回复

发表回复取消回复