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

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$pluginsstring|string[]

Single plugin or list of plugins to deactivate.

$silentbooloptional

Prevent calling deactivation hooks. Default false.Default: false

$network_widebool|nulloptional

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.Default: null

Performance profile

How much work a call to deactivate_plugins() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads stored settings via get_site_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

19–33

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 105.

Plugin surface

3 hooks

Third-party callbacks on 'deactivate_plugin', 'deactivate_{$plugin}', 'deactivated_plugin' run inside this call, and their cost is not bounded by anything here.

Called by

6

6 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionnetwork optionget_site_option()called directly
• hookthird-party callbacksdo_action()called directly
• cacheobject cachewp_cache_get()one call below deactivate_plugins()
• serializeserialisationmaybe_unserialize()one call below deactivate_plugins()

Further down the call graph this can also reach query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 8 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost deactivate_plugins() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 3

3 hooks fire while deactivate_plugins() runs, in this order:

1. 1
   do_action( deactivate_plugin )actionline 787 (+29 into the body)

   Fires before a plugin is deactivated.

2. 2
   do_action( deactivate_{$plugin} )actionline 826 (+68 into the body)

   Fires before a plugin is deactivated.

3. 3
   do_action( deactivated_plugin )actionline 840 (+82 into the body)

   Fires after a plugin is deactivated.

Uses · 12

• is_multisite()Determines whether Multisite is enabled.
• get_site_option()Retrieve an option value for the current network based on name of option.
• get_option()Retrieves an option value based on an option name.
• plugin_basename()Gets the basename of a plugin.
• is_plugin_active()Determines whether a plugin is active.
• is_plugin_active_for_network()Determines whether the plugin is active for the entire network.
• do_action()Calls the callback functions that have been added to an action hook.
• wp_is_recovery_mode()Determines whether WordPress is in Recovery Mode.
• wp_paused_plugins()Get the instance for storing paused plugins.
• update_option()Updates the value of an option that was already added.
• update_site_option()Updates the value of an option that was already added for the current network.
• wp_paused_plugins()::delete()

Used by · 6

• Plugin_Upgrader::deactivate_plugin_before_upgrade()Deactivates a plugin before it is upgraded.
• WP_REST_Plugins_Controller::handle_plugin_status()Handle updating a plugin's status.
• _upgrade_440_force_deactivate_incompatible_plugins()
• _upgrade_core_deactivate_incompatible_plugins()
• upgrade_380()Execute changes made in WordPress 3.8.0.
• validate_active_plugins()Validates active plugins.

Source code

View on Trac ↗View on GitHub ↗

758function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {759	if ( is_multisite() ) {760		$network_current = get_site_option( 'active_sitewide_plugins', array() );761	}762	$current    = get_option( 'active_plugins', array() );763	$do_blog    = false;764	$do_network = false;765 766	foreach ( (array) $plugins as $plugin ) {767		$plugin = plugin_basename( trim( $plugin ) );768		if ( ! is_plugin_active( $plugin ) ) {769			continue;770		}771 772		$network_deactivating = ( false !== $network_wide ) && is_plugin_active_for_network( $plugin );773 774		if ( ! $silent ) {775			/**776			 * Fires before a plugin is deactivated.777			 *778			 * If a plugin is silently deactivated (such as during an update),779			 * this hook does not fire.780			 *781			 * @since 2.9.0782			 *783			 * @param string $plugin               Path to the plugin file relative to the plugins directory.784			 * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network785			 *                                     or just the current site. Multisite only. Default false.786			 */787			do_action( 'deactivate_plugin', $plugin, $network_deactivating );788		}789 790		if ( false !== $network_wide ) {791			if ( is_plugin_active_for_network( $plugin ) ) {792				$do_network = true;793				unset( $network_current[ $plugin ] );794			} elseif ( $network_wide ) {795				continue;796			}797		}798 799		if ( true !== $network_wide ) {800			$key = array_search( $plugin, $current, true );801			if ( false !== $key ) {802				$do_blog = true;803				unset( $current[ $key ] );804			}805		}806 807		if ( $do_blog && wp_is_recovery_mode() ) {808			list( $extension ) = explode( '/', $plugin );809			wp_paused_plugins()->delete( $extension );810		}811 812		if ( ! $silent ) {813			/**814			 * Fires as a specific plugin is being deactivated.815			 *816			 * This hook is the "deactivation" hook used internally by register_deactivation_hook().817			 * The dynamic portion of the hook name, `$plugin`, refers to the plugin basename.818			 *819			 * If a plugin is silently deactivated (such as during an update), this hook does not fire.820			 *821			 * @since 2.0.0822			 *823			 * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network824			 *                                   or just the current site. Multisite only. Default false.825			 */826			do_action( "deactivate_{$plugin}", $network_deactivating );827 828			/**829			 * Fires after a plugin is deactivated.830			 *831			 * If a plugin is silently deactivated (such as during an update),832			 * this hook does not fire.833			 *834			 * @since 2.9.0835			 *836			 * @param string $plugin               Path to the plugin file relative to the plugins directory.837			 * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network

Changelog

Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-admin/includes/plugin.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.