get_media_item( int $attachment_id, string|array $args = null ): string

Parameters

$attachment_idint

Attachment ID for modification.

$argsstring|arrayoptional

Override defaults.Default: null

Return

string

HTML form for attachment.

Hooks fired · 2

2 hooks fire while get_media_item() runs, in this order:

1. 1
   apply_filters( get_media_item_args )filterline 1635 (+36 into the body)

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

2. 2
   apply_filters( media_meta )filterline 1696 (+97 into the body)

   Filters the media metadata.

Uses · 32

• wp_get_attachment_image_src()Retrieves an image to represent an attachment.
• get_post()Retrieves post data given a post ID or post object.
• post_type_supports()Checks a post type's support for a given feature.
• get_post_type()Retrieves the post type of the current post or of a given post.
• wp_parse_args()Merges user defined arguments into defaults array.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• __()Retrieves the translation of $text.
• get_attached_file()Retrieves attached file path based on attachment ID.
• esc_html()Escaping for HTML blocks.
• wp_basename()i18n-friendly version of basename().
• esc_attr()Escaping for HTML attributes.
• get_post_mime_types()Gets default post mime types.

Used by · 1

• get_media_items()Retrieves HTML for media items of post gallery.

Source

View on Trac ↗View on GitHub ↗

1599function get_media_item( $attachment_id, $args = null ) {1600	global $redir_tab;1601 1602	$thumb_url     = false;1603	$attachment_id = (int) $attachment_id;1604 1605	if ( $attachment_id ) {1606		$thumb_url = wp_get_attachment_image_src( $attachment_id, 'thumbnail', true );1607 1608		if ( $thumb_url ) {1609			$thumb_url = $thumb_url[0];1610		}1611	}1612 1613	$post            = get_post( $attachment_id );1614	$current_post_id = ! empty( $_GET['post_id'] ) ? (int) $_GET['post_id'] : 0;1615 1616	$default_args = array(1617		'errors'     => null,1618		'send'       => $current_post_id ? post_type_supports( get_post_type( $current_post_id ), 'editor' ) : true,1619		'delete'     => true,1620		'toggle'     => true,1621		'show_title' => true,1622	);1623 1624	$parsed_args = wp_parse_args( $args, $default_args );1625 1626	/**1627	 * Filters the arguments used to retrieve an image for the edit image form.1628	 *1629	 * @since 3.1.01630	 *1631	 * @see get_media_item1632	 *1633	 * @param array $parsed_args An array of arguments.1634	 */1635	$parsed_args = apply_filters( 'get_media_item_args', $parsed_args );1636 1637	$toggle_on  = __( 'Show' );1638	$toggle_off = __( 'Hide' );1639 1640	$file     = get_attached_file( $post->ID );1641	$filename = esc_html( wp_basename( $file ) );1642	$title    = esc_attr( $post->post_title );1643 1644	$post_mime_types = get_post_mime_types();1645	$keys            = array_keys( wp_match_mime_types( array_keys( $post_mime_types ), $post->post_mime_type ) );1646	$type            = reset( $keys );1647	$type_html       = "<input type='hidden' id='type-of-$attachment_id' value='" . esc_attr( $type ) . "' />";1648 1649	$form_fields = get_attachment_fields_to_edit( $post, $parsed_args['errors'] );1650 1651	if ( $parsed_args['toggle'] ) {1652		$class        = empty( $parsed_args['errors'] ) ? 'startclosed' : 'startopen';1653		$toggle_links = "1654		<a class='toggle describe-toggle-on' href='#'>$toggle_on</a>1655		<a class='toggle describe-toggle-off' href='#'>$toggle_off</a>";1656	} else {1657		$class        = '';1658		$toggle_links = '';1659	}1660 1661	$display_title = ( ! empty( $title ) ) ? $title : $filename; // $title shouldn't ever be empty, but just in case.1662	$display_title = $parsed_args['show_title'] ? "<div class='filename new'><span class='title'>" . wp_html_excerpt( $display_title, 60, '&hellip;' ) . '</span></div>' : '';1663 1664	$gallery = ( ( isset( $_REQUEST['tab'] ) && 'gallery' === $_REQUEST['tab'] ) || ( isset( $redir_tab ) && 'gallery' === $redir_tab ) );1665	$order   = '';1666 1667	foreach ( $form_fields as $key => $val ) {1668		if ( 'menu_order' === $key ) {1669			if ( $gallery ) {1670				$order = "<div class='menu_order'> <input class='menu_order_input' type='text' id='attachments[$attachment_id][menu_order]' name='attachments[$attachment_id][menu_order]' value='" . esc_attr( $val['value'] ) . "' /></div>";1671			} else {1672				$order = "<input type='hidden' name='attachments[$attachment_id][menu_order]' value='" . esc_attr( $val['value'] ) . "' />";1673			}1674 1675			unset( $form_fields['menu_order'] );1676			break;1677		}1678	}

History

Introduced in 2.5.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/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.