wp_get_attachment_metadata( int $attachment_id, bool $unfiltered = false )

Retrieve attachment meta field for attachment ID.

Contents

Description Description

Parameters Parameters

$attachment_id

(int) (Required) Attachment post ID. Defaults to global $post.

$unfiltered

(bool) (Optional) If true, filters are not run.

Default value: false

Top ↑

Return Return

(mixed) Attachment meta field. False on failure.

Top ↑

Source Source

File: wp-includes/post.php 

function wp_get_attachment_metadata( $attachment_id = 0, $unfiltered = false ) {
	$attachment_id = (int) $attachment_id;
	$post          = get_post( $attachment_id );
	if ( ! $post ) {
		return false;
	}

	$data = get_post_meta( $post->ID, '_wp_attachment_metadata', true );

	if ( $unfiltered ) {
		return $data;
	}

	/**
	 * Filters the attachment meta data.
	 *
	 * @since 2.1.0
	 *
	 * @param array|bool $data          Array of meta data for the given attachment, or false
	 *                                  if the object does not exist.
	 * @param int        $attachment_id Attachment post ID.
	 */
	return apply_filters( 'wp_get_attachment_metadata', $data, $post->ID );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.1.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/post.php: wp_get_attachment_metadata

Filters the attachment meta data.
wp-includes/post.php: get_post_meta()

Retrieves a post meta field for the given post ID.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/post.php: wp_get_original_image_path()

Retrieves the path to an uploaded image file.
wp-includes/post.php: wp_get_original_image_url()

Retrieve the URL to an original attachment image.
wp-admin/includes/image.php: wp_get_missing_image_subsizes()

Compare the existing image sub-sizes (as saved in the attachment meta) to the currently registered image sub-sizes, and return the difference.
wp-admin/includes/image.php: wp_update_image_subsizes()

If any of the currently registered image sub-sizes are missing, create them and update the image meta data.
wp-includes/widgets/class-wp-widget-media-image.php: WP_Widget_Media_Image::render_media()

Render the media on the frontend.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::import_theme_starter_content()

Import theme starter content into the customized state.
wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php: WP_REST_Attachments_Controller::prepare_item_for_response()

Prepares a single attachment output for response.
wp-includes/media.php: wp_make_content_images_responsive()

Filters ‘img’ elements in post content to add ‘srcset’ and ‘sizes’ attributes.
wp-includes/media.php: wp_get_attachment_image_srcset()

Retrieves the value for an image attachment’s ‘srcset’ attribute.
wp-includes/media.php: wp_get_attachment_image_sizes()

Retrieves the value for an image attachment’s ‘sizes’ attribute.
wp-includes/media.php: wp_calculate_image_sizes()

Creates a ‘sizes’ attribute value for an image.
wp-admin/includes/image-edit.php: wp_restore_image()

Restores the metadata for a given attachment.
wp-admin/includes/image-edit.php: wp_save_image()

Saves image to post along with enqueued changes in $_REQUEST[‘history’]
wp-admin/includes/image-edit.php: wp_image_editor()

Loads the WP image-editing interface.
wp-admin/includes/media.php: edit_form_image_editor()

Displays the image and editor in the post editor
wp-admin/includes/media.php: attachment_submitbox_metadata()

Displays non-editable attachment metadata in the publish meta box.
wp-admin/includes/media.php: get_media_item()

Retrieve HTML form for modifying the image attachment.
wp-admin/includes/post.php: edit_post()

Update an existing post with values provided in $_POST.
wp-admin/includes/ajax-actions.php: wp_ajax_save_attachment()

Ajax handler for updating attachment attributes.
wp-admin/includes/meta-boxes.php: attachment_id3_data_meta_box()

Display fields for ID3 data
wp-admin/includes/class-custom-image-header.php: Custom_Image_Header::step_2()

Display second step of custom header image page.
wp-includes/theme.php: get_uploaded_header_images()

Get the header images uploaded for the current theme.
wp-includes/post-template.php: prepend_attachment()

Wrap attachment in paragraph tag before content.
wp-includes/media.php: wp_maybe_generate_attachment_metadata()

Maybe attempts to generate attachment metadata, if missing.
wp-includes/media.php: 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.
wp-includes/media.php: gallery_shortcode()

Builds the Gallery shortcode output.
wp-includes/media.php: wp_playlist_shortcode()

Builds the Playlist shortcode output.
wp-includes/media.php: wp_get_attachment_image()

Get an HTML img element representing an image attachment
wp-includes/media.php: image_get_intermediate_size()

Retrieves the image’s intermediate size (resized) path, width, and height.
wp-includes/media.php: image_downsize()

Scale an image to fit a particular size (such as ‘thumb’ or ‘medium’).
wp-includes/post.php: wp_delete_attachment()

Trash or delete an attachment.
wp-includes/post.php: wp_get_attachment_thumb_file()

Retrieve thumbnail for an attachment.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_prepare_media_item()

Prepares media item data for return in an XML-RPC object.
Show 28 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    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
    Contributed by Codex —

    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
		)
		[medium] => 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] => 
	)
)

    Expand full source codeCollapse full source code

  2. Skip to note 2 content
    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
    Contributed by Đăng Tú —

    Example for video format:

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

    Expand full source codeCollapse full source code

You must log in before being able to contribute a note or feedback.