云策 WordPress 开发者社区

函数文档

is_plugin_active()

查看官方原文 ↗
💡 云策文档标注

概述

is_plugin_active() 函数用于检查指定插件是否处于激活状态。它仅适用于 plugins/ 目录下的插件，对于 mu-plugins/ 目录下的插件会返回 false。

关键要点

  • 函数接受一个必需参数：插件文件相对于 plugins 目录的路径字符串。
  • 返回布尔值：true 表示插件在激活列表中，false 表示不在。
  • 函数内部通过检查 active_plugins 选项或使用 is_plugin_active_for_network() 来判断插件状态。
  • 注意：此函数不适用于 must-use 插件，且建议直接使用函数而非复制其定义，以保持兼容性。

代码示例

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

注意事项

  • 函数可在前端和后端使用，但需确保正确包含相关文件（如使用 include_once）。
  • 相关函数包括 is_plugin_active_for_network() 和 get_option()，用于扩展功能。
📄 原文内容

Determines whether a plugin is active.

Description

Only plugins installed in the plugins/ folder can be active.

Plugins in the mu-plugins/ folder can’t be “activated,” so this function will return false for those plugins.

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.

Parameters

$pluginstringrequired
Path to the plugin file relative to the plugins directory.

Return

bool True, if in the active plugins list. False, not in the list.

Source

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

View all references View on Trac View on GitHub

Uses Description
is_plugin_active_for_network()wp-admin/includes/plugin.php

Determines whether the plugin is active for the entire network.
get_option()wp-includes/option.php

Retrieves an option value based on an option name.
Used by Description
WP_Debug_Data::get_wp_plugins_raw_data()wp-admin/includes/class-wp-debug-data.php

Gets the raw plugin data for the WordPress active and inactive sections of the debug data.
WP_Plugin_Dependencies::has_active_dependents()wp-includes/class-wp-plugin-dependencies.php

Determines whether the plugin has active dependents.
wp_ajax_activate_plugin()wp-admin/includes/ajax-actions.php

Handles activating a plugin via AJAX.
wp_get_plugin_action_button()wp-admin/includes/plugin-install.php

Gets the markup for the plugin install action button.
WP_Plugins_List_Table::add_dependencies_to_dependent_plugin_row()wp-admin/includes/class-wp-plugins-list-table.php

Prints a list of other plugins that the plugin depends on.
WP_REST_Plugins_Controller::get_plugin_status()wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Get’s the activation status for a plugin.
WP_REST_Plugins_Controller::check_read_permission()wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Checks if the given plugin can be viewed by the current user.
WP_REST_Plugins_Controller::delete_item()wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Deletes one plugin from the site.
Plugin_Upgrader::active_before()wp-admin/includes/class-plugin-upgrader.php

Turns on maintenance mode before attempting to background update an active plugin.
Plugin_Upgrader::active_after()wp-admin/includes/class-plugin-upgrader.php

Turns off maintenance mode after upgrading an active plugin.
WP_Site_Health::get_test_plugin_version()wp-admin/includes/class-wp-site-health.php

Tests if plugins are outdated, or unnecessary.
is_plugin_paused()wp-admin/includes/plugin.php

Determines whether a plugin is technically active but was paused while loading.
wp_load_press_this()wp-admin/press-this.php
wp_ajax_delete_plugin()wp-admin/includes/ajax-actions.php

Handles deleting a plugin via AJAX.
wp_ajax_press_this_add_category()wp-includes/deprecated.php

Ajax handler for creating new category from Press This.
wp_ajax_press_this_save_post()wp-includes/deprecated.php

Ajax handler for saving a post from Press This.
WP_Automatic_Updater::update()wp-admin/includes/class-wp-automatic-updater.php

Updates an item, if appropriate.
Plugin_Upgrader::bulk_upgrade()wp-admin/includes/class-plugin-upgrader.php

Upgrades several plugins at once.
Plugin_Upgrader::deactivate_plugin_before_upgrade()wp-admin/includes/class-plugin-upgrader.php

Deactivates a plugin before it is upgraded.
WP_Plugins_List_Table::single_row()wp-admin/includes/class-wp-plugins-list-table.php
WP_Plugins_List_Table::prepare_items()wp-admin/includes/class-wp-plugins-list-table.php
Plugin_Installer_Skin::after()wp-admin/includes/class-plugin-installer-skin.php

Performs an action following a plugin install.
Plugin_Upgrader_Skin::__construct()wp-admin/includes/class-plugin-upgrader-skin.php

Constructor.
wp_plugin_update_row()wp-admin/includes/update.php

Displays update information for a plugin.
is_plugin_inactive()wp-admin/includes/plugin.php

Determines whether the plugin is inactive.
deactivate_plugins()wp-admin/includes/plugin.php

Deactivates a single plugin or multiple plugins.

Show 21 moreShow less

Changelog

Version Description
2.5.0 Introduced.

User Contributed Notes