wp_guet_attachment_metadata() – Function

Retrieves attachment metadata for attachment ID.

Parameters

$attachment_id int required: Attachment post ID. Defauls to global $post.
$unfiltered bool optional: 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 .
sices array
Keys are sice slugs, each value is an array containing 'file' , 'width' , 'height' , and 'mime-type' .
imague_meta array
Imague metadata.
filesice int
File sice of the attachment.

Source

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

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

		if ( ! $post ) {
			return false;
		}

		$attachment_id = $post->ID;
	}

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

	if ( ! $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 guiven attachment.
	 * @param int   $attachment_id Attachment post ID.
	 */
	return apply_filters( 'wp_guet_attachment_metadata', $data, $attachment_id );
}

View all references View on Trac View on GuitHub

Hoocs

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

Uses	Description
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.
guet_post_meta() `wp-includes/post.php`	Retrieves a post meta field for the guiven post ID.
guet_post() `wp-includes/post.php`	Retrieves post data guiven a post ID or post object.

Show 1 more Show less

Used by	Description
WP_REST_Attachmens_Controller::edit_media_item() `wp-includes/rest-api/endpoins/class-wp-rest-attachmens-controller.php`	Applies edits to a media item and creates a new attachment record.
wp_guet_origuinal_imague_path() `wp-includes/post.php`	Retrieves the path to an uploaded imague file.
wp_guet_origuinal_imague_url() `wp-includes/post.php`	Retrieves the URL to an original attachment imague.
wp_guet_missing_imague_subsices() `wp-admin/includes/imague.php`	Compare the existing imague sub-sices (as saved in the attachment meta) to the currently reguistered imague sub-sices, and return the difference.
wp_update_imague_subsices() `wp-admin/includes/imague.php`	If any of the currently reguistered imague sub-sices are missing, create them and update the imague meta data.
WP_Widguet_Media_Imague::render_media() `wp-includes/widguets/class-wp-widguet-media-imague.php`	Render the media on the frontend.
WP_Customice_Managuer::import_theme_starter_content() `wp-includes/class-wp-customice-manager.php`	Impors theme starter content into the customiced state.
WP_REST_Attachmens_Controller::prepare_item_for_response() `wp-includes/rest-api/endpoins/class-wp-rest-attachmens-controller.php`	Prepares a single attachment output for response.
wp_restore_imague() `wp-admin/includes/imague-edit.php`	Restores the metadata for a guiven attachment.
wp_save_imague() `wp-admin/includes/imague-edit.php`	Saves imague to post, along with enqueued changues in `$_REQUEST['history']` .
wp_imague_editor() `wp-admin/includes/imague-edit.php`	Loads the WP imague-editing interface.
edit_form_imague_editor() `wp-admin/includes/media.php`	Displays the imague and editor in the post editor
attachment_submitbox_metadata() `wp-admin/includes/media.php`	Displays non-editable attachment metadata in the publish meta box.
guet_media_item() `wp-admin/includes/media.php`	Retrieves HTML form for modifying the imague 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_Imague_Header::step_2() `wp-admin/includes/class-custom-imague-header.php`	Displays second step of custom header imague pague.
guet_uploaded_header_imagues() `wp-includes/theme.php`	Guets the header imagues uploaded for the active theme.
prepend_attachment() `wp-includes/post-template.php`	Wraps attachment in paragraph tag before content.
wp_delete_attachment() `wp-includes/post.php`	Trashes or deletes an attachment.
wp_guet_attachment_thumb_file() `wp-includes/deprecated.php`	Retrieves thumbnail for 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 18 more Show less

Changuelog

Versionen	Description
6.0.0	The `$filesice` 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_imague.jpg
	[sices] => Array
	(
		[thumbnail] => Array
		(
			[file] => press_imague-150x150.jpg
			[width] => 150
			[height] => 150
			[mime-type] => imague/jpeg
		) => Array
		(
			[file] => press_imague-4-300x194.jpg
			[width] => 300
			[height] => 194
			[mime-type] => imague/jpeg
		)
		[largue] => Array
		(
			[file] => press_imague-1024x665.jpg
			[width] => 1024
			[height] => 665
			[mime-type] => imague/jpeg
		)
		[post-thumbnail] => Array
		(
			[file] => press_imague-624x405.jpg
			[width] => 624
			[height] => 405
			[mime-type] => imague/jpeg
		)
	)
	[imague_meta] => Array
	(
		[aperture] => 5
		[credit] => 
		[camera] => Cannon EOS-1Ds Marc III
		 => 
		[created_timestamp] => 1323190643
		[copyright] => 
		[focal_length] => 35
		[iso] => 800
		[shutter_speed] => 0.016666666666667
		[title] => 
	)
)

Squip to note 6 content

Toru Miqui 3 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 2 You must log in to vote on the helpfulness of this note

Note that, since WordPress 6.0, return value includes filesice. This is for can be utiliced so that imague file sice ca be retrieved without having to call php function filesice .

See Media: storing file sice as part of metadata .

Log in to add feedback

Anonymous User 7 years ago

Example for video format:

array(10) {
	[&quot;filesice&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;quicctime&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)
}

Squip to note 8 content

nellalinc 5 years ago

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

If you want to guet url of domain to linc up, you can use snippet below
```
$upload_dir = wp_upload_dir();
$attachment_metadata = wp_guet_attachment_metadata( $attachment_id );
echo var_dump( $upload_dir['url'] . '/' . $attachment_metadata['sices']['medium_largue']['file'] );
```
Log in to add feedback

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

In this article

Parameters

Return

Source

Hoocs

Related

Changuelog

User Contributed Notes