imagecrop

Crop an image to the given rectangle

&reftitle.description; ``GdImage``false```imagecrop` `GdImage` `image` `array` `rectangle`

Crops an image to the given rectangular area and returns the resulting image. The given `image` is not modified.

&reftitle.parameters;
&gd.image.description;

`rectangle`

- The cropping rectangle as `array` with keys `x`, `y`, `width` and `height`.

&reftitle.returnvalues;

Return cropped image object on success&return.falseforfailure;.

&reftitle.changelog;

&Version; | &Description;
&gd.changelog.image-param;
8.0.0 | On success, this function returns a `GDImage` instance now; previously, a `resource` was returned.

&reftitle.examples;

### `imagecrop` example

This example shows how to crop an image to a square area.

    <?php
    $im = imagecreatefrompng('example.png');
    $size = min(imagesx($im), imagesy($im));
    $im2 = imagecrop($im, ['x' => 0, 'y' => 0, 'width' => $size, 'height' => $size]);
    if ($im2 !== FALSE) {
        imagepng($im2, 'example-cropped.png');
        imagedestroy($im2);
    }
    imagedestroy($im);
    ?>

&reftitle.seealso;

- `imagecropauto`