On this page
WP_REST_Widgets_Controller::permissions_check( WP_REST_Request $request ): true|WP_Error
Performs a permissions check for managing widgets.
Parameters
$requestWP_REST_Request Required-
Full details about the request.
Return
true|WP_Error
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php. View all references
protected function permissions_check( $request ) {
if ( ! current_user_can( 'edit_theme_options' ) ) {
return new WP_Error(
'rest_cannot_manage_widgets',
__( 'Sorry, you are not allowed to manage widgets on this site.' ),
array(
'status' => rest_authorization_required_code(),
)
);
}
return true;
}
Related
Uses
| Uses | Description |
|---|---|
| rest_authorization_required_code() wp-includes/rest-api.php | Returns a contextual HTTP error code for authorization failure. |
| current_user_can() wp-includes/capabilities.php | Returns whether the current user has the specified capability. |
| __() wp-includes/l10n.php | Retrieves the translation of $text. |
| WP_Error::__construct() wp-includes/class-wp-error.php | Initializes the error. |
Used By
| Used By | Description |
|---|---|
| WP_REST_Widgets_Controller::get_items_permissions_check() wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php | Checks if a given request has access to get widgets. |
| WP_REST_Widgets_Controller::get_items() wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php | Retrieves a collection of widgets. |
| WP_REST_Widgets_Controller::get_item_permissions_check() wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php | Checks if a given request has access to get a widget. |
| WP_REST_Widgets_Controller::create_item_permissions_check() wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php | Checks if a given request has access to create widgets. |
| WP_REST_Widgets_Controller::update_item_permissions_check() wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php | Checks if a given request has access to update widgets. |
| WP_REST_Widgets_Controller::delete_item_permissions_check() wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php | Checks if a given request has access to delete widgets. |
Changelog
| Version | Description |
|---|---|
| 5.8.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_widgets_controller/permissions_check