imagecrop

(PHP 5 >= 5.5.0, PHP 7, PHP 8)

imagecrop — Crop an image to the given rectangle

Description

imagecrop(GdImage $image, array $rectangle): GdImage|false

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

Parameters

image: A GdImage object, returned by one of the image creation functions, such as imagecreatetruecolor().
rectangle: The cropping rectangle as array with keys x, y, width and height.

Return Values

Return cropped image object on success or false on failure.

Changelog

Version	Description
8.0.0	`image` expects a GdImage instance now; previously, a valid `gd` resource was expected.
8.0.0	On success, this function returns a GDImage instance now; previously, a resource was returned.

Examples

Example #1 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');
}
?>