WP_REST_Posts_Controller::get_item_permissions_check │ public │ WP 4.7.0

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

Method of the class: WP_REST_Posts_Controller{}

No Hooks.

Returns

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

Usage

$WP_REST_Posts_Controller = new WP_REST_Posts_Controller();
$WP_REST_Posts_Controller->get_item_permissions_check( $request );

$request(WP_REST_Request) (required)

Full details about the request.

Changelog

WP_REST_Posts_Controller::get_item_permissions_check() WP REST Posts Controller::get item permissions check code ^{WP 6.8.1}

public function get_item_permissions_check( $request ) {
	$post = $this->get_post( $request['id'] );
	if ( is_wp_error( $post ) ) {
		return $post;
	}

	if ( 'edit' === $request['context'] && $post && ! $this->check_update_permission( $post ) ) {
		return new WP_Error(
			'rest_forbidden_context',
			__( 'Sorry, you are not allowed to edit this post.' ),
			array( 'status' => rest_authorization_required_code() )
		);
	}

	if ( $post && ! empty( $request->get_query_params()['password'] ) ) {
		// Check post password, and return error if invalid.
		if ( ! hash_equals( $post->post_password, $request->get_query_params()['password'] ) ) {
			return new WP_Error(
				'rest_post_incorrect_password',
				__( 'Incorrect post password.' ),
				array( 'status' => 403 )
			);
		}
	}

	// Allow access to all password protected posts if the context is edit.
	if ( 'edit' === $request['context'] ) {
		add_filter( 'post_password_required', array( $this, 'check_password_required' ), 10, 2 );
	}

	if ( $post ) {
		return $this->check_read_permission( $post );
	}

	return true;
}