get_post_status( int|WP_Post $post = null ): string|false
- Since
- 2.0.0
- Source
wp-includes/post.php:1252
Description
If the post ID is of an attachment, then the parent post status will be given instead.
Compatibility
- WordPress
- since 2.0.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$postint|WP_Postoptional- Post ID or post object. Defaults to global $post.Default:
null
Return value
string|false- Post status on success, false on failure.
Performance profile
How much work a call to get_post_status() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Constant
- Instructions
- 10–57
- Plugin surface
- 1 hook
- Called by
- 27
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 73.
Third-party callbacks on 'get_post_status' run inside this call, and their cost is not bounded by anything here.
27 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_post()called directly - hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach cache, serialize, option and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 9 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_post_status() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_object($post) | 10–15 | get_post() |
$post instanceof && isset($post) && !is_object($post) | 11 | none |
is_object($post) | 22–37 | get_post(), apply_filters() |
$post instanceof && isset($post) && is_object($post) | 23–28 | apply_filters() |
is_object($post) && $post_status === "inherit" | 32–41 | get_post(), get_post(), apply_filters() |
is_object($post) && $post_status === "inherit" && get_post() | 48–53 | get_post(), get_post(), get_post_status(), get_post_status(), apply_filters() |
$post instanceof && isset($post) && is_object($post) && $post_status === "inherit" && get_post() | 49 | get_post(), get_post_status(), get_post_status(), apply_filters() |
is_object($post) && $post_status === "inherit" && get_post() | 50–57 | get_post(), get_post(), get_post_status(), get_post_meta(), apply_filters() |
$post instanceof && isset($post) && is_object($post) && $post_status === "inherit" && get_post() | 51–53 | get_post(), get_post_status(), get_post_meta(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 73 instructions, 10–57 executed per call, 13 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while get_post_status() runs, in this order:
Uses · 4
- get_post()Retrieves post data given a post ID or post object.
- get_post_status()Retrieves the post status based on the post ID.
- get_post_meta()Retrieves a post meta field for the given post ID.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 27
- WP_Customize_Manager::handle_changeset_trash_request()Handles request to trash a changeset.
- WP_Customize_Manager::handle_dismiss_autosave_or_lock_request()Deletes a given auto-draft changeset or the autosave revision for a given changeset or delete changeset lock.
- WP_Customize_Manager::import_theme_starter_content()Imports theme starter content into the customized state.
- WP_Customize_Manager::save_changeset_post()Saves the post for the loaded changeset.
- WP_Customize_Manager::trash_changeset_post()Trashes or deletes a changeset post.
- WP_Customize_Nav_Menus::save_nav_menus_created_posts()Publishes the auto-draft posts that were created for nav menu items.
- WP_List_Table::comments_bubble()Displays a comment count bubble.
- WP_Privacy_Requests_Table::column_status()Status column.
- WP_Query::get_posts()Retrieves an array of posts based on query variables.
- WP_REST_Posts_Controller::prepare_links()Prepares links for the request.
- _wp_delete_customize_changeset_dependent_auto_drafts()Deletes auto-draft posts associated with the supplied changeset.
- _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.
Show all 27
- get_post_status()Retrieves the post status based on the post ID.
- get_privacy_policy_url()Retrieves the URL to the privacy policy page.
- is_post_publicly_viewable()Determines whether a post is publicly viewable.
- map_meta_cap()Maps a capability to the primitive capabilities required of the given user to satisfy the capability being checked.
- redirect_canonical()Redirects incoming links to the proper URL based on the site url.
- redirect_post()Redirects to previous page.
- register_and_do_post_meta_boxes()Registers the default post meta boxes, and runs the `do_meta_boxes` actions.
- the_block_editor_meta_box_post_form_hidden_fields()Renders the hidden form required for the meta boxes form.
- wp_delete_post()Trashes or deletes a post or page.
- wp_force_plain_post_permalink()Determine whether post should always use a plain permalink structure.
- wp_get_canonical_url()Returns the canonical URL for a post.
- wp_handle_comment_submission()Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.
- wp_set_post_categories()Sets categories for a post.
- wp_setup_nav_menu_item()Decorates a menu item object with the shared navigation menu item properties.
- wp_xmlrpc_server::wp_newComment()Creates a new comment.
Source code
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 );}Changelog
Introduced in 2.0.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 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.