is_plugin_inactive()

💡 云策文档标注

概述

is_plugin_inactive() 是 WordPress 核心函数，用于判断指定插件是否处于未激活状态。它是 is_plugin_active() 的反向函数，通常用作回调函数。

关键要点

函数功能：检查插件是否未激活，返回布尔值（True 表示未激活，False 表示激活）
参数：$plugin（字符串，必需），插件文件相对于 plugins 目录的路径
依赖关系：需要先加载 wp-admin/includes/plugin.php 文件才能使用此函数
使用场景：常用于后台管理区域、主题或插件开发中，作为条件判断

代码示例

// 确保函数已定义再使用
if ( ! function_exists( 'is_plugin_inactive' ) ) {
    require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
}

if ( is_plugin_inactive( 'plugin-directory/plugin-file.php' ) ) {
    // 插件未激活时的处理代码
}

注意事项

此函数并非始终可用，在插件主文件中直接使用可能导致致命错误，需先检查函数是否存在并加载必要文件

📄 原文内容

Determines whether the plugin is inactive.

Description

Reverse of is_plugin_active() . Used as a callback.

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 inactive. False if active.

More Information

Usage:

In the Admin Area:

In the front end, in a theme, etc…

Source

function is_plugin_inactive( $plugin ) {
	return ! is_plugin_active( $plugin );
}

View all references View on Trac View on GitHub

Uses	Description
is_plugin_active()`wp-admin/includes/plugin.php`	Determines whether a plugin is active.

Used by	Description
WP_Plugin_Dependencies::check_plugin_dependencies_during_ajax()`wp-includes/class-wp-plugin-dependencies.php`	Checks plugin dependencies after a plugin is installed via AJAX.
WP_Plugin_Dependencies::has_unmet_dependencies()`wp-includes/class-wp-plugin-dependencies.php`	Determines whether the plugin has unmet dependencies.
validate_plugin_requirements()`wp-admin/includes/plugin.php`	Validates the plugin requirements for WordPress version and PHP version.
do_block_editor_incompatible_meta_box()`wp-admin/includes/template.php`	Renders a “fake” meta box with an information message, shown on the block editor, when an incompatible meta box is found.
wp_ajax_install_plugin()`wp-admin/includes/ajax-actions.php`	Handles installing a plugin via AJAX.
WP_Automatic_Updater::update()`wp-admin/includes/class-wp-automatic-updater.php`	Updates an item, if appropriate.
wp_link_manager_disabled_message()`wp-admin/includes/bookmark.php`	Outputs the ‘disabled’ message for the WordPress Link Manager.

Show 2 more Show less

Changelog

Version	Description
3.1.0	Introduced.

User Contributed Notes

Skip to note 3 content

Codex

10 years ago

Example

// Makes sure the function is defined before trying to use it
if ( ! function_exists( 'is_plugin_inactive' ) ) {
    require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
}

if ( is_plugin_inactive( 'plugin-directory/plugin-file.php' ) ) {
    //plugin is not activated
}

Skip to note 4 content

Gerard Reches

2 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Notice that this function is not available at all times. Using it in your plugin’s main file will result in a fatal error.

Log in to add feedback

云策 WordPress 开发者社区

函数文档