imagexbm

Function • Params and return types changed in PHP 8.0

Output an XBM image to browser or file.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

imagexbm Function synopsis

imagexbm(
    GdImage $image,
    ?string $filename,
    ?int $foreground_color = null
  ): bool

Parameters

$image

TypeGdImage

$filename

Type?string

The path to save the file to, given as string. If null, the raw image stream will be output directly.

$foreground_color

OptionalType?intDefault valuenull

You can set the foreground color with this parameter by setting an identifier obtained from imagecolorallocate. The default foreground color is black. All other colors are treated as background.

Return value

Typebool

Returns true on success, false on failure

Changes to the imagexbm Function

PHP 8.0

  • Return type added: bool
  • Parameter name of parameter #1 changed: $im to $image
  • Parameter type added for parameter #1 ($image): GdImage
  • Parameter type added for parameter #2 ($filename): ?string
  • Parameter name of parameter #3 changed: $foreground to $foreground_color
  • Parameter type added for parameter #3 ($foreground_color): ?int
  • Parameter default value added for position #3 ($foreground_color): null
  imagexbm(
-     $im,
+     GdImage $image,
-     $filename,
+     ?string $filename,
-     $foreground
+     ?int $foreground_color = null
-   )
+   ): bool

imagexbm 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 Yes
PHP 5.3Unsupported Yes