Summery Summery
Creates a ‘sizes’ attribute value for an image.
Syntax Syntax
Parameters Parameters
- $size
-
(Required) Image size to retrieve. Accepts any valid image size, or an array of width and height values in pixels (in that order). Default 'medium'.
- $image_src
-
(Optional) The URL to the image file.
Default value: null
- $image_meta
-
(Optional) The image meta data as returned by 'wp_get_attachment_metadata()'.
Default value: null
- $attachment_id
-
(Optional) Image attachment ID. Either
$image_meta
or$attachment_id
is needed when using the image size name as argument for$size
. Default 0.
Return Return
(string|bool) A valid source size value for use in a 'sizes' attribute or false.
Source Source
File: wp-includes/media.php
} $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 ); } /** * Creates a 'sizes' attribute value for an image. * * @since 4.4.0 * * @param array|string $size Image size to retrieve. Accepts any valid image size, or an array * of width and height values in pixels (in that order). Default 'medium'. * @param string $image_src Optional. The URL to the image file. Default null. * @param array $image_meta Optional. The image meta data as returned by 'wp_get_attachment_metadata()'. * Default null. * @param int $attachment_id Optional. Image attachment ID. Either `$image_meta` or `$attachment_id` * is needed when using the image size name as argument for `$size`. Default 0. * @return string|bool A valid source size value for use in a 'sizes' attribute or false. */ function wp_calculate_image_sizes( $size, $image_src = null, $image_meta = null, $attachment_id = 0 ) { $width = 0; if ( is_array( $size ) ) { $width = absint( $size[0] ); } elseif ( is_string( $size ) ) { if ( ! $image_meta && $attachment_id ) { $image_meta = wp_get_attachment_metadata( $attachment_id ); } if ( is_array( $image_meta ) ) { $size_array = _wp_get_image_size_from_meta( $size, $image_meta ); if ( $size_array ) { $width = absint( $size_array[0] );
Advertisement
Changelog Changelog
Version | Description |
---|---|
4.4.0 | Introduced. |