deactivate_plugins( string|string[] $plugins, bool $silent = false, bool|null $network_wide = null )

Deactivates a single plugin or multiple plugins.

Contents

Description

The deactivation hook is disabled by the plugin upgrader by using the $silent parameter.

Top ↑

Parameters

$plugins string|string[] Required
Single plugin or list of plugins to deactivate.
$silent bool Optional
Prevent calling deactivation hooks.

Default: false

$network_wide bool|null Optional
Whether to deactivate the plugin for all sites in the network.
A value of null will deactivate plugins for both the network and the current site. Multisite only.

Default: null

Top ↑

More Information

This function is often used by a plugin to deactivate itself if the plugin requires the presence of certain features that are missing in environment after an administrator has activated it. This is usually the last step in a dependency-checking function.

Top ↑

Source

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

function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
	if ( is_multisite() ) {
		$network_current = get_site_option( 'active_sitewide_plugins', array() );
	}
	$current    = get_option( 'active_plugins', array() );
	$do_blog    = false;
	$do_network = false;

	foreach ( (array) $plugins as $plugin ) {
		$plugin = plugin_basename( trim( $plugin ) );
		if ( ! is_plugin_active( $plugin ) ) {
			continue;
		}

		$network_deactivating = ( false !== $network_wide ) && is_plugin_active_for_network( $plugin );

		if ( ! $silent ) {
			/**
			 * Fires before a plugin is deactivated.
			 *
			 * If a plugin is silently deactivated (such as during an update),
			 * this hook does not fire.
			 *
			 * @since 2.9.0
			 *
			 * @param string $plugin               Path to the plugin file relative to the plugins directory.
			 * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network
			 *                                     or just the current site. Multisite only. Default false.
			 */
			do_action( 'deactivate_plugin', $plugin, $network_deactivating );
		}

		if ( false !== $network_wide ) {
			if ( is_plugin_active_for_network( $plugin ) ) {
				$do_network = true;
				unset( $network_current[ $plugin ] );
			} elseif ( $network_wide ) {
				continue;
			}
		}

		if ( true !== $network_wide ) {
			$key = array_search( $plugin, $current, true );
			if ( false !== $key ) {
				$do_blog = true;
				unset( $current[ $key ] );
			}
		}

		if ( $do_blog && wp_is_recovery_mode() ) {
			list( $extension ) = explode( '/', $plugin );
			wp_paused_plugins()->delete( $extension );
		}

		if ( ! $silent ) {
			/**
			 * Fires as a specific plugin is being deactivated.
			 *
			 * This hook is the "deactivation" hook used internally by register_deactivation_hook().
			 * The dynamic portion of the hook name, `$plugin`, refers to the plugin basename.
			 *
			 * If a plugin is silently deactivated (such as during an update), this hook does not fire.
			 *
			 * @since 2.0.0
			 *
			 * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
			 *                                   or just the current site. Multisite only. Default false.
			 */
			do_action( "deactivate_{$plugin}", $network_deactivating );

			/**
			 * Fires after a plugin is deactivated.
			 *
			 * If a plugin is silently deactivated (such as during an update),
			 * this hook does not fire.
			 *
			 * @since 2.9.0
			 *
			 * @param string $plugin               Path to the plugin file relative to the plugins directory.
			 * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network
			 *                                     or just the current site. Multisite only. Default false.
			 */
			do_action( 'deactivated_plugin', $plugin, $network_deactivating );
		}
	}

	if ( $do_blog ) {
		update_option( 'active_plugins', $current );
	}
	if ( $do_network ) {
		update_site_option( 'active_sitewide_plugins', $network_current );
	}
}

View on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Uses

Uses
Uses Description
wp_is_recovery_mode() wp-includes/load.php

Determines whether WordPress is in Recovery Mode.
wp_paused_plugins() wp-includes/error-protection.php

Get the instance for storing paused plugins.
is_plugin_active() wp-admin/includes/plugin.php

Determines whether a plugin is active.
is_plugin_active_for_network() wp-admin/includes/plugin.php

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

Gets the basename of a plugin.
update_site_option() wp-includes/option.php

Updates the value of an option that was already added for the current network.
is_multisite() wp-includes/load.php

Determines whether Multisite is enabled.
do_action() wp-includes/plugin.php

Calls the callback functions that have been added to an action hook.
get_site_option() wp-includes/option.php

Retrieve an option value for the current network based on name of option.
update_option() wp-includes/option.php

Updates the value of an option that was already added.
get_option() wp-includes/option.php

Retrieves an option value based on an option name.
Show 6 more uses Hide more uses

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: 1You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Example

    /**
 * Deactivate plugin example class.
 */
class WPDocs_Deactivate_Plugin {

	/**
	 * Constructor.
	 */
	public function __construct() {
		register_activation_hook( __FILE__, array( $this , 'activate' ) );
	}

	/**
	 * Attempts to activate the plugin if at least PHP 5.4.
	 */
	public function activate() {
		// Check PHP Version and deactivate & die if it doesn't meet minimum requirements.
		if ( version_compare( PHP_VERSION, '5.4', '<=' ) ) {
			deactivate_plugins( plugin_basename( __FILE__ ) );
			wp_die( __( 'This plugin requires PHP Version 5.4 or greater.  Sorry about that.', 'textdomain' ) );
		}
		
		// Do activate Stuff now.
	}
}
new WPDocs_Deactivate_Plugin();
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by Aurovrata Venet —

    If you need to keep checking the dependency of another plugin, then you can hook the `admin_init` action to automatically deactivate the plugin should the other plugin be deactivated by administrator,

    add_action( 'admin_init', 'wpdocs_check_plugin_dependency' );
function wpdocs_check_plugin_dependency() {
  // make sure to add your own plugin active check to stop looping over the wp_die call.
  if ( ! is_plugin_active( 'wpdocs-some-other-plugin/plugin.php' ) && is_plugin_active( 'wpdocs-my-cool-plugin/plugin.php' ) ) {
    deactivate_plugins( 'wpdocs-my-cool-plugin/plugin.php' );
        
    $button = '<a href="' . esc_attr( network_admin_url( 'plugins.php' ) . '" rel="nofollow ugc">Return to Plugins</a>';
    wp_die( 'My Cool Plugin requires Some Other Plugin, and has therefore been deactivated!' . $button );
  }
}
  3. Skip to note 3 content
    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
    Contributed by Benji Kostenbader —

    The “Plugin name” in the docs is referring to the plugin_basename, the relative path for your plugin itself. For example, if your plugin resides in wp-content/plugins/my-custom-plugin/my-custom-plugin.php, the plugin_basename you’d use for this function is my-custom-plugin/my-custom-plugin.php.

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