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

Outputs the attachment media states as HTML.


Parameters

$post WP_Post Required
The attachment post to retrieve states for.
$display bool Optional
Whether to display the post states as an HTML string.

Default: true


Top ↑

Return

string Media states string.


Top ↑

Source

File: wp-admin/includes/template.php. View all references

function _media_states( $post, $display = true ) {
	$media_states        = get_media_states( $post );
	$media_states_string = '';

	if ( ! empty( $media_states ) ) {
		$state_count = count( $media_states );

		$i = 0;

		$media_states_string .= ' — ';

		foreach ( $media_states as $state ) {
			++$i;

			$sep = ( $i < $state_count ) ? ', ' : '';

			$media_states_string .= "<span class='post-state'>$state$sep</span>";
		}
	}

	if ( $display ) {
		echo $media_states_string;
	}

	return $media_states_string;
}


Top ↑

Changelog

Changelog
Version Description
5.6.0 Added the $display parameter and a return value.
3.2.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.