is_post_type_viewable( string|WP_Post_Type $post_type ): bool
- Since
- 4.4.0, 4.5.0, 4.6.0, 5.9.0
- Source
wp-includes/post.php:2408
Description
For built-in post types such as posts and pages, 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_typestring|WP_Post_Type- Post type name or object.
Return value
bool- Whether the post type should be considered viewable.
Performance profile
How much work a call to is_post_type_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–24
- Plugin surface
- 1 hook
- Called by
- 14
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 26.
Third-party callbacks on 'is_post_type_viewable' run inside this call, and their cost is not bounded by anything here.
14 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_type_viewable() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_scalar($post_type) && !is_object($post_type) | 6 | none |
is_scalar($post_type) | 9–11 | get_post_type_object() |
!is_scalar($post_type) && is_object($post_type) | 15–19 | apply_filters() |
is_scalar($post_type) && is_object($post_type) | 20–24 | get_post_type_object(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 26 | 6–24 | 5 | |
| 8.5 | 26 | 6–24 | 5 | |
| 8.4 | 26 | 6–24 | 5 | |
| 8.3 | 26 | 6–24 | 5 | |
| 8.2 | 26 | 6–24 | 5 | |
| 8.1 | 26 | 6–24 | 5 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 28 | 8–26 | 5 |
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_type_viewable() runs, in this order:
- apply_filters( is_post_type_viewable )filterline 2437 (+29 into the body)
Filters whether a post type is considered "viewable".
Uses · 2
- get_post_type_object()Retrieves a post type object by name.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 14
- WP::parse_request()Parses the request to find the correct WordPress query.
- WP_Post_Type::add_rewrite_rules()Adds the necessary rewrite rules for the post type.
- WP_Posts_List_Table::handle_row_actions()Generates and displays row action links.
- WP_Posts_List_Table::inline_edit()Outputs the hidden row displayed when inline editing
- WP_REST_Post_Types_Controller::prepare_item_for_response()Prepares a post type object for serialization.
- WP_REST_Posts_Controller::get_item()Retrieves a single post.
- WP_REST_Posts_Controller::get_item_schema()Retrieves the post's schema, conforming to JSON Schema.
- WP_REST_Posts_Controller::prepare_item_for_response()Prepares a single post output for response.
- build_query_vars_from_query_block()Helper function that constructs a WP_Query args array from a `Query` block properties.
- get_attachment_link()Retrieves the permalink for an attachment.
- get_preview_post_link()Retrieves the URL used for the post preview.
- is_post_publicly_viewable()Determines whether a post is publicly viewable.
Show all 14
- post_submit_meta_box()Displays post submit form fields.
- wp_get_archives()Displays archive links based on type and format.
Source code
function is_post_type_viewable( $post_type ) { if ( is_scalar( $post_type ) ) { $post_type = get_post_type_object( $post_type ); if ( ! $post_type ) { return false; } } if ( ! is_object( $post_type ) ) { return false; } $is_viewable = $post_type->publicly_queryable || ( $post_type->_builtin && $post_type->public ); /** * Filters whether a post type is considered "viewable". * * The returned filtered value must be a boolean type to ensure * `is_post_type_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 type is "viewable" (strict type). * @param WP_Post_Type $post_type Post type object. */ return true === apply_filters( 'is_post_type_viewable', $is_viewable, $post_type );}Changelog
Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
is_post_type_viewable hook to filter the result.from the docblock$post_type parameter to accept a WP_Post_Type object.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.