is_plugin_active_for_network( string $plugin )

Determines whether the plugin is active for the entire network.


Description 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 Conditional Tags article in the Theme Developer Handbook.


Top ↑

Parameters Parameters

$plugin

(string) (Required) Path to the plugin file relative to the plugins directory.


Top ↑

Return Return

(bool) True if active for the network, otherwise false.


Top ↑

More Information More Information

The file that defines this function (wp-admin/includes/plugin.php) is only loaded in the admin sections. In order to use is_plugin_active_for_network outside the admin pages, it’s necessary to include or require plugin.php before trying to use it (as shown in the example).


Top ↑

Source Source

File: wp-admin/includes/plugin.php

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;
}


Top ↑

Changelog Changelog

Changelog
Version Description
3.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by Codex

    Example

    // Makes sure the plugin is defined before trying to use it
    if ( ! function_exists( 'is_plugin_active_for_network' ) ) {
        require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
    }
     
    if ( is_plugin_active_for_network( 'plugin-directory/plugin-file.php' ) ) {
        // Plugin is activated
    }
    

You must log in before being able to contribute a note or feedback.