get_post_stati( array|string $args = array(), string $output = 'names', string $operator = 'and' )
Get a list of post statuses.
Description
See also
Parameters
- $args
-
(Optional) Array or string of post status arguments to compare against properties of the global
$wp_post_statuses objects
.Default value: array()
- $output
-
(Optional) The type of output to return, either 'names' or 'objects'. Default 'names'.
Default value: 'names'
- $operator
-
(Optional) 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 value: 'and'
Return
(array) A list of post status names or objects.
Source
File: wp-includes/post.php
function get_post_stati( $args = array(), $output = 'names', $operator = 'and' ) {
global $wp_post_statuses;
$field = ('names' == $output) ? 'name' : false;
return wp_filter_object_list($wp_post_statuses, $args, $operator, $field);
}
Changelog
Version | Description |
---|---|
WP-3.0.0 | Introduced. |