WP_REST_Widgets_Controller::permissions_check() – Method

Performs a permissions check for managing widgets.

Parameters

$requestWP_REST_Requestrequired: Full details about the request.

Return

Source

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

View all references View on Trac View on GitHub

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.

Show 2 more Show less

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.

Show 1 more Show less

Changelog

Version	Description
5.8.0	Introduced.

WP_REST_Widgets_Controller::permissions_check( WP_REST_Request $request ): true|WP_Error

In this article

Parameters

Return

Source

Changelog

User Contributed Notes

WP_REST_Widgets_Controller::permissions_check( WP_REST_Request $request ): true|WP_Error

In this article

Parameters

Return

Source

Related

Changelog

User Contributed Notes