WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Block_Types_Controller::check_read_permission()

WP_REST_Block_Types_Controller::check_read_permission(): true|WP_Error

In this article

Back to top

Checks whether a given block type should be visible.

Return

true|WP_Error True if the block type is visible, WP_Error otherwise.

Source

protected function check_read_permission() {
	if ( current_user_can( 'edit_posts' ) ) {
		return true;
	}
	foreach ( get_post_types( array( 'show_in_rest' => true ), 'objects' ) as $post_type ) {
		if ( current_user_can( $post_type->cap->edit_posts ) ) {
			return true;
		}
	}

	return new WP_Error( 'rest_block_type_cannot_view', __( 'Sorry, you are not allowed to manage block types.' ), array( 'status' => rest_authorization_required_code() ) );
}

View all references View on Trac View on GitHub

UsesDescription
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.

get_post_types()wp-includes/post.php

Gets a list of all registered post type objects.

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

Initializes the error.

Show 2 moreShow less
Used byDescription
WP_REST_Block_Types_Controller::get_items_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-block-types-controller.php

Checks whether a given request has permission to read post block types.

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

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

Changelog

VersionDescription
5.5.0Introduced.

User Contributed Notes

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