WP_Image_Editor_GD::make_subsize() WordPress Method
The WP_Image_Editor_GD::make_subsize() function is used to create a new image with a given width and height. This function is useful for creating thumbnails or other smaller versions of an image. This function can be used with either the GD library or the Imagick library.
WP_Image_Editor_GD::make_subsize( array $size_data ) #
Create an image sub-size and return the image meta data value for it.
Parameters
- $size_data
(array)(Required)Array of size data.
- 'width'
(int) The maximum width in pixels. - 'height'
(int) The maximum height in pixels. - 'crop'
(bool) Whether to crop the image to exact dimensions.
- 'width'
Return
(array|WP_Error) The image data array for inclusion in the sizes
array in the image meta, WP_Error object on error.
Source
File: wp-includes/class-wp-image-editor-gd.php
public function make_subsize( $size_data ) { if ( ! isset( $size_data['width'] ) && ! isset( $size_data['height'] ) ) { return new WP_Error( 'image_subsize_create_error', __( 'Cannot resize the image. Both width and height are not set.' ) ); } $orig_size = $this->size; if ( ! isset( $size_data['width'] ) ) { $size_data['width'] = null; } if ( ! isset( $size_data['height'] ) ) { $size_data['height'] = null; } if ( ! isset( $size_data['crop'] ) ) { $size_data['crop'] = false; } $resized = $this->_resize( $size_data['width'], $size_data['height'], $size_data['crop'] ); if ( is_wp_error( $resized ) ) { $saved = $resized; } else { $saved = $this->_save( $resized ); imagedestroy( $resized ); } $this->size = $orig_size; if ( ! is_wp_error( $saved ) ) { unset( $saved['path'] ); } return $saved; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.3.0 | Introduced. |