Plugin_Upgrader::active_before( bool|WP_Error $response, array $plugin ): bool|WP_Error
- Since
- 5.4.0
- Source
wp-admin/includes/class-plugin-upgrader.php:597
Description
Hooked to the 'upgrader_pre_install' filter by Plugin_Upgrader::upgrade().
Compatibility
- WordPress
- since 5.4.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$responsebool|WP_Error- The installation response before the installation has started.
$pluginarray- Plugin package arguments.
Return value
bool|WP_Error- The original
$responseparameter or WP_Error.
Performance profile
How much work a call to Plugin_Upgrader::active_before() 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
- Moderate
- Scaling
- Constant
- Instructions
- 7–24
- Plugin surface
- None
- Called by
- 0
Reads stored settings via get_option(), cached per request but not free on a cold cache.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 28.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
do_action()one call below Plugin_Upgrader::active_before() - optionoption read or write
get_option()one call below Plugin_Upgrader::active_before()
Further down the call graph this can also reach cache, serialize, 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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost Plugin_Upgrader::active_before() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_wp_error() | 7 | is_wp_error() |
!is_wp_error() && !wp_doing_cron() | 10 | is_wp_error(), wp_doing_cron() |
!is_wp_error() && wp_doing_cron() | 18–21 | is_wp_error(), wp_doing_cron(), is_plugin_active() |
!is_wp_error() && wp_doing_cron() && is_plugin_active() | 23–24 | is_wp_error(), wp_doing_cron(), is_plugin_active(), ->maintenance_mode() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 28 | 7–24 | 5 | |
| 8.5 | 28 | 7–24 | 5 | |
| 8.4 | 28 | 7–24 | 5 | |
| 8.3 | 28 | 7–24 | 5 | |
| 8.2 | 28 | 7–24 | 5 | |
| 8.1 | 28 | 7–24 | 5 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 29 | 7–25 | 5 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 4
- is_wp_error()Checks whether the given variable is a WordPress Error.
- wp_doing_cron()Determines whether the current request is a WordPress cron request.
- is_plugin_active()Determines whether a plugin is active.
- Plugin_Upgrader::maintenance_mode()
Source code
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
Introduced in 5.4.0. Unchanged from 6.7.7 through 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/class-plugin-upgrader.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.