W3cubDocs

/WordPress

WP_REST_Post_Statuses_Controller::get_item_permissions_check( WP_REST_Request $request )

Checks if a given request has access to read a post status.

Parameters

$request

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

Return

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

Source

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

public function get_item_permissions_check( $request ) {
		$status = get_post_status_object( $request['status'] );

		if ( empty( $status ) ) {
			return new WP_Error(
				'rest_status_invalid',
				__( 'Invalid status.' ),
				array( 'status' => 404 )
			);
		}

		$check = $this->check_read_permission( $status );

		if ( ! $check ) {
			return new WP_Error(
				'rest_cannot_read_status',
				__( 'Cannot view status.' ),
				array( 'status' => rest_authorization_required_code() )
			);
		}

		return true;
	}

Uses

Uses Description
wp-includes/rest-api.php: rest_authorization_required_code()

Returns a contextual HTTP error code for authorization failure.
wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php: WP_REST_Post_Statuses_Controller::check_read_permission()

Checks whether a given post status should be visible.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/post.php: get_post_status_object()

Retrieve a post status object by name.
wp-includes/class-wp-error.php: WP_Error::__construct()

Initialize the error.

Changelog

Version Description
4.7.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_post_statuses_controller/get_item_permissions_check