WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Templates_Controller::permissions_check()

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

In this article

Back to top

Checks if the user has permissions to make the request.

Parameters

$requestWP_REST_Requestrequired
Full details about the request.

Return

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

Source

protected function permissions_check( $request ) {
	/*
	 * Verify if the current user has edit_theme_options capability.
	 * This capability is required to edit/view/delete templates.
	 */
	if ( ! current_user_can( 'edit_theme_options' ) ) {
		return new WP_Error(
			'rest_cannot_manage_templates',
			__( 'Sorry, you are not allowed to access the templates on this site.' ),
			array(
				'status' => rest_authorization_required_code(),
			)
		);
	}

	return true;
}

View all references View on Trac View on GitHub

UsesDescription
current_user_can()wp-includes/capabilities.php

Returns whether the current user has the specified capability.

Used byDescription
WP_REST_Templates_Controller::update_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php

Checks if a given request has access to write a single template.

WP_REST_Templates_Controller::create_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php

Checks if a given request has access to create a template.

WP_REST_Templates_Controller::delete_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php

Checks if a given request has access to delete a single template.

Changelog

VersionDescription
5.8.0Introduced.

User Contributed Notes

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