_post_states( WP_Post $post, bool $display = true ): string

Compatibility

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

Parameters

$postWP_Post

The post to retrieve states for.

$displaybooloptional

Whether to display the post states as an HTML string.
Default true.Default: true

Return value

string

Post states string.

Performance profile

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

Heavy

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

18–28

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

Plugin surface

1 hook

Third-party callbacks on 'post_states_html' run inside this call, and their cost is not bounded by anything here.

Called by

2

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

What it touches

• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below _post_states()

Further down the call graph this can also reach cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost _post_states() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while _post_states() runs, in this order:

1. 1
   apply_filters( post_states_html )filterline 2286 (+32 into the body)

   Filters the HTML string of post states.

Uses · 3

• get_post_states()Retrieves an array of post states from a post.
• wp_get_list_item_separator()Retrieves the list item separator based on the locale.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• WP_Posts_List_Table::column_title()Handles the title column output.
• Walker_Nav_Menu_Checklist::start_el()Start the element output.

Source code

View on Trac ↗View on GitHub ↗

2254function _post_states( $post, $display = true ) {2255	$post_states      = get_post_states( $post );2256	$post_states_html = '';2257 2258	if ( ! empty( $post_states ) ) {2259		$state_count = count( $post_states );2260		$separator   = wp_get_list_item_separator();2261 2262		$i = 0;2263 2264		$post_states_html .= ' &mdash; ';2265 2266		foreach ( $post_states as $state ) {2267			++$i;2268 2269			$suffix = ( $i < $state_count ) ? $separator : '';2270 2271			$post_states_html .= "<span class='post-state'>{$state}{$suffix}</span>";2272		}2273	}2274 2275	/**2276	 * Filters the HTML string of post states.2277	 *2278	 * @since 6.9.02279	 *2280	 * @param string                 $post_states_html All relevant post states combined into an HTML string for display.2281	 *                                                 E.g. `&mdash; <span class='post-state'>Draft, </span><span class='post-state'>Sticky</span>`.2282	 * @param array<string, string>  $post_states      A mapping of post state slugs to translated post state labels.2283	 *                                                 E.g. `array( 'draft' => __( 'Draft' ), 'sticky' => __( 'Sticky' ), ... )`.2284	 * @param WP_Post                $post             The current post object.2285	 */2286	$post_states_html = apply_filters( 'post_states_html', $post_states_html, $post_states, $post );2287 2288	if ( $display ) {2289		echo $post_states_html;2290	}2291 2292	return $post_states_html;2293}

Changelog

Introduced in 2.7.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/template.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.