WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Plugins_Controller::get_plugin_status()

WP_REST_Plugins_Controller::get_plugin_status( string $plugin ): string

In this article

Back to top

Get’s the activation status for a plugin.

Parameters

$pluginstringrequired
The plugin file to check.

Return

string Either 'network-active', 'active' or 'inactive'.

Source

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

View all references View on Trac View on GitHub

UsesDescription
is_plugin_active_for_network()wp-admin/includes/plugin.php

Determines whether the plugin is active for the entire network.

is_plugin_active()wp-admin/includes/plugin.php

Determines whether a plugin is active.

Used byDescription
WP_REST_Plugins_Controller::does_plugin_match_request()wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Checks if the plugin matches the requested parameters.

WP_REST_Plugins_Controller::update_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Checks if a given request has access to update a specific plugin.

WP_REST_Plugins_Controller::update_item()wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Updates one plugin.

WP_REST_Plugins_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

Prepares the plugin for the REST response.

Changelog

VersionDescription
5.5.0Introduced.

User Contributed Notes

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