get_media_states( WP_Post $post ): 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 to retrieve states for.

Return value

string[]

Array of media state labels keyed by their state.

Performance profile

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

Reaches the database via get_posts().

Scaling

Constant

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

Instructions

35–143

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

Plugin surface

1 hook

Third-party callbacks on 'display_media_states' 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

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()one call below get_media_states()
• serializeserialisationmaybe_unserialize()one call below get_media_states()
• querycontent queryget_posts()one call below get_media_states()

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

What one call costs · 900 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( display_media_states )filterline 2481 (+70 into the body)

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

Uses · 15

• get_option()Retrieves an option value based on an option name.
• current_theme_supports()Checks a theme's support for a given feature.
• get_post_meta()Retrieves a post meta field for the given post ID.
• is_random_header_image()Checks if random header image is in use.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• get_uploaded_header_images()Gets the header images uploaded for the active theme.
• __()Retrieves the translation of $text.
• get_header_image()Retrieves header image for custom header.
• wp_get_attachment_url()Retrieves the URL for an attachment.
• get_theme_support()Gets the theme support arguments passed when registering that support.
• has_header_video()Checks whether a header video is set or not.
• get_theme_mods()Retrieves all theme modifications.

Used by · 2

• _media_states()Outputs the attachment media states as HTML.
• wp_prepare_attachment_for_js()Prepares an attachment post object for JS, where it is expected to be JSON-encoded and fit into an Attachment model.

Source code

View on Trac ↗View on GitHub ↗

2411function get_media_states( $post ) {2412	static $header_images;2413 2414	$media_states = array();2415	$stylesheet   = get_option( 'stylesheet' );2416 2417	if ( current_theme_supports( 'custom-header' ) ) {2418		$meta_header = get_post_meta( $post->ID, '_wp_attachment_is_custom_header', true );2419 2420		if ( is_random_header_image() ) {2421			if ( ! isset( $header_images ) ) {2422				$header_images = wp_list_pluck( get_uploaded_header_images(), 'attachment_id' );2423			}2424 2425			if ( $meta_header === $stylesheet && in_array( $post->ID, $header_images, true ) ) {2426				$media_states[] = __( 'Header Image' );2427			}2428		} else {2429			$header_image = get_header_image();2430 2431			// Display "Header Image" if the image was ever used as a header image.2432			if ( ! empty( $meta_header ) && $meta_header === $stylesheet && wp_get_attachment_url( $post->ID ) !== $header_image ) {2433				$media_states[] = __( 'Header Image' );2434			}2435 2436			// Display "Current Header Image" if the image is currently the header image.2437			if ( $header_image && wp_get_attachment_url( $post->ID ) === $header_image ) {2438				$media_states[] = __( 'Current Header Image' );2439			}2440		}2441 2442		if ( get_theme_support( 'custom-header', 'video' ) && has_header_video() ) {2443			$mods = get_theme_mods();2444			if ( isset( $mods['header_video'] ) && $post->ID === $mods['header_video'] ) {2445				$media_states[] = __( 'Current Header Video' );2446			}2447		}2448	}2449 2450	if ( current_theme_supports( 'custom-background' ) ) {2451		$meta_background = get_post_meta( $post->ID, '_wp_attachment_is_custom_background', true );2452 2453		if ( ! empty( $meta_background ) && $meta_background === $stylesheet ) {2454			$media_states[] = __( 'Background Image' );2455 2456			$background_image = get_background_image();2457			if ( $background_image && wp_get_attachment_url( $post->ID ) === $background_image ) {2458				$media_states[] = __( 'Current Background Image' );2459			}2460		}2461	}2462 2463	if ( (int) get_option( 'site_icon' ) === $post->ID ) {2464		$media_states[] = __( 'Site Icon' );2465	}2466 2467	if ( (int) get_theme_mod( 'custom_logo' ) === $post->ID ) {2468		$media_states[] = __( 'Logo' );2469	}2470 2471	/**2472	 * Filters the default media display states for items in the Media list table.2473	 *2474	 * @since 3.2.02475	 * @since 4.8.0 Added the `$post` parameter.2476	 *2477	 * @param string[] $media_states An array of media states. Default 'Header Image',2478	 *                               'Background Image', 'Site Icon', 'Logo'.2479	 * @param WP_Post  $post         The current attachment object.2480	 */2481	return apply_filters( 'display_media_states', $media_states, $post );2482}

Changelog

Introduced in 5.6.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 6.9.7 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.