WP_REST_Plugins_Controller::get_plugin_status( string $plugin ): string
- Since
- 5.5.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php:674
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 check.
Return value
string- Either 'network-active', 'active' or 'inactive'.
Performance profile
How much work a call to WP_REST_Plugins_Controller::get_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
- 6–10
- Plugin surface
- None
- Called by
- 4
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 12.
Nothing here hands control to plugin code.
4 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::get_plugin_status()
Further down the call graph this can also reach hook, 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Plugins_Controller::get_plugin_status() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_plugin_active_for_network() | 6 | is_plugin_active_for_network() |
!is_plugin_active_for_network() | 10 | is_plugin_active_for_network(), is_plugin_active() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 12 instructions, 6–10 executed per call, 2 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 · 2
- is_plugin_active_for_network()Determines whether the plugin is active for the entire network.
- is_plugin_active()Determines whether a plugin is active.
Used by · 4
- WP_REST_Plugins_Controller::does_plugin_match_request()Checks if the plugin matches the requested parameters.
- WP_REST_Plugins_Controller::prepare_item_for_response()Prepares the plugin for the REST response.
- WP_REST_Plugins_Controller::update_item()Updates one plugin.
- WP_REST_Plugins_Controller::update_item_permissions_check()Checks if a given request has access to update a specific plugin.
Source code
protected function get_plugin_status( $plugin ) { if ( is_plugin_active_for_network( $plugin ) ) { return 'network-active'; } if ( is_plugin_active( $plugin ) ) { return 'active'; } return 'inactive'; }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 7.0.4 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.