wp_get_attachment_metadata() – Function

Retrieves attachment metadata for attachment ID.

Parameters

$attachment_idintrequired: Attachment post ID. Defaults to global $post.
$unfilteredbooloptional: If true, filters are not run.
Default:false

Return

array|false Attachment metadata. False on failure.

width int
The width of the attachment.
height int
The height of the attachment.
file string
The file path relative to wp-content/uploads.
sizes array
Keys are size slugs, each value is an array containing 'file', 'width', 'height', and 'mime-type'.
image_meta array
Image metadata.
filesize int
File size of the attachment.

Source

function wp_get_attachment_metadata( $attachment_id = 0, $unfiltered = false ) {
	$attachment_id = (int) $attachment_id;

	if ( ! $attachment_id ) {
		$post = get_post();

		if ( ! $post ) {
			return false;
		}

		$attachment_id = $post->ID;
	}

	$data = get_post_meta( $attachment_id, '_wp_attachment_metadata', true );

	if ( ! is_array( $data ) || ! $data ) {
		return false;
	}

	if ( $unfiltered ) {
		return $data;
	}

	/**
	 * Filters the attachment meta data.
	 *
	 * @since 2.1.0
	 *
	 * @param array $data          Array of meta data for the given attachment.
	 * @param int   $attachment_id Attachment post ID.
	 */
	$data = apply_filters( 'wp_get_attachment_metadata', $data, $attachment_id );

	if ( ! is_array( $data ) ) {
		return false;
	}

	if ( array_key_exists( 'sizes', $data ) && ! is_array( $data['sizes'] ) ) {
		$data['sizes'] = array();
	}

	return $data;
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘wp_get_attachment_metadata’, array $data, int $attachment_id ): Filters the attachment meta data.

Uses	Description
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_post_meta()`wp-includes/post.php`	Retrieves a post meta field for the given post ID.
get_post()`wp-includes/post.php`	Retrieves post data given a post ID or post object.

Show 1 more Show less

Used by	Description
WP_REST_Attachments_Controller::validate_image_dimensions()`wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php`	Validates that uploaded image dimensions are appropriate for the specified image size.
WP_REST_Attachments_Controller::get_sideloaded_file_names()`wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php`	Returns the file names which a finalize request may store for an attachment.
WP_REST_Attachments_Controller::finalize_item()`wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php`	Finalizes an attachment after client-side media processing.
WP_REST_Attachments_Controller::get_attachment_filesize()`wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php`	Gets the attachment’s file size in bytes.
WP_REST_Attachments_Controller::edit_media_item()`wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php`	Applies edits to a media item and creates a new attachment record.
wp_img_tag_add_width_and_height_attr()`wp-includes/media.php`	Adds `width` and `height` attributes to an `img` HTML tag.
wp_img_tag_add_srcset_and_sizes_attr()`wp-includes/media.php`	Adds `srcset` and `sizes` attributes to an existing `img` HTML tag.
wp_get_original_image_path()`wp-includes/post.php`	Retrieves the path to an uploaded image file.
wp_get_original_image_url()`wp-includes/post.php`	Retrieves the URL to an original attachment image.
wp_get_missing_image_subsizes()`wp-admin/includes/image.php`	Compare the existing image sub-sizes (as saved in the attachment meta) to the currently registered image sub-sizes, and return the difference.
wp_update_image_subsizes()`wp-admin/includes/image.php`	If any of the currently registered image sub-sizes are missing, create them and update the image meta data.
WP_Widget_Media_Image::render_media()`wp-includes/widgets/class-wp-widget-media-image.php`	Render the media on the frontend.
WP_Customize_Manager::import_theme_starter_content()`wp-includes/class-wp-customize-manager.php`	Imports theme starter content into the customized state.
WP_REST_Attachments_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php`	Prepares a single attachment output for response.
wp_get_attachment_image_srcset()`wp-includes/media.php`	Retrieves the value for an image attachment’s ‘srcset’ attribute.
wp_get_attachment_image_sizes()`wp-includes/media.php`	Retrieves the value for an image attachment’s ‘sizes’ attribute.
wp_calculate_image_sizes()`wp-includes/media.php`	Creates a ‘sizes’ attribute value for an image.
wp_restore_image()`wp-admin/includes/image-edit.php`	Restores the metadata for a given attachment.
wp_save_image()`wp-admin/includes/image-edit.php`	Saves image to post, along with enqueued changes in `$_REQUEST['history']`.
wp_image_editor()`wp-admin/includes/image-edit.php`	Loads the WP image-editing interface.
edit_form_image_editor()`wp-admin/includes/media.php`	Displays the image and editor in the post editor
attachment_submitbox_metadata()`wp-admin/includes/media.php`	Displays non-editable attachment metadata in the publish meta box.
get_media_item()`wp-admin/includes/media.php`	Retrieves HTML form for modifying the image attachment.
edit_post()`wp-admin/includes/post.php`	Updates an existing post with values provided in `$_POST`.
wp_ajax_save_attachment()`wp-admin/includes/ajax-actions.php`	Handles updating attachment attributes via AJAX.
attachment_id3_data_meta_box()`wp-admin/includes/meta-boxes.php`	Displays fields for ID3 data.
Custom_Image_Header::step_2()`wp-admin/includes/class-custom-image-header.php`	Displays second step of custom header image page.
get_uploaded_header_images()`wp-includes/theme.php`	Gets the header images uploaded for the active theme.
prepend_attachment()`wp-includes/post-template.php`	Wraps attachment in paragraph tag before content.
wp_maybe_generate_attachment_metadata()`wp-includes/media.php`	Maybe attempts to generate attachment metadata, if missing.
wp_prepare_attachment_for_js()`wp-includes/media.php`	Prepares an attachment post object for JS, where it is expected to be JSON-encoded and fit into an Attachment model.
gallery_shortcode()`wp-includes/media.php`	Builds the Gallery shortcode output.
wp_playlist_shortcode()`wp-includes/media.php`	Builds the Playlist shortcode output.
image_get_intermediate_size()`wp-includes/media.php`	Retrieves the image’s intermediate size (resized) path, width, and height.
wp_get_attachment_image()`wp-includes/media.php`	Gets an HTML img element representing an image attachment.
image_downsize()`wp-includes/media.php`	Scales an image to fit a particular size (such as ‘thumb’ or ‘medium’).
wp_get_attachment_thumb_file()`wp-includes/deprecated.php`	Retrieves thumbnail for an attachment.
wp_delete_attachment()`wp-includes/post.php`	Trashes or deletes an attachment.
wp_xmlrpc_server::_prepare_media_item()`wp-includes/class-wp-xmlrpc-server.php`	Prepares media item data for return in an XML-RPC object.

Show 34 more Show less

Changelog

Version	Description
7.1.0	`false` is now returned if the metadata is not an array, and when the result is filtered the `sizes` key is always an array when present.
6.0.0	The `$filesize` value was added to the returned array.
2.1.0	Introduced.

User Contributed Notes

Codex 11 years ago

Example return value

Array
(
	[width] => 2400
	[height] => 1559
	[file] => 2011/12/press_image.jpg
	[sizes] => Array
	(
		[thumbnail] => Array
		(
			[file] => press_image-150x150.jpg
			[width] => 150
			[height] => 150
			[mime-type] => image/jpeg
		)
		 => Array
		(
			[file] => press_image-4-300x194.jpg
			[width] => 300
			[height] => 194
			[mime-type] => image/jpeg
		)
		[large] => Array
		(
			[file] => press_image-1024x665.jpg
			[width] => 1024
			[height] => 665
			[mime-type] => image/jpeg
		)
		[post-thumbnail] => Array
		(
			[file] => press_image-624x405.jpg
			[width] => 624
			[height] => 405
			[mime-type] => image/jpeg
		)
	)
	[image_meta] => Array
	(
		[aperture] => 5
		[credit] => 
		[camera] => Canon EOS-1Ds Mark III
		 => 
		[created_timestamp] => 1323190643
		[copyright] => 
		[focal_length] => 35
		[iso] => 800
		[shutter_speed] => 0.016666666666667
		[title] => 
	)
)

Skip to note 6 content

Toru Miki 4 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

Note that, since WordPress 6.0, return value includes filesize. This is for can be utilized so that image file size ca be retrieved without having to call php function filesize.

See Media: storing file size as part of metadata.

Log in to add feedback

Anonymous User 7 years ago

Example for video format:

array(10) {
	[&quot;filesize&quot;] =&gt; int(227431276)
	[&quot;mime_type&quot;] =&gt; string(9) &quot;video/mp4&quot;
	[&quot;length&quot;] =&gt; int(918)
	[&quot;length_formatted&quot;] =&gt; string(5) &quot;15:18&quot;
	[&quot;width&quot;] =&gt; int(1280)
	[&quot;height&quot;] =&gt; int(720)
	[&quot;fileformat&quot;] =&gt; string(3) &quot;mp4&quot;
	[&quot;dataformat&quot;] =&gt; string(9) &quot;quicktime&quot;
	[&quot;audio&quot;] =&gt; array(7) {
		[&quot;dataformat&quot;] =&gt; string(3) &quot;mp4&quot;
		[&quot;codec&quot;] =&gt; string(19) &quot;ISO/IEC 14496-3 AAC&quot;
		[&quot;sample_rate&quot;] =&gt; float(44100)
		[&quot;channels&quot;] =&gt; int(2)
		[&quot;bits_per_sample&quot;] =&gt; int(16)
		[&quot;lossless&quot;] =&gt; bool(false)
		[&quot;channelmode&quot;] =&gt; string(6) &quot;stereo&quot;
	}
	[&quot;created_timestamp&quot;]=&gt; int(-2082844800)
}

Skip to note 8 content

nellalink 6 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
NOTE that when calling wp_get_attachment_metadata() , the ARRAY index returned from ‘file’ is the file path relative to wp-content/uploads.

If you want to get url of domain to link up, you can use snippet below
```
$upload_dir = wp_upload_dir();
$attachment_metadata = wp_get_attachment_metadata( $attachment_id );
echo var_dump( $upload_dir['url'] . '/' . $attachment_metadata['sizes']['medium_large']['file'] );
```
Log in to add feedback

wp_get_attachment_metadata( int $attachment_id, bool $unfiltered = false ): array|false

In this article

Parameters

Return

Source

Hooks

Related

Changelog

User Contributed Notes