WP_REST_Plugins_Controller::check_read_permission( string $plugin ): true|WP_Error

Description

Parameters

$pluginstring

The plugin file to check.

Return

true|WP_Error

True if can read, a WP_Error instance otherwise.

Uses · 8

• __()Retrieves the translation of $text.
• is_multisite()Determines whether Multisite is enabled.
• is_network_only_plugin()Checks for "Network: true" in the plugin header to see if this should be activated only as a network wide plugin. The plugin would also work when Multisite is not enabled.
• is_plugin_active()Determines whether a plugin is active.
• current_user_can()Returns whether the current user has the specified capability.
• rest_authorization_required_code()Returns a contextual HTTP error code for authorization failure.
• WP_REST_Plugins_Controller::is_plugin_installed()Checks if the plugin is installed.
• WP_Error::__construct()Initializes the error.

Used by · 4

• WP_REST_Plugins_Controller::delete_item_permissions_check()Checks if a given request has access to delete a specific plugin.
• WP_REST_Plugins_Controller::get_item_permissions_check()Checks if a given request has access to get a specific plugin.
• WP_REST_Plugins_Controller::get_items()Retrieves a collection of plugins.
• WP_REST_Plugins_Controller::update_item_permissions_check()Checks if a given request has access to update a specific plugin.

Source

View on Trac ↗View on GitHub ↗

211	protected function check_read_permission( $plugin ) {212		require_once ABSPATH . 'wp-admin/includes/plugin.php';213 214		if ( ! $this->is_plugin_installed( $plugin ) ) {215			return new WP_Error( 'rest_plugin_not_found', __( 'Plugin not found.' ), array( 'status' => 404 ) );216		}217 218		if ( ! is_multisite() ) {219			return true;220		}221 222		if ( ! is_network_only_plugin( $plugin ) || is_plugin_active( $plugin ) || current_user_can( 'manage_network_plugins' ) ) {223			return true;224		}225 226		return new WP_Error(227			'rest_cannot_view_plugin',228			__( 'Sorry, you are not allowed to manage this plugin.' ),229			array( 'status' => rest_authorization_required_code() )230		);231	}

History

Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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-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.