WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Sidebars_Controller::do_permissions_check()

WP_REST_Sidebars_Controller::do_permissions_check(): true|WP_Error

In this article

Back to top

Checks if the user has permissions to make the request.

Return

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

Source

protected function do_permissions_check() {
	/*
	 * Verify if the current user has edit_theme_options capability.
	 * This capability is required to access the widgets screen.
	 */
	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

UsesDescription
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_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 1 moreShow less
Used byDescription
WP_REST_Sidebars_Controller::get_items_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php

Checks if a given request has access to get sidebars.

WP_REST_Sidebars_Controller::get_items()wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php

Retrieves the list of sidebars (active or inactive).

WP_REST_Sidebars_Controller::get_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php

Checks if a given request has access to get a single sidebar.

WP_REST_Sidebars_Controller::update_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php

Checks if a given request has access to update sidebars.

Changelog

VersionDescription
5.8.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.