get_compat_media_markup( int $attachment_id, array $args = null ): array

Compatibility

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

Parameters

$attachment_idint

$argsarrayoptional

Default: null

Return value

array

Performance profile

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

Scaling

Scales with input

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

Instructions

66–91

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

Plugin surface

3 hooks

Third-party callbacks on 'get_media_item_args', 'attachment_fields_to_edit', 'media_meta' 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

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()one call below get_compat_media_markup()

Further down the call graph this can also reach option, serialize 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 · 4 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 3

3 hooks fire while get_compat_media_markup() runs, in this order:

1. 1
   apply_filters( get_media_item_args )filterline 1887 (+13 into the body)

   Filters the arguments used to retrieve an image for the edit image form.

2. 2
   apply_filters( attachment_fields_to_edit )filterline 1935 (+61 into the body)

   Filters the attachment fields to edit.

3. 3
   apply_filters( media_meta )filterline 1950 (+76 into the body)

   Filters the media metadata.

Uses · 12

• get_post()Retrieves post data given a post ID or post object.
• current_user_can()Returns whether the current user has the specified capability.
• wp_parse_args()Merges user defined arguments into defaults array.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_attachment_taxonomies()Retrieves taxonomies attached to given the attachment.
• get_taxonomy()Retrieves the taxonomy object of $taxonomy.
• get_object_term_cache()Retrieves the cached term objects for the given object ID.
• wp_get_object_terms()Retrieves the terms associated with the given object(s), in the supplied taxonomies.
• wp_required_field_indicator()Assigns a visual indicator for required form fields.
• user_can_richedit()Determines whether the user can access the visual editor.
• esc_attr()Escaping for HTML attributes.
• wp_required_field_message()Creates a message to explain required form fields.

Used by · 2

• edit_form_image_editor()Displays the image and editor in the post editor
• 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 ↗

1874function get_compat_media_markup( $attachment_id, $args = null ) {1875	$post = get_post( $attachment_id );1876 1877	$default_args = array(1878		'errors'   => null,1879		'in_modal' => false,1880	);1881 1882	$user_can_edit = current_user_can( 'edit_post', $attachment_id );1883 1884	$args = wp_parse_args( $args, $default_args );1885 1886	/** This filter is documented in wp-admin/includes/media.php */1887	$args = apply_filters( 'get_media_item_args', $args );1888 1889	$form_fields = array();1890 1891	if ( $args['in_modal'] ) {1892		foreach ( get_attachment_taxonomies( $post ) as $taxonomy ) {1893			$t = (array) get_taxonomy( $taxonomy );1894 1895			if ( ! $t['public'] || ! $t['show_ui'] ) {1896				continue;1897			}1898 1899			if ( empty( $t['label'] ) ) {1900				$t['label'] = $taxonomy;1901			}1902 1903			if ( empty( $t['args'] ) ) {1904				$t['args'] = array();1905			}1906 1907			$terms = get_object_term_cache( $post->ID, $taxonomy );1908 1909			if ( false === $terms ) {1910				$terms = wp_get_object_terms( $post->ID, $taxonomy, $t['args'] );1911			}1912 1913			$values = array();1914 1915			foreach ( $terms as $term ) {1916				$values[] = $term->slug;1917			}1918 1919			$t['value']    = implode( ', ', $values );1920			$t['taxonomy'] = true;1921 1922			$form_fields[ $taxonomy ] = $t;1923		}1924	}1925 1926	/*1927	 * Merge default fields with their errors, so any key passed with the error1928	 * (e.g. 'error', 'helps', 'value') will replace the default.1929	 * The recursive merge is easily traversed with array casting:1930	 * foreach ( (array) $things as $thing )1931	 */1932	$form_fields = array_merge_recursive( $form_fields, (array) $args['errors'] );1933 1934	/** This filter is documented in wp-admin/includes/media.php */1935	$form_fields = apply_filters( 'attachment_fields_to_edit', $form_fields, $post );1936 1937	unset(1938		$form_fields['image-size'],1939		$form_fields['align'],1940		$form_fields['image_alt'],1941		$form_fields['post_title'],1942		$form_fields['post_excerpt'],1943		$form_fields['post_content'],1944		$form_fields['url'],1945		$form_fields['menu_order'],1946		$form_fields['image_url']1947	);1948 1949	/** This filter is documented in wp-admin/includes/media.php */1950	$media_meta = apply_filters( 'media_meta', '', $post );1951 1952	$defaults = array(1953		'input'         => 'text',

Changelog

Introduced in 3.5.0. One change between 6.7.7 and 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/media.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.