解释 `is_plugin_active()` 函数的源码，它是如何判断插件是否处于激活状态的？ - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位听众，早上好！我是今天的主讲人，很高兴能跟大家一起聊聊 WordPress 插件激活状态的那些事儿。今天我们就来剖析一下 is_plugin_active() 这个函数，看看它到底是怎么判断一个插件是“活蹦乱跳”还是“沉睡不醒”的。准备好了吗？ Let’s dive in!

一、前情提要：插件激活的本质

在深入代码之前，我们先简单回顾一下 WordPress 插件激活的机制。当你点击 WordPress 后台的“激活”按钮时，实际上发生的事情是：

WordPress 会将该插件的文件名记录在一个地方。这个地方通常是 wp_options 表中的 active_plugins 选项。
在 WordPress 加载时，它会读取 active_plugins 选项，并加载其中列出的插件文件。

所以，判断一个插件是否激活，本质上就是看它的文件名是否出现在 active_plugins 选项中。

二、源码解析：is_plugin_active() 函数

接下来，我们来看看 is_plugin_active() 函数的源码。这个函数位于 wp-includes/plugin.php 文件中。

function is_plugin_active( $plugin ) {
    return in_array( $plugin, (array) get_option( 'active_plugins', array() ), true ) || is_plugin_active_for_network( $plugin );
}

是不是很简单？别被它的简洁迷惑了，麻雀虽小，五脏俱全。我们来逐行分析一下：

function is_plugin_active( $plugin ) {：定义函数，接收一个参数 $plugin，这个参数就是我们要检查的插件的文件名（例如：my-plugin/my-plugin.php）。
return in_array( $plugin, (array) get_option( 'active_plugins', array() ), true ) || is_plugin_active_for_network( $plugin );：这是核心逻辑，我们把它拆解一下：
- get_option( 'active_plugins', array() )：这个函数从 wp_options 表中获取 active_plugins 选项的值。如果该选项不存在，就返回一个空数组 array()。 active_plugins 选项的值通常是一个序列化的 PHP 数组，包含了所有已激活插件的文件名。
- (array) get_option( 'active_plugins', array() )：将 get_option() 返回的值强制转换为数组。虽然 get_option() 应该返回数组，但为了确保万无一失，这里做了一个类型转换。
- in_array( $plugin, (array) get_option( 'active_plugins', array() ), true )： in_array() 函数用来检查 $plugin 是否存在于 active_plugins 数组中。第三个参数 true 表示严格比较，也就是不仅值要相等，类型也要相等。这样可以避免一些潜在的类型转换问题。
- || is_plugin_active_for_network( $plugin )： || 是逻辑或运算符。如果 in_array() 返回 true（插件已激活），那么整个表达式就为 true，函数直接返回 true。否则，就执行 is_plugin_active_for_network( $plugin ) 函数。这个函数用来检查插件是否在网络（多站点）模式下被激活。

三、多站点模式：is_plugin_active_for_network() 函数

在 WordPress 多站点模式下，插件可以被全局激活（在整个网络中激活），也可以被单独站点激活。 is_plugin_active_for_network() 函数就是用来检查插件是否被全局激活的。

function is_plugin_active_for_network( $plugin ) {
    if ( ! is_multisite() )
        return false;

    $plugins = get_site_option( 'active_sitewide_plugins' );
    if ( isset( $plugins[ plugin_basename( $plugin ) ] ) )
        return true;

    return false;
}

我们再来分析一下这个函数：

function is_plugin_active_for_network( $plugin ) {：定义函数，接收一个参数 $plugin，同样是插件的文件名。
if ( ! is_multisite() ) return false;：首先检查是否是多站点模式。如果不是，直接返回 false，因为单站点模式下不存在全局激活的概念。
$plugins = get_site_option( 'active_sitewide_plugins' );：从 wp_options 表中获取 active_sitewide_plugins 选项的值。这个选项存储了所有全局激活的插件的文件名。注意这里用的是 get_site_option() 而不是 get_option()，这是多站点模式下获取全局选项的正确方式。
if ( isset( $plugins[ plugin_basename( $plugin ) ] ) ) return true;： plugin_basename( $plugin ) 函数用来获取插件的文件名，不包含目录路径。例如，如果 $plugin 是 my-plugin/my-plugin.php，那么 plugin_basename( $plugin ) 将返回 my-plugin.php。然后，检查 $plugins 数组中是否存在以 my-plugin.php 为键的元素。如果存在，说明该插件被全局激活，返回 true。
return false;：如果以上条件都不满足，说明插件既没有被单独站点激活，也没有被全局激活，返回 false。

四、总结：插件激活状态的判断逻辑

现在，我们可以总结一下 is_plugin_active() 函数的判断逻辑了：

单站点模式： 检查插件的文件名是否存在于 active_plugins 选项中。
多站点模式：
- 首先检查插件的文件名是否存在于 active_plugins 选项中（判断是否被单独站点激活）。
- 如果不存在，再检查插件的文件名是否存在于 active_sitewide_plugins 选项中（判断是否被全局激活）。

用一个表格来总结一下：

场景	检查选项	使用函数	返回值
单站点	`active_plugins`	`in_array()`	`true`/`false`
多站点(单站点激活)	`active_plugins`	`in_array()`	`true`/`false`
多站点(全局激活)	`active_sitewide_plugins`	`isset()` & `plugin_basename()`	`true`/`false`

五、实战演练：如何正确使用 is_plugin_active()

了解了 is_plugin_active() 函数的原理，接下来我们看看如何在实际开发中使用它。

示例 1：根据插件激活状态显示不同的内容

<?php
if ( is_plugin_active( 'my-plugin/my-plugin.php' ) ) {
    echo '<p>My Plugin is active!</p>';
} else {
    echo '<p>My Plugin is not active. Please activate it.</p>';
}
?>

这段代码会根据 my-plugin/my-plugin.php 插件的激活状态，显示不同的提示信息。

示例 2：在插件中检查另一个插件是否激活

<?php
/**
 * Plugin Name: Plugin A
 */

add_action( 'admin_init', 'plugin_a_check_plugin_b' );

function plugin_a_check_plugin_b() {
    if ( ! is_plugin_active( 'plugin-b/plugin-b.php' ) ) {
        add_action( 'admin_notices', 'plugin_a_notice_plugin_b_inactive' );
    }
}

function plugin_a_notice_plugin_b_inactive() {
    ?>
    <div class="notice notice-warning is-dismissible">
        <p>Plugin A requires Plugin B to be active. Please activate Plugin B.</p>
    </div>
    <?php
}
?>

这段代码演示了如何在插件 A 中检查插件 B 是否激活。如果插件 B 没有激活，插件 A 会在后台显示一个警告信息。

示例 3: 兼容多站点模式的检查

<?php
function is_plugin_active_properly( $plugin ) {
    if ( is_multisite() ) {
        if ( is_plugin_active_for_network( $plugin ) ) {
            return true; // Globally active
        }
    }

    return is_plugin_active( $plugin ); // Active for this site (or single site)
}

if ( is_plugin_active_properly( 'my-plugin/my-plugin.php' ) ) {
    // Do something
} else {
    // Do something else
}
?>

这段代码展示了一个更健壮的检查方法，它同时考虑了单站点和多站点模式，并且区分了全局激活和单站点激活。这样做可以确保你的代码在各种环境下都能正常工作。

六、注意事项：一些容易犯的错误

在使用 is_plugin_active() 函数时，有一些容易犯的错误需要注意：

插件文件名错误： 确保你传递给 is_plugin_active() 函数的插件文件名是正确的。插件文件名通常是 插件目录名/插件主文件.php。可以通过查看插件的头部注释来确定插件文件名。
未激活插件： 如果你确定插件已经激活，但 is_plugin_active() 函数仍然返回 false，可能是因为插件的激活状态没有正确写入 active_plugins 选项。可以尝试停用并重新激活插件，或者手动检查 wp_options 表中的 active_plugins 选项。
缓存问题： 有些缓存插件可能会缓存 active_plugins 选项的值，导致 is_plugin_active() 函数返回错误的结果。可以尝试清除缓存，或者禁用缓存插件。
多站点环境混淆： 在多站点环境下，要注意区分全局激活和单站点激活。如果你的代码需要在全局激活的插件上运行，必须使用 is_plugin_active_for_network() 函数进行检查。

七、总结与展望

好了，今天我们深入剖析了 WordPress 的 is_plugin_active() 函数，了解了它的源码、判断逻辑和使用方法。希望通过今天的讲解，大家能够更好地理解插件激活的机制，并在实际开发中正确使用 is_plugin_active() 函数。

WordPress 的插件系统非常灵活强大，掌握好这些基础知识，才能更好地开发出高质量的 WordPress 插件。

感谢大家的聆听，希望今天的分享对大家有所帮助！如果大家还有什么问题，欢迎随时提问。

祝大家编程愉快！

发表回复 取消回复

发表回复取消回复