wp_get_attachment_metadata() WP 1.0

Retrieve attachment meta field for attachment ID.

Hooks in function

Return

Mixed. Attachment meta field. False on failure.

Usage

wp_get_attachment_metadata( $attachment_id, $unfiltered );

$attachment_id(int)

Attachment post ID.
Default: global $post

$unfiltered(true/false)

If true, filters are not run.
Default: false

Code of wp get attachment metadata: wp-includes/post.php ^{WP 5.2.1}

<?php
function wp_get_attachment_metadata( $attachment_id = 0, $unfiltered = false ) {
	$attachment_id = (int) $attachment_id;
	if ( ! $post = get_post( $attachment_id ) ) {
		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 );
}

Related Functions

From category: Metadata (postmeta)