W3cubDocs

/WordPress

WP_Widget_Media::display_media_state( array $states, WP_Post $post = null )

Filters the default media display states for items in the Media list table.

Parameters

$states

(array) (Required) An array of media states.

$post

(WP_Post) (Optional) The current attachment object.

Default value: null

Return

(array)

Source

File: wp-includes/widgets/class-wp-widget-media.php 

public function display_media_state( $states, $post = null ) {
		if ( ! $post ) {
			$post = get_post();
		}

		// Count how many times this attachment is used in widgets.
		$use_count = 0;
		foreach ( $this->get_settings() as $instance ) {
			if ( isset( $instance['attachment_id'] ) && $instance['attachment_id'] === $post->ID ) {
				$use_count++;
			}
		}

		if ( 1 === $use_count ) {
			$states[] = $this->l10n['media_library_state_single'];
		} elseif ( $use_count > 0 ) {
			$states[] = sprintf( translate_nooped_plural( $this->l10n['media_library_state_multi'], $use_count ), number_format_i18n( $use_count ) );
		}

		return $states;
	}

Uses

Uses Description
wp-includes/l10n.php: translate_nooped_plural()

Translates and retrieves the singular or plural form of a string that’s been registered with _n_noop() or _nx_noop().
wp-includes/functions.php: number_format_i18n()

Convert float number to format based on the locale.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.

Changelog

Version Description
4.8.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_widget_media/display_media_state