wppaste
WordPress

get_available_post_statuses( string $type = 'post' ): string[]

Since
2.5.0
Source
wp-admin/includes/post.php:1210
Returns all the possible statuses for a post type.

Compatibility

WordPress
since 2.5.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$typestringoptional
The post_type you want the statuses for. Default 'post'.Default: 'post'

Return value

string[]
An array of all the statuses for the supplied post type.

Performance profile

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

Only touches the object cache, via wp_cache_get().

Scaling
Constant

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

Instructions
12

Executed per call on PHP 8.5. The body compiles to 12.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

  • cacheobject cachewp_cache_get()one call below get_available_post_statuses()
  • hookthird-party callbacksapply_filters()one call below get_available_post_statuses()

Further down the call graph this can also reach query. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

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

WhenInstructionsCalls it makes
always12wp_count_posts(), get_object_vars(), array_keys()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 12 instructions, 12 executed per call, 0 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 1

  • wp_count_posts()Counts number of posts of a post type and if user has permissions to view.

Used by · 1

Source code

View on Trac View on GitHub 

function get_available_post_statuses( $type = 'post' ) {	$statuses = wp_count_posts( $type ); 	return array_keys( get_object_vars( $statuses ) );}

Changelog

Introduced in 2.5.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 7.0.4 tag, from src/wp-admin/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.