WP_REST_Plugins_Controller::update_item_permissions_check() WordPress Method
The WP_REST_Plugins_Controller::update_item_permissions_check() method is used to check if the current user can update a given plugin. This is useful for making sure that only authorized users can perform plugin updates, which can be a critical operation on a WordPress site. By default, this method will return true if the current user can manage plugins. However, it can be overridden by plugin authors to provide more fine-grained control over who can update their plugin.
WP_REST_Plugins_Controller::update_item_permissions_check( WP_REST_Request $request ) #
Checks if a given request has access to update a specific plugin.
Parameters
- $request
(WP_REST_Request)(Required)Full details about the request.
Return
(true|WP_Error) True if the request has access to update the item, WP_Error object otherwise.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-plugins-controller.php
public function update_item_permissions_check( $request ) {
require_once ABSPATH . 'wp-admin/includes/plugin.php';
if ( ! current_user_can( 'activate_plugins' ) ) {
return new WP_Error(
'rest_cannot_manage_plugins',
__( 'Sorry, you are not allowed to manage plugins for this site.' ),
array( 'status' => rest_authorization_required_code() )
);
}
$can_read = $this->check_read_permission( $request['plugin'] );
if ( is_wp_error( $can_read ) ) {
return $can_read;
}
$status = $this->get_plugin_status( $request['plugin'] );
if ( $request['status'] && $status !== $request['status'] ) {
$can_change_status = $this->plugin_status_permission_check( $request['plugin'], $request['status'], $status );
if ( is_wp_error( $can_change_status ) ) {
return $can_change_status;
}
}
return true;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 5.5.0 | Introduced. |