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:

  1. If false (default), images will be scaled, not cropped.
  2. 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.
  3. If true, images will be cropped to the specified dimensions using center positions.

Parameters

$name

(string) (Required) Image size identifier.

$width

(int) (Required) Image width in pixels.

$height

(int) (Required) Image height in pixels.

$crop

(bool|array) (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,
	);
}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/functions.php: absint()

Convert a value to non-negative integer.

Used By

Used By
Used By Description
wp-includes/media.php: set_post_thumbnail_size()

Registers an image size for the post thumbnail.

Changelog

Changelog
Version Description
WP-2.9.0 Introduced.