is_plugin_active_for_network( string $plugin ): bool
- Since
- 3.0.0
- Source
wp-admin/includes/plugin.php:580
Description
Only plugins installed in the plugins/ folder can be active.
Plugins in the mu-plugins/ folder can't be "activated," so this function will return false for those plugins.
For more information on this and similar theme functions, check out the https://developer.wordpress.org/themes/basics/conditional-tags/ Conditional Tags article in the Theme Developer Handbook.
Compatibility
- WordPress
- since 3.0.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- Path to the plugin file relative to the plugins directory.
Return value
bool- True if active for the network, otherwise false.
Performance profile
How much work a call to is_plugin_active_for_network() 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
- 5–11
- Plugin surface
- None
- Called by
- 9
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 13.
Nothing here hands control to plugin code.
9 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()called directly
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 is_plugin_active_for_network() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_multisite() | 5 | is_multisite() |
is_multisite() | 11 | is_multisite(), get_site_option() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 13 instructions, 5–11 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_multisite()Determines whether Multisite is enabled.
- get_site_option()Retrieve an option value for the current network based on name of option.
Used by · 9
- Plugin_Upgrader_Skin::__construct()Constructor.
- WP_Plugins_List_Table::add_dependencies_to_dependent_plugin_row()Prints a list of other plugins that the plugin depends on.
- WP_Plugins_List_Table::prepare_items()
- WP_Plugins_List_Table::single_row()
- WP_REST_Plugins_Controller::get_plugin_status()Get's the activation status for a plugin.
- _upgrade_core_deactivate_incompatible_plugins()
- deactivate_plugins()Deactivates a single plugin or multiple plugins.
- is_plugin_active()Determines whether a plugin is active.
- wp_plugin_update_row()Displays update information for a plugin.
Source code
function is_plugin_active_for_network( $plugin ) { if ( ! is_multisite() ) { return false; } $plugins = get_site_option( 'active_sitewide_plugins' ); if ( isset( $plugins[ $plugin ] ) ) { return true; } return false;}Changelog
Introduced in 3.0.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/plugin.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.