is_post_status_viewable( string|stdClass $post_status ): bool
- Since
- 5.7.0, 5.9.0
- Source
wp-includes/post.php:2452
Description
For built-in post statuses such as publish and private, the 'public' value will be evaluated.
For all others, the 'publicly_queryable' value will be used.
Compatibility
- WordPress
- since 5.9.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$post_statusstring|stdClass- Post status name or object.
Return value
bool- Whether the post status should be considered viewable.
Performance profile
How much work a call to is_post_status_viewable() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 6–30
- Plugin surface
- 1 hook
- Called by
- 2
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 33.
Third-party callbacks on 'is_post_status_viewable' run inside this call, and their cost is not bounded by anything here.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost is_post_status_viewable() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 6–10 | none |
is_scalar($post_status) && is_string($post_status) | 11–17 | get_post_status_object() |
!is_scalar($post_status) && is_object($post_status) && !$post_status | 19–23 | apply_filters() |
is_scalar($post_status) && is_string($post_status) && is_object($post_status) && !$post_status | 26–30 | get_post_status_object(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 33 | 6–30 | 8 | |
| 8.5 | 33 | 6–30 | 8 | |
| 8.4 | 33 | 6–30 | 8 | |
| 8.3 | 33 | 6–30 | 8 | |
| 8.2 | 33 | 6–30 | 8 | |
| 8.1 | 33 | 6–30 | 8 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 35 | 8–32 | 8 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while is_post_status_viewable() runs, in this order:
- apply_filters( is_post_status_viewable )filterline 2489 (+37 into the body)
Filters whether a post status is considered "viewable".
Uses · 2
- get_post_status_object()Retrieves a post status object by name.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 2
- is_post_publicly_viewable()Determines whether a post is publicly viewable.
- wp_force_plain_post_permalink()Determine whether post should always use a plain permalink structure.
Source code
function is_post_status_viewable( $post_status ) { if ( is_scalar( $post_status ) ) { if ( ! is_string( $post_status ) ) { return false; } $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; } $is_viewable = $post_status->publicly_queryable || ( $post_status->_builtin && $post_status->public ); /** * Filters whether a post status is considered "viewable". * * The returned filtered value must be a boolean type to ensure * `is_post_status_viewable()` only returns a boolean. This strictness * is by design to maintain backwards-compatibility and guard against * potential type errors in PHP 8.1+. Non-boolean values (even falsey * and truthy values) will result in the function returning false. * * @since 5.9.0 * * @param bool $is_viewable Whether the post status is "viewable" (strict type). * @param stdClass $post_status Post status object. */ return true === apply_filters( 'is_post_status_viewable', $is_viewable, $post_status );}Changelog
Introduced in 5.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
is_post_status_viewable hook to filter the result.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/post.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.