Plugin_Upgrader::deactivate_plugin_before_upgrade( bool|WP_Error $return, array $plugin )

Deactivates a plugin before it is upgraded.

Description

Hooked to the ‘upgrader_pre_install’ filter by Plugin_Upgrader::upgrade().

Parameters

$return

(bool|WP_Error) (Required) Upgrade offer return.

$plugin

(array) (Required) Plugin package arguments.

Return

(bool|WP_Error) The passed in $return param or WP_Error.

Source

File: wp-admin/includes/class-plugin-upgrader.php 

	public function deactivate_plugin_before_upgrade($return, $plugin) {

		if ( is_wp_error($return) ) //Bypass.
			return $return;

		// When in cron (background updates) don't deactivate the plugin, as we require a browser to reactivate it
		if ( wp_doing_cron() )
			return $return;

		$plugin = isset($plugin['plugin']) ? $plugin['plugin'] : '';
		if ( empty($plugin) )
			return new WP_Error('bad_request', $this->strings['bad_request']);

		if ( is_plugin_active($plugin) ) {
			//Deactivate the plugin silently, Prevent deactivation hooks from running.
			deactivate_plugins($plugin, true);
		}

		return $return;
	}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/class-wp-error.php: WP_Error::__construct()

Initialize the error.
wp-includes/load.php: is_wp_error()

Check whether variable is a ClassicPress Error.
wp-includes/load.php: wp_doing_cron()

Determines whether the current request is a ClassicPress cron request.
wp-admin/includes/plugin.php: deactivate_plugins()

Deactivate a single plugin or multiple plugins.
wp-admin/includes/plugin.php: is_plugin_active()

Check whether a plugin is active.

Changelog

Changelog
Version Description
WP-4.1.0 Added a return value.
WP-2.8.0 Introduced.