get_post_stati( array|string $args = array(), string $output = 'names', string $operator = 'and' ): string[]|stdClass[]

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarray|stringoptional

Array or string of post status arguments to compare against properties of the global $wp_post_statuses objects. Default empty array.Default: array()

$outputstringoptional

The type of output to return, either 'names' or 'objects'. Default 'names'.Default: 'names'

$operatorstringoptional

The logical operation to perform. 'or' means only one element from the array needs to match; 'and' means all elements must match.
Default 'and'.Default: 'and'

Return value

string[]|stdClass[]

A list of post status names or objects.

Performance profile

How much work a call to get_post_stati() 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

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

15–16

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 17.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

21

21 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_stati() can have, taken from its control-flow graph on PHP 8.5.

Uses · 1

• wp_filter_object_list()Filters a list of objects, based on a set of key => value arguments.

Used by · 21

• WP_Customize_Manager::establish_loaded_changeset()Establishes the loaded changeset.
• WP_Customize_Manager::find_changeset_post_id()Finds the changeset post ID for a given changeset UUID.
• WP_Customize_Manager::import_theme_starter_content()Imports theme starter content into the customized state.
• WP_Posts_List_Table::__construct()Constructor.
• WP_Posts_List_Table::get_views()
• WP_Posts_List_Table::prepare_items()
• WP_Privacy_Requests_Table::get_request_counts()Counts the number of requests for each status.
• WP_Query::get_posts()Retrieves an array of posts based on query variables.
• WP_REST_Menu_Items_Controller::get_item_schema()Retrieves the nav menu item's schema, conforming to JSON Schema.
• WP_REST_Post_Statuses_Controller::get_items()Retrieves all post statuses, depending on user context.
• WP_REST_Posts_Controller::get_collection_params()Retrieves the query params for the posts collection.
• WP_REST_Posts_Controller::get_item_schema()Retrieves the post's schema, conforming to JSON Schema.

Source code

View on Trac ↗View on GitHub ↗

1515function get_post_stati( $args = array(), $output = 'names', $operator = 'and' ) {1516	global $wp_post_statuses;1517 1518	$field = ( 'names' === $output ) ? 'name' : false;1519 1520	return wp_filter_object_list( $wp_post_statuses, $args, $operator, $field );1521}

Changelog

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