is_plugin_active( string $plugin ): bool

Determines whether a plugin is active.

Contents

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.

Top ↑

Parameters

$plugin string Required
Path to the plugin file relative to the plugins directory.

Top ↑

Return

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

Top ↑

Source

File: wp-admin/includes/plugin.php. View all references 

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

View on Trac View on GitHub

Top ↑

Top ↑

Used By

Used By
Used By Description
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_Debug_Data::debug_data() wp-admin/includes/class-wp-debug-data.php

Static function for generating site debug data when required.
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.
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.
WP_Plugin_Install_List_Table::display_rows() wp-admin/includes/class-wp-plugin-install-list-table.php
Show 17 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 11You must log in to vote on the helpfulness of this note
    Contributed by Jonas Lundman — 
    <?php
/**
 * Detect plugin. For use on Front End and Back End.
 */
 
// check for plugin using plugin name
if(in_array('plugin-directory/plugin-file.php', apply_filters('active_plugins', get_option('active_plugins')))){ 
	//plugin is activated
}
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 8You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Front end 

    <?php
/**
 * Detect plugin. For frontend only.
 */
include_once ABSPATH . 'wp-admin/includes/plugin.php';

// check for plugin using plugin name
if ( is_plugin_active( 'plugin-directory/plugin-file.php' ) ) {
	//plugin is activated
}
  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Admin area 

    <?php
/**
 * Detect plugin. For use in Admin area only.
 */
if ( is_plugin_active( 'plugin-directory/plugin-file.php' ) ) {
	//plugin is activated
}

You must log in before being able to contribute a note or feedback.