wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_get_attachment_metadata › WordPress Function

Since2.1.0
Deprecatedn/a
› wp_get_attachment_metadata ( $attachment_id = 0, $unfiltered = false )
Parameters: (2)
  • (int) $attachment_id Attachment post ID. Defaults to global $post.
    Required: No
    Default: —
  • (bool) $unfiltered Optional. If true, filters are not run. Default false.
    Required: No
    Default: false
Returns:
  • (array|false) { Attachment metadata. False on failure. @type int $width The width of the attachment. @type int $height The height of the attachment. @type string $file The file path relative to `wp-content/uploads`. @type array $sizes Keys are size slugs, each value is an array containing 'file', 'width', 'height', and 'mime-type'. @type array $image_meta Image metadata. @type int $filesize File size of the attachment. }
Defined at:
Codex:
Change Log:
  • 6.0.0

Retrieves attachment metadata for attachment ID.



Related Functions: wp_generate_attachment_metadata, wp_update_attachment_metadata, wp_maybe_generate_attachment_metadata, wp_get_attachment_image, wp_get_attachment_caption

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 ( ! $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.
	 */
	return apply_filters( 'wp_get_attachment_metadata', $data, $attachment_id );
}