is_post_status_viewable( string|stdClass $post_status )

Determine whether a post status is considered “viewable”.


Description Description

For built-in post statuses such as publish and private, the ‘public’ value will be evaluted. For all others, the ‘publicly_queryable’ value will be used.


Top ↑

Parameters Parameters

$post_status

(string|stdClass) (Required) Post status name or object.


Top ↑

Return Return

(bool) Whether the post status should be considered viewable.


Top ↑

Source Source

File: wp-includes/post.php

function is_post_status_viewable( $post_status ) {
	if ( is_scalar( $post_status ) ) {
		$post_status = get_post_status_object( $post_status );
		if ( ! $post_status ) {
			return false;
		}
	}

	if (
		! is_object( $post_status ) ||
		$post_status->internal ||
		$post_status->protected
	) {
		return false;
	}

	return $post_status->publicly_queryable || ( $post_status->_builtin && $post_status->public );
}


Top ↑

Changelog Changelog

Changelog
Version Description
5.7.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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