add_image_size( string $name, int $width, int $height, bool|array $crop = false )
Register a new image size.
Description
Cropping behavior for the image size is dependent on the value of $crop:
- If false (default), images will be scaled, not cropped.
- If an array in the form of array( x_crop_position, y_crop_position ):
- x_crop_position accepts ‘left’ ‘center’, or ‘right’.
- y_crop_position accepts ‘top’, ‘center’, or ‘bottom’. Images will be cropped to the specified dimensions within the defined crop area.
- If true, images will be cropped to the specified dimensions using center positions.
Parameters
- $name
-
(Required) Image size identifier.
- $width
-
(Required) Image width in pixels.
- $height
-
(Required) Image height in pixels.
- $crop
-
(Optional) Whether to crop images to specified width and height or resize. An array can specify positioning of the crop area.
Default value: false
Source
File: wp-includes/media.php
function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
global $_wp_additional_image_sizes;
$_wp_additional_image_sizes[ $name ] = array(
'width' => absint( $width ),
'height' => absint( $height ),
'crop' => $crop,
);
}
Changelog
| Version | Description |
|---|---|
| WP-2.9.0 | Introduced. |