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

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

$responsebool|WP_Errorrequired
The installation response before the installation has started.
$pluginarrayrequired
Plugin package arguments.

Return

bool|WP_Error The original $response parameter or WP_Error.

Source

public function active_before( $response, $plugin ) {
	if ( is_wp_error( $response ) ) {
		return $response;
	}

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

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

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

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

	return $response;
}

Changelog

VersionDescription
5.4.0Introduced.

User Contributed Notes

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