WP_REST_Templates_Controller::permissions_check() WordPress Method

The WP_REST_Templates_Controller::permissions_check() method is used to check if the current user has the required permissions to access a given template. If the user does not have the required permissions, a WP_Error instance is returned.

WP_REST_Templates_Controller::permissions_check( WP_REST_Request $request ) #

Checks if the user has permissions to make the request.


Parameters

$request

(WP_REST_Request)(Required)Full details about the request.


Top ↑

Return

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


Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php

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


Top ↑

Changelog

Changelog
VersionDescription
5.8.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.