image_crop

function image_crop

image_crop(stdClass $image, $x, $y, $width, $height)

Crops an image to a rectangle specified by the given dimensions.

Parameters

$image: An image object returned by image_load().

$x: The top left coordinate, in pixels, of the crop area (x axis value).

$y: The top left coordinate, in pixels, of the crop area (y axis value).

$width: The target width, in pixels.

$height: The target height, in pixels.

Return value

TRUE on success, FALSE on failure.

See also

image_load()

image_scale_and_crop()

image_gd_crop()

Related topics

File

includes/image.inc, line 331

API for manipulating images.

Code

function image_crop(stdClass $image, $x, $y, $width, $height) {
  $aspect = $image->info['height'] / $image->info['width'];
  if (empty($height)) {
    $height = $width / $aspect;
  }
  if (empty($width)) {
    $width = $height * $aspect;
  }

  $width = (int) round($width);
  $height = (int) round($height);

  return image_toolkit_invoke('crop', $image, array($x, $y, $width, $height));
}