WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Revisions_Controller::get_items_permissions_check()

WP_REST_Revisions_Controller::get_items_permissions_check( WP_REST_Request $request ): true|WP_Error

In this article

Back to top

Checks if a given request has access to get revisions.

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

public function get_items_permissions_check( $request ) {
	$parent = $this->get_parent( $request['parent'] );
	if ( is_wp_error( $parent ) ) {
		return $parent;
	}

	if ( ! current_user_can( 'edit_post', $parent->ID ) ) {
		return new WP_Error(
			'rest_cannot_read',
			__( 'Sorry, you are not allowed to view revisions of this post.' ),
			array( 'status' => rest_authorization_required_code() )
		);
	}

	return true;
}

View all references View on Trac View on GitHub

UsesDescription
WP_REST_Revisions_Controller::get_parent()wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

Get the parent post, if the ID is valid.

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.

is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 3 moreShow less
Used byDescription
WP_REST_Revisions_Controller::get_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

Checks if a given request has access to get a specific revision.

WP_REST_Revisions_Controller::delete_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

Checks if a given request has access to delete a revision.

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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