add_image_size( string $name, int $width, int $height, bool|array $crop = false )

Register a new image size.


Description Description


Parameters Parameters

$name

(string) (Required) Image size identifier.

$width

(int) (Optional) Image width in pixels. Default 0.

$height

(int) (Optional) Image height in pixels. Default 0.

$crop

(bool|array) (Optional) Image cropping behavior. If false, the image will be scaled (default), If true, image will be cropped to the specified dimensions using center positions. If an array, the image will be cropped using the array to specify the crop location. Array values must be in the format: array( x_crop_position, y_crop_position ) where: - x_crop_position accepts: 'left', 'center', or 'right'. - y_crop_position accepts: 'top', 'center', or 'bottom'.

Default value: false


Top ↑

Source 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,
	);
}

Top ↑

Changelog Changelog

Changelog
Version Description
2.9.0 Introduced.

Top ↑

More Information More Information

Top ↑

Reserved Image Size Names Reserved Image Size Names

‘thumb’, ‘thumbnail’, ‘medium’, ‘large’, ‘post-thumbnail’

The names “thumb” & “thumbnail” are just aliases- they are exactly the same.

For a detailed explanation and “why”, read further inside the image_downsize() article.

However, if needed, you can always set the options yourself:

update_option( 'thumbnail_size_w', 160 );
update_option( 'thumbnail_size_h', 160 );
update_option( 'thumbnail_crop', 1 );

Top ↑

Crop Mode Crop Mode

Set the image size by resizing the image proportionally (without distorting it):

add_image_size( 'custom-size', 220, 180 ); // 220 pixels wide by 180 pixels tall, soft proportional crop mode

Set the image size by cropping the image (not showing part of it):

add_image_size( 'custom-size', 220, 180, true ); // 220 pixels wide by 180 pixels tall, hard crop mode

Set the image size by cropping the image and defining a crop position:

add_image_size( 'custom-size', 220, 220, array( 'left', 'top' ) ); // Hard crop left top

When setting a crop position, the first value in the array is the x axis crop position, the second is the y axis crop position.

  • x_crop_position accepts ‘left’ ‘center’, or ‘right’.
  • y_crop_position accepts ‘top’, ‘center’, or ‘bottom’.

By default, these values default to ‘center’ when using hard crop mode.

You can find examples of the various crop types here.


Top ↑

Using the New Image Sizes Using the New Image Sizes

Now that you’ve defined some custom image sizes, there are a variety of ways that you can use them.
For Featured Images

To use your custom image sizes for a post’s featured image, you can use the_post_thumbnail() in the appropriate theme template file…

Note: To enable featured images the current theme must include add_theme_support( ‘post-thumbnails’ ); in its functions.php file. See also Post Thumbnails.

if ( has_post_thumbnail() ) { 
	the_post_thumbnail( 'your-custom-size' ); 
}

Top ↑

For Media Library Images (Admin) For Media Library Images (Admin)

You can also make your custom sizes selectable from your WordPress admin. To do so, you have to use the image_size_names_choose hook to assign them a normal, human-readable name…

add_filter( 'image_size_names_choose', 'my_custom_sizes' );

function my_custom_sizes( $sizes ) {
    return array_merge( $sizes, array(
        'your-custom-size' => __( 'Your Custom Size Name' ),
    ) );
}

Top ↑

For General Media (PHP/Templates) For General Media (PHP/Templates)

You can output images (by size) directly from the WordPress Media Library using PHP as well. To do this, simply use wp_get_attachment_image().

// Assuming your Media Library image has a post id of 42...
echo wp_get_attachment_image( 42, 'your-custom-size' );

Note: If you just want the image URL instead of a pre-built tag, you can use wp_get_attachment_image_src() instead.


Top ↑

Other Notes: Other Notes:

Using the ‘false’ setting will fail to produce a new image in the upload directory if one of the image dimensions of the uploaded image are equal to the new image size.

If a registered image size is removed from functions.php, then any image uploaded before that point and then deleted from the media library afterwards, does not have those auto-generated sizes deleted too. Only image sizes that exist in functions.php are deleted.

Although height and width are not required parameters, their default values (0) will lead to unwanted behavior, so bear in mind that you should always define them. As mentioned before, use a value of 9999 to define the other dimension as the one to be considered when image resize is executed.



Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by Codex

    In a theme’s functions.php file. Always use the “after_setup_theme” action hook.

    add_action( 'after_setup_theme', 'wpdocs_theme_setup' );
    function wpdocs_theme_setup() {
    	add_image_size( 'category-thumb', 300 ); // 300 pixels wide (and unlimited height)
    	add_image_size( 'homepage-thumb', 220, 180, true ); // (cropped)
    }
    
  2. Skip to note 3 content
    Contributed by rtpHarry

    The section “Reserved Image Size Names” hints at it but doesn’t explicitly point out that you can also customise the medium and large sizes via code by using these option names:

    medium_size_h: The medium size height.
    medium_size_w: The medium size width.
    large_size_h: The large size height.
    large_size_w: The large size width.

    So for example, to set the large height to 700px you would use this code:

       update_option( 'large_size_h', 700 );
    
  3. Skip to note 6 content
    Contributed by pixeline

    Note that along thumbnail, medium, large, there is also a size built into wordpress that you can use : full to get the image at its original dimensions.

  4. Skip to note 7 content
    Contributed by hongpong

    If you upload an image whose dimensions match the add_image_size() when crop is set to true, in the $meta object accessed by the wp_generate_attachment_metadata filter, that matching image size will not be available. Also, image sizes that have larger dimensions than an uploaded photo will not be available either.

    (Thus if you are using a technique to create something like a monochrome derivative image, you won’t be able to get it to work if the uploaded image is exactly the same size as the image size you’re using for your black and white version).

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