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

3 calls to image_crop()

ImageToolkitUnitTest::testCrop in modules/simpletest/tests/image.test

Test the image_crop() function.

image_crop_effect in modules/image/image.effects.inc

Image effect callback; Crop an image resource.

image_scale_and_crop in includes/image.inc

Scales an image to the exact width and height given.

1 string reference to 'image_crop'

ImageDimensionsTestCase::testImageDimensions in modules/image/image.test

Test styled image dimensions cumulatively.

File

includes/image.inc, line 331

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

---