Plugin_Upgrader::active_before() WordPress Method
The Plugin_Upgrader::active_before() method is called before a plugin is updated. This is a useful place to do any checks or tasks that need to be done before the plugin is updated.
Plugin_Upgrader::active_before( bool|WP_Error $response, 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
- $response
(bool|WP_Error)(Required)The installation response before the installation has started.
- $plugin
(array)(Required)Plugin package arguments.
Return
(bool|WP_Error) The original $response
parameter or WP_Error.
Source
File: wp-admin/includes/class-plugin-upgrader.php
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; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.4.0 | Introduced. |