W3cubDocs

/WordPress

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

Turns on maintenance mode before attempting to background update an active plugin.

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 active_before( $return, $plugin ) {
		if ( is_wp_error( $return ) ) {
			return $return;
		}

		// Only enable maintenance mode when in cron (background update).
		if ( ! wp_doing_cron() ) {
			return $return;
		}

		$plugin = isset( $plugin['plugin'] ) ? $plugin['plugin'] : '';

		// Only run if plugin is active.
		if ( ! is_plugin_active( $plugin ) ) {
			return $return;
		}

		// Change to maintenance mode. Bulk edit handles this separately.
		if ( ! $this->bulk ) {
			$this->maintenance_mode( true );
		}

		return $return;
	}

Uses

Uses Description
wp-includes/load.php: wp_doing_cron()

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

Determines whether a plugin is active.
wp-includes/load.php: is_wp_error()

Check whether variable is a WordPress Error.

Changelog

Version Description
5.4.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/plugin_upgrader/active_before