WP_REST_Plugins_Controller::handle_plugin_status( string $plugin, string $new_status, string $current_status ): true|WP_Error
- Since
- 5.5.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php:734
Compatibility
- WordPress
- since 5.5.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
$pluginstring- The plugin file to update.
$new_statusstring- The plugin's new status.
$current_statusstring- The plugin's current status.
Return value
true|WP_Error
Performance profile
How much work a call to WP_REST_Plugins_Controller::handle_plugin_status() 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
- 10–32
- Plugin surface
- None
- Called by
- 2
Reads stored settings via get_site_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 50.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionnetwork option
get_site_option()one call below WP_REST_Plugins_Controller::handle_plugin_status() - hookthird-party callbacks
do_action()one call below WP_REST_Plugins_Controller::handle_plugin_status()
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 · 7 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Plugins_Controller::handle_plugin_status() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$new_status !== "inactive" && $new_status === "active" && $current_status === "network-active" | 10 | none |
$new_status === "inactive" | 12 | deactivate_plugins() |
$new_status !== "inactive" && !is_wp_error() | 22–25 | is_multisite(), activate_plugin(), is_wp_error() |
$new_status !== "inactive" && is_multisite() && $new_status !== "network-active" && is_network_only_plugin() | 25–27 | is_multisite(), is_network_only_plugin(), __() |
$new_status !== "inactive" && is_wp_error() | 25–28 | is_multisite(), activate_plugin(), is_wp_error(), ->add_data() |
$new_status !== "inactive" && is_multisite() && $new_status !== "network-active" && !is_network_only_plugin() && !is_wp_error() | 27–29 | is_multisite(), is_network_only_plugin(), activate_plugin(), is_wp_error() |
$new_status !== "inactive" && is_multisite() && $new_status !== "network-active" && !is_network_only_plugin() && is_wp_error() | 30–32 | is_multisite(), is_network_only_plugin(), activate_plugin(), is_wp_error(), ->add_data() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 50 instructions, 10–32 executed per call, 7 branches. The work does not change between versions.
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 · 7
- deactivate_plugins()Deactivates a single plugin or multiple plugins.
- is_multisite()Determines whether Multisite is enabled.
- is_network_only_plugin()Checks for "Network: true" in the plugin header to see if this should be activated only as a network wide plugin. The plugin would also work when Multisite is not enabled.
- __()Retrieves the translation of $text.
- activate_plugin()Attempts activation of plugin in a "sandbox" and redirects on success.
- is_wp_error()Checks whether the given variable is a WordPress Error.
- WP_Error::__construct()Initializes the error.
Used by · 2
- WP_REST_Plugins_Controller::create_item()Uploads a plugin and optionally activates it.
- WP_REST_Plugins_Controller::update_item()Updates one plugin.
Source code
protected function handle_plugin_status( $plugin, $new_status, $current_status ) { if ( 'inactive' === $new_status ) { deactivate_plugins( $plugin, false, 'network-active' === $current_status ); return true; } if ( 'active' === $new_status && 'network-active' === $current_status ) { return true; } $network_activate = 'network-active' === $new_status; if ( is_multisite() && ! $network_activate && is_network_only_plugin( $plugin ) ) { return new WP_Error( 'rest_network_only_plugin', __( 'Network only plugin must be network activated.' ), array( 'status' => 400 ) ); } $activated = activate_plugin( $plugin, '', $network_activate ); if ( is_wp_error( $activated ) ) { $activated->add_data( array( 'status' => 500 ) ); return $activated; } return true; }Changelog
Introduced in 5.5.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-includes/rest-api/endpoints/class-wp-rest-plugins-controller.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.