get_post_status_object( string $post_status ): stdClass|null
- Since
- 3.0.0
- Source
wp-includes/post.php:1488
Compatibility
- WordPress
- since 3.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
$post_statusstring- The name of a registered post status.
Return value
stdClass|null- A post status object.
Performance profile
How much work a call to get_post_status_object() 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
- Trivial
- Scaling
- Constant
- Instructions
- 5–6
- Plugin surface
- None
- Called by
- 18
Touches nothing outside its own arguments.
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 7.
Nothing here hands control to plugin code.
18 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_post_status_object() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 5–6 | none |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 7 instructions, 5–6 executed per call, 1 branch. 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.
Used by · 18
- WP::parse_request()Parses the request to find the correct WordPress query.
- WP_Customize_Manager::save()Handles customize_save WP Ajax request to save/update a changeset.
- WP_Privacy_Requests_Table::column_status()Status column.
- WP_Privacy_Requests_Table::get_views()Gets an associative array ( id => link ) with the list of views available on this table.
- WP_Query::get_posts()Retrieves an array of posts based on query variables.
- WP_REST_Post_Statuses_Controller::get_item()Retrieves a specific post status.
- WP_REST_Post_Statuses_Controller::get_item_permissions_check()Checks if a given request has access to read a post status.
- WP_REST_Post_Statuses_Controller::get_items()Retrieves all post statuses, depending on user context.
- WP_REST_Posts_Controller::check_read_permission()Checks if a post can be read.
- WP_REST_Posts_Controller::handle_status_param()Determines validity and normalizes the given status parameter.
- _wp_translate_postdata()Renames `$_POST` data from form names to DB post columns.
- is_post_status_viewable()Determines whether a post status is considered "viewable".
Show all 18
- 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.
- url_to_postid()Examines a URL and try to determine the post ID it represents.
- wp_force_plain_post_permalink()Determine whether post should always use a plain permalink structure.
- wp_handle_comment_submission()Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.
- wp_xmlrpc_server::_insert_post()Helper method for wp_newPost() and wp_editPost(), containing shared logic.
Source code
function get_post_status_object( $post_status ) { global $wp_post_statuses; if ( empty( $wp_post_statuses[ $post_status ] ) ) { return null; } return $wp_post_statuses[ $post_status ];}Changelog
Introduced in 3.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 6.7.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.