Uses
Uses | Description |
---|---|
wp-includes/functions.php: absint() | Convert a value to non-negative integer. |
Register a new image size.
(string) (Required) Image size identifier.
(int) (Optional) Image width in pixels. Default 0.
(int) (Optional) Image height in pixels. Default 0.
(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:
Default value: false
‘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 );
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.
By default, these values default to ‘center’ when using hard crop mode.
You can find examples of the various crop types here.
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' ); }
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' ), ) ); }
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.
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.
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, ); }
Version | Description |
---|---|
2.9.0 | Introduced. |
© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_image_size