W3cubDocs

/WordPress

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

Gets a list of post statuses.

Description

See also

Parameters

$argsarray|stringoptional
Array or string of post status arguments to compare against properties of the global $wp_post_statuses objects.

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

string[]|stdClass[] A list of post status names or objects.

Source

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

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_post_stati