wp_generate_attachment_metadata( int $attachment_id, string $file ): array

Parameters

$attachment_idint

Attachment ID to process.

$filestring

Filepath of the attached image.

Return

array

Metadata for attachment.

Hooks fired · 3

3 hooks fire while wp_generate_attachment_metadata() runs, in this order:

1. 1
   apply_filters( attachment_thumbnail_args )filterline 674 (+81 into the body)

   Filters the parameters for the attachment thumbnail creation.

2. 2
   apply_filters( fallback_intermediate_image_sizes )filterline 700 (+107 into the body)

   Filters the image sizes generated for non-image mime types.

3. 3
   apply_filters( wp_generate_attachment_metadata )filterline 764 (+171 into the body)

   Filters the generated attachment meta data.

Uses · 24

• get_post()Retrieves post data given a post ID or post object.
• get_post_mime_type()Retrieves the mime type of an attachment based on the ID.
• file_is_displayable_image()Validates that file is suitable for displaying within a web page.
• wp_create_image_subsizes()Creates image sub-sizes, adds the new data to the image meta `sizes` array, and updates the image metadata.
• wp_attachment_is()Verifies an attachment is of a given type.
• wp_read_video_metadata()Retrieves metadata from a video file's ID3 tags.
• current_theme_supports()Checks a theme's support for a given feature.
• post_type_supports()Checks a post type's support for a given feature.
• wp_read_audio_metadata()Retrieves metadata from an audio file's ID3 tags.
• get_posts()Retrieves an array of the latest posts, or posts matching the given criteria.
• update_post_meta()Updates a post meta field based on the given post ID.
• wp_basename()i18n-friendly version of basename().

Used by · 13

• Custom_Background::handle_upload()Handles an Image upload for the background image.
• Custom_Image_Header::insert_attachment()Inserts an attachment and its metadata.
• Custom_Image_Header::step_2()Displays second step of custom header image page.
• WP_Customize_Manager::import_theme_starter_content()Imports theme starter content into the customized state.
• WP_REST_Attachments_Controller::create_item()Creates a single attachment.
• WP_REST_Attachments_Controller::edit_media_item()Applies edits to a media item and creates a new attachment record.
• WP_Site_Icon::insert_attachment()Inserts an attachment.
• media_handle_sideload()Handles a side-loaded file in the same way as an uploaded file is handled by media_handle_upload().
• media_handle_upload()Saves a file submitted from a POST request and create an attachment post for it.
• wp_ajax_crop_image()Handles cropping an image via AJAX.
• wp_generate_attachment_metadata()Generates attachment meta data and create image sub-sizes for images.
• wp_maybe_generate_attachment_metadata()Maybe attempts to generate attachment metadata, if missing.

Source

View on Trac ↗View on GitHub ↗

593function wp_generate_attachment_metadata( $attachment_id, $file ) {594	$attachment = get_post( $attachment_id );595 596	$metadata  = array();597	$support   = false;598	$mime_type = get_post_mime_type( $attachment );599 600	if ( 'image/heic' === $mime_type || ( preg_match( '!^image/!', $mime_type ) && file_is_displayable_image( $file ) ) ) {601		// Make thumbnails and other intermediate sizes.602		$metadata = wp_create_image_subsizes( $file, $attachment_id );603	} elseif ( wp_attachment_is( 'video', $attachment ) ) {604		$metadata = wp_read_video_metadata( $file );605		$support  = current_theme_supports( 'post-thumbnails', 'attachment:video' ) || post_type_supports( 'attachment:video', 'thumbnail' );606	} elseif ( wp_attachment_is( 'audio', $attachment ) ) {607		$metadata = wp_read_audio_metadata( $file );608		$support  = current_theme_supports( 'post-thumbnails', 'attachment:audio' ) || post_type_supports( 'attachment:audio', 'thumbnail' );609	}610 611	/*612	 * wp_read_video_metadata() and wp_read_audio_metadata() return `false`613	 * if the attachment does not exist in the local filesystem,614	 * so make sure to convert the value to an array.615	 */616	if ( ! is_array( $metadata ) ) {617		$metadata = array();618	}619 620	if ( $support && ! empty( $metadata['image']['data'] ) ) {621		// Check for existing cover.622		$hash   = md5( $metadata['image']['data'] );623		$posts  = get_posts(624			array(625				'fields'         => 'ids',626				'post_type'      => 'attachment',627				'post_mime_type' => $metadata['image']['mime'],628				'post_status'    => 'inherit',629				'posts_per_page' => 1,630				'meta_key'       => '_cover_hash',631				'meta_value'     => $hash,632			)633		);634		$exists = reset( $posts );635 636		if ( ! empty( $exists ) ) {637			update_post_meta( $attachment_id, '_thumbnail_id', $exists );638		} else {639			$ext = '.jpg';640			switch ( $metadata['image']['mime'] ) {641				case 'image/gif':642					$ext = '.gif';643					break;644				case 'image/png':645					$ext = '.png';646					break;647				case 'image/webp':648					$ext = '.webp';649					break;650			}651			$basename = str_replace( '.', '-', wp_basename( $file ) ) . '-image' . $ext;652			$uploaded = wp_upload_bits( $basename, '', $metadata['image']['data'] );653			if ( false === $uploaded['error'] ) {654				$image_attachment = array(655					'post_mime_type' => $metadata['image']['mime'],656					'post_type'      => 'attachment',657					'post_content'   => '',658				);659				/**660				 * Filters the parameters for the attachment thumbnail creation.661				 *662				 * @since 3.9.0663				 *664				 * @param array $image_attachment An array of parameters to create the thumbnail.665				 * @param array $metadata         Current attachment metadata.666				 * @param array $uploaded         {667				 *     Information about the newly-uploaded file.668				 *669				 *     @type string $file  Filename of the newly-uploaded file.670				 *     @type string $url   URL of the uploaded file.671				 *     @type string $type  File type.672				 * }

History

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-admin/includes/image.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.