get_post_status_object( string $post_status )

Retrieve a post status object by name.

Description

See also

Top ↑

Parameters

$post_status

(string) (Required) The name of a registered post status.

Top ↑

Return

(object|null) A post status object.

Top ↑

Source

File: wp-includes/post.php 

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

View on Trac

Top ↑

Changelog

Version Description
3.0.0 Introduced.

Top ↑

Top ↑

Used By

Used By Description
wp-admin/includes/class-wp-privacy-requests-table.php: WP_Privacy_Requests_Table::column_status()

Status column.
wp-admin/includes/class-wp-privacy-requests-table.php: WP_Privacy_Requests_Table::get_views()

Get an associative array ( id => link ) with the list of views available on this table.
wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php: WP_REST_Post_Statuses_Controller::get_items()

Retrieves all post statuses, depending on user context.
wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php: WP_REST_Post_Statuses_Controller::get_item_permissions_check()

Checks if a given request has access to read a post status.
wp-includes/rest-api/endpoints/class-wp-rest-post-statuses-controller.php: WP_REST_Post_Statuses_Controller::get_item()

Retrieves a specific post status.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::check_read_permission()

Checks if a post can be read.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::handle_status_param()

Determines validity and normalizes the given status parameter.
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/post.php: _wp_translate_postdata()

Rename $_POST data from form names to DB post columns.
wp-includes/capabilities.php: map_meta_cap()

Maps meta capabilities to primitive capabilities.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::save()

Handle customize_save WP Ajax request to save/update a changeset.
wp-includes/class-wp.php: WP::parse_request()

Parse request to find correct WordPress query.
wp-includes/class-wp-query.php: WP_Query::get_posts()

Retrieves an array of posts based on query variables.
wp-includes/rewrite.php: url_to_postid()

Examine a URL and try to determine the post ID it represents.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_insert_post()

Helper method for wp_newPost() and wp_editPost(), containing shared logic.