is_post_publicly_viewable( int|WP_Post|null $post = null ): bool

Description

Parameters

$postint|WP_Post|nulloptional

Post ID or post object. Defaults to global $post.Default: null

Return

bool

Whether the post is publicly viewable.

Uses · 5

• get_post()Retrieves post data given a post ID or post object.
• get_post_type()Retrieves the post type of the current post or of a given post.
• get_post_status()Retrieves the post status based on the post ID.
• is_post_type_viewable()Determines whether a post type is considered "viewable".
• is_post_status_viewable()Determines whether a post status is considered "viewable".

Used by · 6

• WP_REST_Terms_Controller::check_read_terms_permission_for_post()Checks if the terms for a post can be read.
• _block_bindings_post_data_get_value()Gets value for Post Data source.
• _block_bindings_post_meta_get_value()Gets value for Post Meta source.
• gallery_shortcode()Builds the Gallery shortcode output.
• get_oembed_response_data()Retrieves the oEmbed response data for a given post.
• redirect_canonical()Redirects incoming links to the proper URL based on the site url.

Source

View on Trac ↗View on GitHub ↗

2508function is_post_publicly_viewable( $post = null ) {2509	$post = get_post( $post );2510 2511	if ( ! $post ) {2512		return false;2513	}2514 2515	$post_type   = get_post_type( $post );2516	$post_status = get_post_status( $post );2517 2518	return is_post_type_viewable( $post_type ) && is_post_status_viewable( $post_status );2519}

History

Introduced in 5.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 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.