_media_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 attachment post to retrieve states for.

$displaybooloptional

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

Return value

string

Media states string.

Performance profile

How much work a call to _media_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

11–21

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

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

• optionoption read or writeget_option()one call below _media_states()
• hookthird-party callbacksapply_filters()one call below _media_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 _media_states() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

• get_media_states()Retrieves an array of media states from an attachment.
• wp_get_list_item_separator()Retrieves the list item separator based on the locale.

Used by · 1

• WP_Media_List_Table::column_title()Handles the title column output.

Source code

View on Trac ↗View on GitHub ↗

2382function _media_states( $post, $display = true ) {2383	$media_states        = get_media_states( $post );2384	$media_states_string = '';2385 2386	if ( ! empty( $media_states ) ) {2387		$state_count = count( $media_states );2388		$separator   = wp_get_list_item_separator();2389 2390		$i = 0;2391 2392		$media_states_string .= ' &mdash; ';2393 2394		foreach ( $media_states as $state ) {2395			++$i;2396 2397			$suffix = ( $i < $state_count ) ? $separator : '';2398 2399			$media_states_string .= "<span class='post-state'>{$state}{$suffix}</span>";2400		}2401	}2402 2403	if ( $display ) {2404		echo $media_states_string;2405	}2406 2407	return $media_states_string;2408}

Changelog

Introduced in 3.2.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.