分析 WordPress `is_plugin_active()` 函数的源码：如何检查一个插件是否被激活。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

咳咳，大家好！今天咱们就来聊聊 WordPress 插件激活的那些事儿，特别是那个神秘兮兮的 is_plugin_active() 函数。别害怕，我会尽量用大白话，让你们听懂。

第一幕：开场白，插件激活的意义

想象一下，WordPress 就像一个光秃秃的毛坯房，而插件呢，就是各种家具、电器、装修材料。没有它们，房子就没法住人。插件让你的网站拥有各种各样的功能，从 SEO 优化到电子商务，从表单创建到安全防护，都离不开它们。

而插件激活，就相当于你把家具搬进房间，把电器插上电源，让它们开始工作。一个没激活的插件，就像一个躺在纸箱里的电视机，看着挺好，但啥也干不了。

第二幕：is_plugin_active() 函数登场

现在，咱们的主角要登场了：is_plugin_active()。这个函数的作用很简单，就是告诉你，某个插件是不是已经激活了。

它的原型长这样：

function is_plugin_active( $plugin ) {
  // 函数的具体实现
}

嗯，看起来挺简洁的。参数 $plugin 是什么？这就是一个指向插件主文件的路径，比如 akismet/akismet.php 或者 woocommerce/woocommerce.php。记住，是相对于 wp-content/plugins/ 目录的相对路径。

第三幕：深入源码，扒一扒它的老底

让我们一起潜入 WordPress 的源码，看看 is_plugin_active() 到底是怎么工作的。这个函数通常位于 wp-includes/plugin.php 文件中。

function is_plugin_active( $plugin ) {
    $active_plugins = (array) get_option( 'active_plugins', array() );

    if ( is_multisite() ) {
        $active_sitewide_plugins = (array) get_site_option( 'active_sitewide_plugins', array() );
        if ( isset( $active_sitewide_plugins[ $plugin ] ) ) {
            return true;
        }
    }

    return in_array( $plugin, $active_plugins, true );
}

代码不多，但是信息量很大。咱们一行一行地拆解它：

$active_plugins = (array) get_option( 'active_plugins', array() );

这行代码是关键。它从 WordPress 的选项数据库中获取名为 active_plugins 的选项。这个选项是一个数组，存储了所有已激活插件的主文件路径。

get_option() 函数的作用就是从数据库中读取选项的值。如果 active_plugins 选项不存在，它会返回一个空数组 array()，避免出错。 (array) 是一个强制类型转换，确保 $active_plugins 始终是一个数组。

你可以把它想象成一个存放着所有“已激活”插件名单的登记表。
if ( is_multisite() ) { ... }

这部分代码处理的是多站点 (Multisite) 的情况。多站点允许你用一个 WordPress 安装运行多个网站。在多站点中，有些插件可以在整个网络范围内激活 (Network Activated)，这意味着它们会自动在所有站点上激活。

is_multisite() 函数检查当前 WordPress 是否运行在多站点模式下。
$active_sitewide_plugins = (array) get_site_option( 'active_sitewide_plugins', array() );

如果是在多站点模式下，这行代码会从站点选项数据库中获取名为 active_sitewide_plugins 的选项。这个选项也是一个数组，存储了所有网络激活插件的主文件路径。

get_site_option() 函数与 get_option() 类似，但它读取的是站点级别的选项，而不是单个站点的选项。
if ( isset( $active_sitewide_plugins[ $plugin ] ) ) { return true; }

这行代码检查要判断的插件 $plugin 是否存在于 $active_sitewide_plugins 数组中。如果存在，说明这个插件是网络激活的，函数直接返回 true。注意这里用的是 isset() 函数，它比 in_array() 更高效，因为它只需要检查键是否存在，而不需要遍历整个数组。
return in_array( $plugin, $active_plugins, true );

如果插件不是网络激活的，或者不是在多站点模式下，这行代码会被执行。它使用 in_array() 函数检查要判断的插件 $plugin 是否存在于 $active_plugins 数组中。

in_array() 函数的作用是在一个数组中查找指定的值。第三个参数 true 表示使用严格比较，也就是说，不仅要值相等，还要类型相等。

如果 $plugin 存在于 $active_plugins 数组中，说明这个插件已经被激活，函数返回 true。否则，函数返回 false。

第四幕：代码实战，举几个栗子

光说不练假把式，咱们来写几个实际的代码示例。

例1：检查 Akismet 插件是否激活

if ( is_plugin_active( 'akismet/akismet.php' ) ) {
  echo 'Akismet 插件已激活！';
} else {
  echo 'Akismet 插件未激活！';
}

这段代码会检查 Akismet 插件是否已经激活，并输出相应的消息。

例2：在插件激活时执行某些操作

有时候，你需要在插件激活时执行一些初始化操作。你可以这样写：
```
register_activation_hook( __FILE__, 'my_plugin_activate' );

function my_plugin_activate() {
  // 你的初始化代码
  update_option( 'my_plugin_version', '1.0' ); // 保存插件版本号
}

// 在插件的某个页面检查插件是否已经被激活
if ( is_plugin_active( plugin_basename( __FILE__ ) ) ) {
    // 插件已激活，可以执行相关操作
}
```
这段代码使用了 register_activation_hook() 函数，它会在插件激活时自动执行 my_plugin_activate() 函数。在 my_plugin_activate() 函数中，你可以执行任何你需要的初始化操作，比如创建数据库表、设置默认选项等等。
plugin_basename( __FILE__ )获取当前插件的主文件路径。

例3：检查 WooCommerce 插件是否激活，并根据激活状态显示不同的内容

<?php
if ( is_plugin_active( 'woocommerce/woocommerce.php' ) ) {
    // WooCommerce 已激活，显示 WooCommerce 相关内容
    echo '<p>WooCommerce 已经安装并激活，您可以使用 WooCommerce 的各种功能。</p>';

    // 例如，显示 WooCommerce 版本号
    $woo_version = WC()->version;
    echo '<p>WooCommerce 版本：' . esc_html( $woo_version ) . '</p>';
} else {
    // WooCommerce 未激活，显示提示信息
    echo '<p>您需要先安装并激活 WooCommerce 插件才能使用本功能。</p>';
    echo '<p><a href="' . esc_url( admin_url( 'plugin-install.php?s=woocommerce&tab=search' ) ) . '">安装 WooCommerce</a></p>';
}
?>

这个例子首先检查 WooCommerce 插件是否已经激活。如果激活，则显示 WooCommerce 相关的提示信息，并显示 WooCommerce 的版本号。如果未激活，则显示提示信息，并提供一个链接，直接跳转到 WordPress 后台的插件安装页面，方便用户安装 WooCommerce 插件。

例4：检查某个插件是否在多站点环境中网络激活

<?php
if ( is_multisite() && is_plugin_active_for_network( 'my-plugin/my-plugin.php' ) ) {
    echo "该插件已在整个网络中激活。";
} else {
    echo "该插件未在整个网络中激活。";
}
?>

在这个例子中，is_multisite() 检查是否是多站点环境，is_plugin_active_for_network() 检查插件是否在网络级别激活。

第五幕：is_plugin_active_for_network() 函数

在多站点环境中，还有一个函数经常和 is_plugin_active() 搭配使用，那就是 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 ] ) ) {
        return true;
    }

    return false;
}

这个函数的逻辑也很简单：

首先，检查是否是多站点环境。如果不是，直接返回 false。
然后，从站点选项数据库中获取 active_sitewide_plugins 选项。
最后，检查要判断的插件 $plugin 是否存在于 active_sitewide_plugins 数组中。如果存在，返回 true，否则返回 false。

第六幕：注意事项，避免踩坑

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

插件路径必须正确。 确保你传递给函数的插件主文件路径是正确的，包括目录名和文件名。路径是相对于 wp-content/plugins/ 目录的相对路径。
插件必须已经安装。 is_plugin_active() 函数只能判断已经安装的插件是否激活，如果插件没有安装，它会返回 false。
多站点环境的特殊性。 在多站点环境中，要考虑插件是网络激活还是站点激活的情况。可以使用 is_plugin_active_for_network() 函数来判断插件是否是网络激活的。
不要过度使用。 尽量避免在每个页面都调用 is_plugin_active() 函数。这会增加数据库查询的次数，影响网站的性能。建议将插件激活状态缓存起来，或者只在必要的时候才调用该函数。
插件激活和加载顺序。 插件激活并不意味着插件的代码立即被加载。 WordPress 有自己的插件加载机制。如果你需要依赖某个插件的功能，最好使用 plugins_loaded 钩子来确保依赖的插件已经被加载。

第七幕：active_plugins 选项的幕后故事

现在让我们更深入地了解一下 active_plugins 这个选项。它存储在 WordPress 的 wp_options 表中，以序列化的数组形式存储。序列化是一种将 PHP 数组转换为字符串的格式，方便存储在数据库中。

你可以通过以下 SQL 查询语句来查看 active_plugins 选项的值：

SELECT option_value FROM wp_options WHERE option_name = 'active_plugins';

（请将 wp_ 替换成你实际的 WordPress 数据库表前缀。）

你会看到类似这样的字符串：

a:2:{i:0;s:16:"akismet/akismet.php";i:1;s:26:"woocommerce/woocommerce.php";}

这个字符串就是序列化后的数组。你可以使用 PHP 的 unserialize() 函数将它转换回 PHP 数组：

$serialized_data = get_option( 'active_plugins' );
$active_plugins = unserialize( $serialized_data );

print_r( $active_plugins );

第八幕：表格总结，一目了然

为了方便大家理解，我用一个表格来总结一下今天讲的内容：

函数名	作用	适用环境	参数	返回值
`is_plugin_active()`	判断一个插件是否已经激活	所有环境	`$plugin` (插件主文件路径)	`true` 或 `false`
`is_plugin_active_for_network()`	判断一个插件是否在整个网络范围内激活	多站点环境	`$plugin` (插件主文件路径)	`true` 或 `false`
`get_option( 'active_plugins' )`	获取所有已激活插件的列表 (序列化数组)	所有环境	无	序列化数组
`get_site_option( 'active_sitewide_plugins' )`	获取所有网络激活插件的列表 (序列化数组)	多站点环境	无	序列化数组

第九幕：扩展阅读，更上一层楼

如果你想更深入地了解 WordPress 插件激活的机制，可以阅读以下资料：

WordPress 官方文档：https://developer.wordpress.org/reference/functions/is_plugin_active/
WordPress 插件开发教程：https://developer.wordpress.org/plugins/

第十幕：谢幕，结束语

好了，今天的讲座就到这里。希望大家通过今天的学习，对 is_plugin_active() 函数有了更深入的了解。记住，掌握这些基础知识，才能更好地开发 WordPress 插件，打造更强大的网站。

下次有机会再和大家分享更多有趣的 WordPress 技术。拜拜！

发表回复 取消回复

发表回复取消回复