get_post_status_object( string $post_status ): stdClass|null

Parameters

$post_statusstring

The name of a registered post status.

Return

stdClass|null

A post status object.

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".

Source

View on Trac ↗View on GitHub ↗

1513function get_post_status_object( $post_status ) {1514	global $wp_post_statuses;1515 1516	if ( ! is_string( $post_status ) || empty( $wp_post_statuses[ $post_status ] ) ) {1517		return null;1518	}1519 1520	return $wp_post_statuses[ $post_status ];1521}

History

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.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.