function image_crop

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

Image toolkits
Functions for image file manipulations.
3 calls to image_crop()
image_crop_effect in drupal/core/modules/image/image.effects.inc
Image effect callback; Crop an image resource.
image_scale_and_crop in drupal/core/includes/image.inc
Scales an image to the exact width and height given.
ToolkitTest::testCrop in drupal/core/modules/system/lib/Drupal/system/Tests/Image/ToolkitTest.php
Test the image_crop() function.
1 string reference to 'image_crop'
ImageDimensionsTest::testImageDimensions in drupal/core/modules/image/lib/Drupal/image/Tests/ImageDimensionsTest.php
Test styled image dimensions cumulatively.

File

drupal/core/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,
  ));
}