WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Block_Types_Controller::get_item_permissions_check()

WP_REST_Block_Types_Controller::get_item_permissions_check( WP_REST_Request $request ): true|WP_Error

In this article

Back to top

Checks if a given request has access to read a block type.

Parameters

$requestWP_REST_Requestrequired
Full details about the request.

Return

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

Source

public function get_item_permissions_check( $request ) {
	$check = $this->check_read_permission();
	if ( is_wp_error( $check ) ) {
		return $check;
	}
	$block_name = sprintf( '%s/%s', $request['namespace'], $request['name'] );
	$block_type = $this->get_block( $block_name );
	if ( is_wp_error( $block_type ) ) {
		return $block_type;
	}

	return true;
}

View all references View on Trac View on GitHub

UsesDescription
WP_REST_Block_Types_Controller::get_block()wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php

Get the block, if the name is valid.

WP_REST_Block_Types_Controller::check_read_permission()wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php

Checks whether a given block type should be visible.

is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

Show 1 moreShow less

Changelog

VersionDescription
5.5.0Introduced.

User Contributed Notes

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