image_scale

Versions
4.6 – 6: image_scale($source, $destination, $width, $height)
7: image_scale(stdClass $image, $width = NULL, $height = NULL, $upscale = FALSE)

Scales an image to the given width and height while maintaining aspect ratio.

The resulting image can be smaller for one or both target dimensions.

Parameters

$source The file path of the source image.

$destination The file path of the destination image.

$width The target width, in pixels.

$height The target height, in pixels.

Return value

TRUE or FALSE, based on success.

▸ 1 function calls image_scale()

▾ 1 function calls image_scale()

file_validate_image_resolution in includes/file.inc: If the file is an image verify that its dimensions are within the specified maximum and minimum dimensions. Non-image files will be ignored.

Code

includes/image.inc, line 186

<?php
function image_scale($source, $destination, $width, $height) {
  $info = image_get_info($source);

  // Don't scale up.
  if ($width >= $info['width'] && $height >= $info['height']) {
    return FALSE;
  }

  $aspect = $info['height'] / $info['width'];
  if ($aspect < $height / $width) {
    $width = (int)min($width, $info['width']);
    $height = (int)round($width * $aspect);
  }
  else {
    $height = (int)min($height, $info['height']);
    $width = (int)round($height / $aspect);
  }

  return image_toolkit_invoke('resize', array($source, $destination, $width, $height));
}
?>