is_plugin_active_for_network( string $plugin ): bool

Determines whether the plugin is active for the entire network.

Contents

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

$plugin string Required
Path to the plugin file relative to the plugins directory.

Top ↑

Return

bool True if active for the network, otherwise false.

Top ↑

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

File: wp-admin/includes/plugin.php. View all references 

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

View on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
is_multisite() wp-includes/load.php

If Multisite is enabled.
get_site_option() wp-includes/option.php

Retrieve an option value for the current network based on name of option.

Top ↑

Used By

Used By
Used By Description
WP_REST_Plugins_Controller::get_plugin_status() wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Get’s the activation status for a plugin.
WP_Plugins_List_Table::single_row() wp-admin/includes/class-wp-plugins-list-table.php
WP_Plugins_List_Table::prepare_items() wp-admin/includes/class-wp-plugins-list-table.php
Plugin_Upgrader_Skin::__construct() wp-admin/includes/class-plugin-upgrader-skin.php

Constructor.
wp_plugin_update_row() wp-admin/includes/update.php

Displays update information for a plugin.
is_plugin_active() wp-admin/includes/plugin.php

Determines whether a plugin is active.
deactivate_plugins() wp-admin/includes/plugin.php

Deactivates a single plugin or multiple plugins.
Show 2 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
3.0.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -3You must log in to vote on the helpfulness of this note
    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.