get_post_status() – Function | Developer.WordPress.org

Retrieves 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

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

Return

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

Source

function get_post_status( $post = null ) {
	// Normalize the post object if necessary, skip normalization if called from get_sample_permalink().
	if ( ! $post instanceof WP_Post || ! isset( $post->filter ) || 'sample' !== $post->filter ) {
		$post = get_post( $post );
	}

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

	$post_status = $post->post_status;

	if (
		'attachment' === $post->post_type &&
		'inherit' === $post_status
	) {
		if (
			0 === $post->post_parent ||
			! get_post( $post->post_parent ) ||
			$post->ID === $post->post_parent
		) {
			// Unattached attachments with inherit status are assumed to be published.
			$post_status = 'publish';
		} elseif ( 'trash' === get_post_status( $post->post_parent ) ) {
			// Get parent status prior to trashing.
			$post_status = get_post_meta( $post->post_parent, '_wp_trash_meta_status', true );

			if ( ! $post_status ) {
				// Assume publish as above.
				$post_status = 'publish';
			}
		} else {
			$post_status = get_post_status( $post->post_parent );
		}
	} elseif (
		'attachment' === $post->post_type &&
		! in_array( $post_status, array( 'private', 'trash', 'auto-draft' ), true )
	) {
		/*
		 * Ensure uninherited attachments have a permitted status either 'private', 'trash', 'auto-draft'.
		 * This is to match the logic in wp_insert_post().
		 *
		 * Note: 'inherit' is excluded from this check as it is resolved to the parent post's
		 * status in the logic block above.
		 */
		$post_status = 'publish';
	}

	/**
	 * Filters the post status.
	 *
	 * @since 4.4.0
	 * @since 5.7.0 The attachment post type is now passed through this filter.
	 *
	 * @param string  $post_status The post status.
	 * @param WP_Post $post        The post object.
	 */
	return apply_filters( 'get_post_status', $post_status, $post );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘get_post_status’, string $post_status, WP_Post $post ): Filters the post status.

Uses	Description
get_post_status()`wp-includes/post.php`	Retrieves the post status based on the post ID.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_post_meta()`wp-includes/post.php`	Retrieves a post meta field for the given post ID.
get_post()`wp-includes/post.php`	Retrieves post data given a post ID or post object.

Show 2 more Show less

Used by	Description
wp_force_plain_post_permalink()`wp-includes/link-template.php`	Determine whether post should always use a plain permalink structure.
is_post_publicly_viewable()`wp-includes/post.php`	Determines whether a post is publicly viewable.
the_block_editor_meta_box_post_form_hidden_fields()`wp-admin/includes/post.php`	Renders the hidden form required for the meta boxes form.
register_and_do_post_meta_boxes()`wp-admin/includes/meta-boxes.php`	Registers the default post meta boxes, and runs the `do_meta_boxes` actions.
get_privacy_policy_url()`wp-includes/link-template.php`	Retrieves the URL to the privacy policy page.
WP_Privacy_Requests_Table::column_status()`wp-admin/includes/class-wp-privacy-requests-table.php`	Status column.
WP_Customize_Manager::handle_dismiss_autosave_or_lock_request()`wp-includes/class-wp-customize-manager.php`	Deletes a given auto-draft changeset or the autosave revision for a given changeset or delete changeset lock.
WP_Customize_Manager::trash_changeset_post()`wp-includes/class-wp-customize-manager.php`	Trashes or deletes a changeset post.
WP_Customize_Manager::handle_changeset_trash_request()`wp-includes/class-wp-customize-manager.php`	Handles request to trash a changeset.
_wp_keep_alive_customize_changeset_dependent_auto_drafts()`wp-includes/theme.php`	Makes sure that auto-draft posts get their post_date bumped or status changed to draft to prevent premature garbage-collection.
_wp_delete_customize_changeset_dependent_auto_drafts()`wp-includes/nav-menu.php`	Deletes auto-draft posts associated with the supplied changeset.
WP_Customize_Manager::save_changeset_post()`wp-includes/class-wp-customize-manager.php`	Saves the post for the loaded changeset.
WP_Customize_Manager::import_theme_starter_content()`wp-includes/class-wp-customize-manager.php`	Imports theme starter content into the customized state.
WP_Customize_Nav_Menus::save_nav_menus_created_posts()`wp-includes/class-wp-customize-nav-menus.php`	Publishes the auto-draft posts that were created for nav menu items.
wp_handle_comment_submission()`wp-includes/comment.php`	Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.
WP_List_Table::comments_bubble()`wp-admin/includes/class-wp-list-table.php`	Displays a comment count bubble.
redirect_post()`wp-admin/includes/post.php`	Redirects to previous page.
map_meta_cap()`wp-includes/capabilities.php`	Maps a capability to the primitive capabilities required of the given user to satisfy the capability being checked.
WP_Query::get_posts()`wp-includes/class-wp-query.php`	Retrieves an array of posts based on query variables.
wp_set_post_categories()`wp-includes/post.php`	Sets categories for a post.
wp_delete_post()`wp-includes/post.php`	Trashes or deletes a post or page.
get_post_status()`wp-includes/post.php`	Retrieves the post status based on the post ID.
redirect_canonical()`wp-includes/canonical.php`	Redirects incoming links to the proper URL based on the site url.
wp_setup_nav_menu_item()`wp-includes/nav-menu.php`	Decorates a menu item object with the shared navigation menu item properties.
wp_xmlrpc_server::wp_newComment()`wp-includes/class-wp-xmlrpc-server.php`	Creates a new comment.

Show 20 more Show less

Changelog

Version	Description
2.0.0	Introduced.

User Contributed Notes

Skip to note 6 content

Aurovrata Venet 5 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 11You must log in to vote on the helpfulness of this note

will return one of: publish, future, draft, pending, private
- If a plugin has introduced custom status types, those may also be included.
  
  crstauf 5 years ago
- Will also return trash, auto-draft or inherit.
  
  Nicholas Turbanov 4 years ago
- or ‘auto-draft’
  
  tirlicompa 2 years ago
- or ‘trash’ or some custom status
  
  kubiq 2 years ago
Log in to add feedback
Skip to note 7 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
A basic example:
```
<?php
	if ( get_post_status ( $ID ) == 'private' ) {
		echo 'private';
	} else {
		echo 'public';
	}
?>
```
Log in to add feedback
Skip to note 8 content

twinpictures 3 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
To return the localized label for the post status, get_post_status_object must be used:
```
echo get_post_status_object( get_post_status( ) )->label;
```
Log in to add feedback

internetfootprint 4 years ago

Basic example:

<?php 
$current_status = get_post_status ( $postID );

if ( false !== $current_status ) {
    if ( 'publish' === $current_status == 'publish' ) {
        $err_msg = esc_html__( 'Post status is set to: Publish.', 'textdomain' ) );
    } elseif ( 'draft' === $current_status ) 
        $err_msg = esc_html__( 'Your post is in Draft mode.', 'textdomain' );
    }
} else {
    $err_msg = esc_html__( 'Sorry, the post status is not available at this time.', 'textdomain' );
}
?>

Default post status includes: publish, future, draft, pending, private.

Just noting there is a small error on line 5: 'publish' === $current_status == 'publish' should be.. 'publish' === $current_status

Tony V. Le 3 years ago

Skip to note 10 content

Peter Hardy-vanDoorn 2 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note

Documentation above says both that, if no ID or $post is passed then it will default to both the global $post AND null.

In my testing it does NOT default to the global $post, so if used in the Loop you must still pass either the ID or the $post, eg:

get_post_status ( get_the_ID() )
- In my testing get_post_status() returns the global $post status if no parameter is provided.
  
  crstauf 2 years ago
Log in to add feedback

get_post_status( int|WP_Post $post = null ): string|false

In this article