探究 WordPress `is_plugin_active()` 函数的源码：如何通过 `active_plugins` 选项判断插件是否激活。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

大家好，欢迎来到今天的 WordPress 源码探秘小课堂！今天我们要扒一扒 WordPress 中一个非常重要且常用的函数：is_plugin_active()。别看它名字平平无奇，但它可是判断插件是否激活的关键人物。

开场白：插件激活的幕后英雄

想象一下，你安装了一堆 WordPress 插件，有的激活了，有的还在沉睡。你的网站怎么知道哪些插件应该启动，哪些应该继续冬眠呢？这就是 is_plugin_active() 函数的任务。它就像一个侦探，专门调查 active_plugins 这个关键证据，然后告诉你哪个插件在工作，哪个在摸鱼。

is_plugin_active() 函数的源码剖析

让我们直接进入正题，看看 is_plugin_active() 函数的真面目。它的定义位于 wp-includes/plugin.php 文件中（WordPress 版本可能会有细微差异，但基本原理不变）。

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

代码很简单，对吧？但麻雀虽小，五脏俱全。让我们一步步拆解它。

参数：$plugin

$plugin 参数是你要检查的插件的文件名。记住，是文件名，不是插件的文件夹名或者插件的名称。通常，这个文件名会是类似 my-awesome-plugin/my-awesome-plugin.php 这样的形式。也就是说，是插件主文件的相对路径。
get_option( 'active_plugins', array() )

这部分代码是关键。 get_option() 函数是 WordPress 用来获取选项值的。 'active_plugins' 是选项的名称。这个选项存储了一个数组，包含了所有已激活插件的文件名。

如果 active_plugins 选项不存在（比如，你的网站刚安装完，还没激活任何插件），那么 get_option() 函数会返回第二个参数，也就是一个空数组 array()。这样可以避免出现错误。

get_option 函数返回的数据类型可能是字符串或者数组，为了保证后续 in_array 函数的正常运行，我们将其强制转换为数组 (array)。
in_array( $plugin, (array) get_option( 'active_plugins', array() ), true )

in_array() 函数是 PHP 的内置函数，用于检查一个值是否存在于一个数组中。
- 第一个参数 $plugin 是我们要查找的值（插件的文件名）。
- 第二个参数 (array) get_option( 'active_plugins', array() ) 是我们要搜索的数组（已激活插件的文件名数组）。
- 第三个参数 true 是 in_array() 函数的严格模式标志。如果设置为 true，in_array() 会同时比较值和类型。这很重要，因为我们需要确保插件的文件名字符串完全匹配，而不是进行类型转换后的比较。
如果 $plugin 存在于 active_plugins 数组中，in_array() 函数会返回 true，表示插件已激活。否则，返回 false。

active_plugins 选项：插件激活的秘密基地

现在我们知道了 is_plugin_active() 函数的核心在于读取 active_plugins 选项。那么，active_plugins 选项到底是什么样子呢？让我们深入了解一下。

active_plugins 选项存储在 wp_options 数据表中。这是一个 WordPress 的核心数据表，用于存储各种网站设置和选项。

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

SELECT option_value FROM wp_options WHERE option_name = 'active_plugins';

查询结果可能看起来像这样：

a:2:{i:0;s:29:"akismet/akismet.php";i:1;s:41:"hello-dolly/hello.php";}

这看起来像一堆乱码，对吧？其实，这是 PHP 的序列化字符串。序列化是一种将 PHP 数据结构（比如数组、对象）转换为字符串的过程，以便存储在数据库或文件中。

我们可以使用 PHP 的 unserialize() 函数将这个字符串转换回 PHP 数组：

$serialized_data = 'a:2:{i:0;s:29:"akismet/akismet.php";i:1;s:41:"hello-dolly/hello.php";}';
$active_plugins = unserialize( $serialized_data );

print_r( $active_plugins );

输出结果：

Array
(
    [0] => akismet/akismet.php
    [1] => hello-dolly/hello.php
)

现在清楚多了！这是一个包含了已激活插件文件名的数组。在这个例子中，akismet/akismet.php 和 hello-dolly/hello.php 插件都已激活。

is_plugin_active() 函数的实际应用

is_plugin_active() 函数在 WordPress 开发中有很多应用场景。以下是一些常见的例子：

根据插件是否激活来加载不同的功能

if ( is_plugin_active( 'my-awesome-plugin/my-awesome-plugin.php' ) ) {
    // 插件已激活，加载相关功能
    add_action( 'wp_enqueue_scripts', 'my_awesome_plugin_enqueue_scripts' );
} else {
    // 插件未激活，显示提示信息
    add_action( 'admin_notices', 'my_awesome_plugin_admin_notice' );
}

在插件设置页面显示插件状态

function my_plugin_settings_page() {
    $plugin_file = 'my-awesome-plugin/my-awesome-plugin.php';
    $is_active = is_plugin_active( $plugin_file );

    echo '<p>Plugin Status: ' . ( $is_active ? 'Active' : 'Inactive' ) . '</p>';
}

在主题中集成插件功能

if ( is_plugin_active( 'woocommerce/woocommerce.php' ) ) {
    // WooCommerce 插件已激活，显示购物车图标
    echo '<a href="' . wc_get_cart_url() . '">Cart</a>';
}

is_plugin_active() 函数的局限性

虽然 is_plugin_active() 函数非常有用，但它也有一些局限性：

只能判断插件是否激活，不能判断插件是否安装

is_plugin_active() 函数只能告诉你一个插件是否已激活。如果插件根本没有安装，is_plugin_active() 函数会返回 false。如果你需要判断插件是否已安装，可以使用 is_plugin_installed() 函数（这个函数需要自己实现，WordPress 并没有提供原生的 is_plugin_installed() 函数，但有很多实现方式，比如检查插件目录是否存在）。
依赖于 active_plugins 选项

is_plugin_active() 函数依赖于 active_plugins 选项。如果这个选项被篡改或损坏，is_plugin_active() 函数可能会返回错误的结果。虽然这种情况很少发生，但仍然需要注意。
无法处理网络激活的插件（在 WordPress Multisite 中）

在 WordPress Multisite 环境中，插件可以在整个网络范围内激活（网络激活）或者在单个站点上激活。 is_plugin_active() 只能检测到在当前站点上激活的插件，无法检测到网络激活的插件。如果你需要在 Multisite 环境中检测网络激活的插件，你需要使用 is_plugin_active_for_network() 函数。

更高级的插件激活状态检测：is_plugin_active_for_network()

对于 WordPress Multisite 环境，is_plugin_active() 函数就显得力不从心了。为了解决这个问题，WordPress 提供了 is_plugin_active_for_network() 函数。它可以检测插件是否在整个网络范围内激活。

is_plugin_active_for_network() 函数的定义位于 wp-includes/plugin.php 文件中。

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;
}

让我们分析一下这段代码：

if ( ! is_multisite() ) { return false; }

首先，函数检查当前是否是 WordPress Multisite 环境。如果不是，直接返回 false，因为网络激活的概念只存在于 Multisite 环境中。
$plugins = get_site_option( 'active_sitewide_plugins' );

get_site_option() 函数类似于 get_option()，但它用于获取站点选项（而不是单个博客的选项）。 'active_sitewide_plugins' 是存储网络激活插件的选项名称。这个选项存储了一个关联数组，键是插件的基本文件名（例如 akismet/akismet.php），值通常是 1。
if ( isset( $plugins[ plugin_basename( $plugin ) ] ) ) { return true; }

plugin_basename() 函数用于获取插件的基本文件名。例如，plugin_basename( 'akismet/akismet.php' ) 会返回 akismet/akismet.php。

然后，函数检查 $plugins 数组中是否存在以插件基本文件名作为键的元素。如果存在，表示插件已网络激活，返回 true。

is_plugin_active_for_network() 的应用场景

is_plugin_active_for_network() 函数主要用于 WordPress Multisite 环境，用于判断插件是否在整个网络范围内激活。

例如，你可能希望在网络激活的插件中添加一些全局设置，或者在主题中集成网络激活插件的功能。

if ( is_plugin_active_for_network( 'my-awesome-plugin/my-awesome-plugin.php' ) ) {
    // 插件已网络激活，添加全局设置
    add_action( 'network_admin_menu', 'my_awesome_plugin_network_admin_menu' );
}

总结：插件激活状态的侦探

is_plugin_active() 和 is_plugin_active_for_network() 函数是 WordPress 中用于检测插件激活状态的重要工具。它们通过读取 active_plugins 和 active_sitewide_plugins 选项来判断插件是否已激活。

函数	作用	适用环境	依赖的选项
`is_plugin_active()`	判断插件是否在当前站点上激活	单站点和 Multisite	`active_plugins`
`is_plugin_active_for_network()`	判断插件是否在整个网络范围内激活	仅 Multisite	`active_sitewide_plugins`

掌握了这两个函数，你就可以在你的插件和主题中灵活地控制插件功能，并为用户提供更好的体验。

彩蛋：一个自定义的 is_plugin_installed() 函数

正如之前提到的，WordPress 并没有提供原生的 is_plugin_installed() 函数。但我们可以自己实现一个。以下是一个简单的例子：

function is_plugin_installed( $plugin_file ) {
    $path = WP_PLUGIN_DIR . '/' . $plugin_file;
    return file_exists( $path );
}

这个函数通过检查插件文件是否存在来判断插件是否已安装。虽然简单，但在很多情况下都足够使用。

结束语：源码探索的乐趣

希望今天的讲座能够帮助你更好地理解 is_plugin_active() 函数以及 WordPress 插件激活机制。源码探索是一个不断学习和发现的过程。希望大家能够保持好奇心，继续探索 WordPress 的更多奥秘！

今天的课程就到这里，感谢大家！下次再见！

发表回复 取消回复

发表回复取消回复