imagecropauto

Function • Params and return types changed in PHP 8.0

Crop an image automatically using one of the available modes.

PHP 5.3-5.4
PHP 5.5
Added
PHP 5.6
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

imagecropauto Function synopsis

imagecropauto(
    GdImage $image,
    int $mode = IMG_CROP_DEFAULT,
    float $threshold = 0.5,
    int $color = -1
  ): GdImage|false

Parameters

$image

TypeGdImage

$mode

OptionalTypeintDefault valueIMG_CROP_DEFAULT

One of the following constants:

$mode accepts one of the following constant values:

$threshold

OptionalTypefloatDefault value0.5

Specifies the tolerance in percent to be used while comparing the image color and the color to crop. The method used to calculate the color difference is based on the color distance in the RGB(a) cube.

$color

OptionalTypeintDefault value-1

Either an RGB color value or a palette index.

Return value

TypeGdImage|false

Returns a cropped image object on success or false on failure. false is also returned if the whole image was cropped.

Changes to the imagecropauto Function

PHP 8.0

  • Return type added: GdImage|false
  • Parameter name of parameter #1 changed: $im to $image
  • Parameter type added for parameter #1 ($image): GdImage
  • Parameter type added for parameter #2 ($mode): int
  • Parameter default value added for position #2 ($mode): IMG_CROP_DEFAULT
  • Parameter type added for parameter #3 ($threshold): float
  • Parameter default value added for position #3 ($threshold): 0.5
  • Parameter type added for parameter #4 ($color): int
  • Parameter default value added for position #4 ($color): -1
  imagecropauto(
-     $im,
+     GdImage $image,
-     $mode,
+     int $mode = IMG_CROP_DEFAULT,
-     $threshold,
+     float $threshold = 0.5,
-     $color
+     int $color = -1
-   )
+   ): GdImage|false

PHP 5.5

  • Function added

imagecropauto Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported No
PHP 5.3Unsupported No