get_post_status( int|WP_Post $ID = '' )

Retrieve the post status based on the Post ID.

Description

If the post ID is of an attachment, then the parent post status will be given instead.

Parameters

$ID

(int|WP_Post) (Optional) Post ID or post object.

Default value: ''

Return

(string|false) Post status on success, false on failure.

Source

File: wp-includes/post.php 

function get_post_status( $ID = '' ) {
	$post = get_post($ID);

	if ( !is_object($post) )
		return false;

	if ( 'attachment' == $post->post_type ) {
		if ( 'private' == $post->post_status )
			return 'private';

		// Unattached attachments are assumed to be published.
		if ( ( 'inherit' == $post->post_status ) && ( 0 == $post->post_parent) )
			return 'publish';

		// Inherit status from the parent.
		if ( $post->post_parent && ( $post->ID != $post->post_parent ) ) {
			$parent_post_status = get_post_status( $post->post_parent );
			if ( 'trash' == $parent_post_status ) {
				return get_post_meta( $post->post_parent, '_wp_trash_meta_status', true );
			} else {
				return $parent_post_status;
			}
		}

	}

	/**
	 * Filters the post status.
	 *
	 * @since WP-4.4.0
	 *
	 * @param string  $post_status The post status.
	 * @param WP_Post $post        The post object.
	 */
	return apply_filters( 'get_post_status', $post->post_status, $post );
}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/plugin.php: apply_filters()

Call the functions added to a filter hook.
wp-includes/post.php: get_post_meta()

Retrieve post meta field for a post.
wp-includes/post.php: get_post_status()

Retrieve the post status based on the Post ID.
wp-includes/post.php: get_post_status

Filters the post status.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.

Used By

Used By
Used By Description
wp-includes/class-wp-query.php: WP_Query::get_posts()

Retrieve the posts based on query variables.
wp-includes/nav-menu.php: _wp_delete_customize_changeset_dependent_auto_drafts()

Delete auto-draft posts associated with the supplied changeset.
wp-includes/nav-menu.php: wp_setup_nav_menu_item()

Decorates a menu item object with the shared navigation menu item properties.
wp-includes/comment.php: wp_handle_comment_submission()

Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.
wp-includes/embed.php: get_oembed_response_data()

Retrieves the oEmbed response data for a given post.
wp-includes/link-template.php: get_privacy_policy_url()

Retrieves the URL to the privacy policy page.
wp-includes/link-template.php: get_post_permalink()

Retrieves the permalink for a post of a custom post type.
wp-includes/theme.php: _wp_keep_alive_customize_changeset_dependent_auto_drafts()

Make sure that auto-draft posts get their post_date bumped or status changed to draft to prevent premature garbage-collection.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_newComment()

Create new comment.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::handle_dismiss_autosave_or_lock_request()

Delete a given auto-draft changeset or the autosave revision for a given changeset or delete changeset lock.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::import_theme_starter_content()

Import theme starter content into the customized state.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::save_changeset_post()

Save the post for the loaded changeset.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::trash_changeset_post()

Trash or delete a changeset post.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::handle_changeset_trash_request()

Handle request to trash a changeset.
wp-includes/canonical.php: redirect_canonical()

Redirects incoming links to the proper URL based on the site url.
wp-includes/post.php: wp_set_post_categories()

Set categories for a post.
wp-includes/post.php: wp_delete_post()

Trash or delete a post or page.
wp-includes/post.php: get_post_status()

Retrieve the post status based on the Post ID.
wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::save_nav_menus_created_posts()

Publish the auto-draft posts that were created for nav menu items.
wp-admin/includes/user.php: WP_Privacy_Requests_Table::column_status()

Status column.
wp-admin/includes/post.php: redirect_post()

Redirect to previous page.
Show 16 more used by Hide more used by

Changelog

Changelog
Version Description
WP-2.0.0 Introduced.