WP_REST_Plugins_Controller::get_items_permissions_check() WordPress Method

The WP_REST_Plugins_Controller::get_items_permissions_check() method is used to check if a user has permission to perform the `get_plugins` REST API action. This method is called before the `get_plugins` REST API action is executed. If this method returns false, then the `get_plugins` REST API action will not be executed. To check if a user has permission to perform the `get_plugins` REST API action, this method does the following: 1. Checks if the user is logged in. 2. Checks if the user has the `edit_posts` capability. 3. Checks if the user has the `activate_plugins` capability. If all of the above checks return true, then the user has permission to perform the `get_plugins` REST API action. Otherwise, the user does not have permission to perform the `get_plugins` REST API action.

WP_REST_Plugins_Controller::get_items_permissions_check( WP_REST_Request $request ) #

Checks if a given request has access to get plugins.


Parameters

$request

(WP_REST_Request)(Required)Full details about the request.


Top ↑

Return

(true|WP_Error) True if the request has read access, WP_Error object otherwise.


Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php

	public function get_items_permissions_check( $request ) {
		if ( ! current_user_can( 'activate_plugins' ) ) {
			return new WP_Error(
				'rest_cannot_view_plugins',
				__( 'Sorry, you are not allowed to manage plugins for this site.' ),
				array( 'status' => rest_authorization_required_code() )
			);
		}

		return true;
	}


Top ↑

Changelog

Changelog
VersionDescription
5.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.