WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Image_Editor_GD::make_subsize()

WP_Image_Editor_GD::make_subsize( array $size_data ): array|WP_Error

In this article

Back to top

Create an image sub-size and return the image meta data value for it.

Parameters

$size_dataarrayrequired
Array of size data.
  • width int
    The maximum width in pixels.
  • height int
    The maximum height in pixels.
  • crop bool|array
    Whether to crop the image to exact dimensions.

Return

array|WP_Error The image data array for inclusion in the sizes array in the image meta, WP_Error object on error.

Source

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;
}

View all references View on Trac View on GitHub

UsesDescription
WP_Image_Editor_GD::_resize()wp-includes/class-wp-image-editor-gd.php
WP_Image_Editor_GD::_save()wp-includes/class-wp-image-editor-gd.php
is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 2 moreShow less
Used byDescription
WP_Image_Editor_GD::multi_resize()wp-includes/class-wp-image-editor-gd.php

Create multiple smaller images from a single source.

Changelog

VersionDescription
5.3.0Introduced.

User Contributed Notes

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