WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Post_Statuses_Controller::check_read_permission()

WP_REST_Post_Statuses_Controller::check_read_permission( object $status ): bool

In this article

Back to top

Checks whether a given post status should be visible.

Parameters

$statusobjectrequired
Post status.

Return

bool True if the post status is visible, otherwise false.

Source

protected function check_read_permission( $status ) {
	if ( true === $status->public ) {
		return true;
	}

	if ( false === $status->internal || 'trash' === $status->name ) {
		$types = get_post_types( array( 'show_in_rest' => true ), 'objects' );

		foreach ( $types as $type ) {
			if ( current_user_can( $type->cap->edit_posts ) ) {
				return true;
			}
		}
	}

	return false;
}

View all references View on Trac View on GitHub

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

Used byDescription
WP_REST_Post_Statuses_Controller::get_items()wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php

Retrieves all post statuses, depending on user context.

WP_REST_Post_Statuses_Controller::get_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php

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

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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