is_post_type_viewable() – Function | Developer.WordPress.org

Determines whether a post type is considered “viewable”.

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.

Parameters

$post_typestring|WP_Post_Typerequired: Post type name or object.

Return

bool Whether the post type should be considered viewable.

Source

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 );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘is_post_type_viewable’, bool $is_viewable, WP_Post_Type $post_type ): Filters whether a post type is considered “viewable”.

Uses	Description
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_post_type_object()`wp-includes/post.php`	Retrieves a post type object by name.

Used by	Description
build_query_vars_from_query_block()`wp-includes/blocks.php`	Helper function that constructs a WP_Query args array from a `Query` block properties.
is_post_publicly_viewable()`wp-includes/post.php`	Determines whether a post is publicly viewable.
WP_REST_Posts_Controller::get_item_schema()`wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php`	Retrieves the post’s schema, conforming to JSON Schema.
WP_REST_Posts_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php`	Prepares a single post output for response.
WP_REST_Posts_Controller::get_item()`wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php`	Retrieves a single post.
WP_REST_Post_Types_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php`	Prepares a post type object for serialization.
WP_Post_Type::add_rewrite_rules()`wp-includes/class-wp-post-type.php`	Adds the necessary rewrite rules for the post type.
get_preview_post_link()`wp-includes/link-template.php`	Retrieves the URL used for the post preview.
WP_Posts_List_Table::handle_row_actions()`wp-admin/includes/class-wp-posts-list-table.php`	Generates and displays row action links.
post_submit_meta_box()`wp-admin/includes/meta-boxes.php`	Displays post submit form fields.
WP_Posts_List_Table::inline_edit()`wp-admin/includes/class-wp-posts-list-table.php`	Outputs the hidden row displayed when inline editing
wp_get_archives()`wp-includes/general-template.php`	Displays archive links based on type and format.
WP::parse_request()`wp-includes/class-wp.php`	Parses the request to find the correct WordPress query.
get_attachment_link()`wp-includes/link-template.php`	Retrieves the permalink for an attachment.

Show 9 more Show less

Changelog

Version	Description
5.9.0	Added `is_post_type_viewable` hook to filter the result.
4.6.0	Converted the `$post_type` parameter to accept a `WP_Post_Type` object.
4.5.0	Added the ability to pass a post type name in addition to object.
4.4.0	Introduced.

User Contributed Notes

Skip to note 2 content

Munaf Vichhi 2 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Using this hook you can hide single custom posts URL.
```
add_filter( 'is_post_type_viewable', function ( $is_viewable, $post_type ) {
    if ( false == $is_viewable || 'sample_post_type' === $post_type->name ) {
        return false;
    }

    return true;
}, 10, 2 );
```
Log in to add feedback

is_post_type_viewable( string|WP_Post_Type $post_type ): bool

In this article