wp_get_attachment_image_sizes( int $attachment_id, string|int[] $size = ‘medium’, array $image_meta = null ): string|false

Retrieves the value for an image attachment’s ‘sizes’ attribute.

Description

See also

Parameters

$attachment_idintrequired
Image attachment ID.
$sizestring|int[]optional
Image size. Accepts any registered image size name, or an array of width and height values in pixels (in that order). Default 'medium'.

Default:'medium'

$image_metaarrayoptional
The image meta data as returned by ‘wp_get_attachment_metadata() ‘.

Default:null

Return

string|false A valid source size value for use in a 'sizes' attribute or false.

Source

function wp_get_attachment_image_sizes( $attachment_id, $size = 'medium', $image_meta = null ) {
	$image = wp_get_attachment_image_src( $attachment_id, $size );

	if ( ! $image ) {
		return false;
	}

	if ( ! is_array( $image_meta ) ) {
		$image_meta = wp_get_attachment_metadata( $attachment_id );
	}

	$image_src  = $image[0];
	$size_array = array(
		absint( $image[1] ),
		absint( $image[2] ),
	);

	return wp_calculate_image_sizes( $size_array, $image_src, $image_meta, $attachment_id );
}

Changelog

VersionDescription
4.4.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.