W3cubDocs

/WordPress

get_post_status( int|WP_Post $post = null )

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

$post

(int|WP_Post) (Optional) Post ID or post object. Defaults to global $post..

Default value: null

Return

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

Source

File: wp-includes/post.php 

function get_post_status( $post = null ) {
	$post = get_post( $post );

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

Uses

Uses Description
wp-includes/post.php: get_post_status

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

Calls the callback functions that have been added to a filter hook.
wp-includes/post.php: get_post_meta()

Retrieves a post meta field for the given post ID.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.
wp-includes/post.php: get_post_status()

Retrieve the post status based on the post ID.

Used By

Used By Description
wp-admin/includes/post.php: the_block_editor_meta_box_post_form_hidden_fields()

Renders the hidden form required for the meta boxes form.
wp-admin/includes/meta-boxes.php: register_and_do_post_meta_boxes()

Registers the default post meta boxes, and runs the do_meta_boxes actions.
wp-includes/link-template.php: get_privacy_policy_url()

Retrieves the URL to the privacy policy page.
wp-admin/includes/class-wp-privacy-requests-table.php: WP_Privacy_Requests_Table::column_status()

Status column.
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::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/theme.php: _wp_keep_alive_customize_changeset_dependent_auto_drafts()

Makes sure that auto-draft posts get their post_date bumped or status changed to draft to prevent premature garbage-collection.
wp-includes/nav-menu.php: _wp_delete_customize_changeset_dependent_auto_drafts()

Delete auto-draft posts associated with the supplied changeset.
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::import_theme_starter_content()

Import theme starter content into the customized state.
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-includes/embed.php: get_oembed_response_data()

Retrieves the oEmbed response data for a given post.
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-admin/includes/class-wp-list-table.php: WP_List_Table::comments_bubble()

Displays a comment count bubble.
wp-admin/includes/post.php: redirect_post()

Redirect to previous page.
wp-includes/class-wp-query.php: WP_Query::get_posts()

Retrieves an array of posts based on query variables.
wp-includes/link-template.php: get_post_permalink()

Retrieves the permalink for a post of a custom post type.
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/canonical.php: redirect_canonical()

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

Decorates a menu item object with the shared navigation menu item properties.

Changelog

Version Description
2.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_post_status