A WordPress-centric search engine for devs and theme authors



wp_get_attachment_metadata ›

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:
  • (mixed) Attachment meta field. False on failure.
Defined at:
Codex:

Retrieve attachment meta field 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;

	$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 );
}