Controls whether a GD image retains its full alpha-channel information on encoding.
What It Does
GD provides simple pixel-level operations; Imagick provides another image-processing API with distinct requirements. For transparent PNGs, first disable alpha blending before filling with transparent color.
Requirements and Compatibility
GD extension. Sample images and fonts referred to by filename must be supplied locally. Use PHP 8 GdImage objects where applicable; optional decoders depend on the installed build.
Syntax, Inputs and Results
The arguments shown below are concrete values for this function; their types and ranges matter. The example checks return data rather than assuming that every operation succeeds.
Example 1: Basic Use
Call the function with a concrete input and inspect its result.
<?php
if (!extension_loaded('gd')) throw new RuntimeException('GD extension required');
$im = imagecreatetruecolor(160, 110);
$white = imagecolorallocate($im, 255, 255, 255);
imagefilledrectangle($im, 0, 0, 159, 109, $white);
$ok = imagesavealpha($im, true);
var_dump($ok);Example 2: Another Case
Change the inputs to observe the behavior on another case.
<?php
if (!extension_loaded('gd')) throw new RuntimeException('GD extension required');
$im = imagecreatetruecolor(160, 110);
$white = imagecolorallocate($im, 255, 255, 255);
imagefilledrectangle($im, 0, 0, 159, 109, $white);
$ok = imagesavealpha($im, false);
var_dump($ok);
// This example uses a different target color or alpha state.Practical Example
Use the result to create an output, validate a condition, or complete an image workflow.
<?php
if (!extension_loaded('gd')) throw new RuntimeException('GD extension required');
$im = imagecreatetruecolor(160, 110);
$white = imagecolorallocate($im, 255, 255, 255);
imagefilledrectangle($im, 0, 0, 159, 109, $white);
imagealphablending($im, false);
$transparent = imagecolorallocatealpha($im, 0, 0, 0, 127);
imagefilledrectangle($im, 0, 0, 159, 109, $transparent);
imagesavealpha($im, true);
imagepng($im, __DIR__ . "/alpha-saved.png");For production, apply the compatibility and edge-case limits described below.
Important Behavior and Edge Cases
For transparent PNGs, first disable alpha blending before filling with transparent color.
Comparison with Related Functions and Tools
| Subject | Key difference |
|---|---|
| imagesavealpha() | GD provides simple pixel-level operations; Imagick provides another image-processing API with distinct requirements. |
Common Beginner Mistakes
| Mistake | Correct approach |
|---|---|
| Calling imagesavealpha() without its required input or supported extension | Check the extension, supply valid arguments, and handle false or exceptions according to the function. |
| Assuming imagesavealpha() guarantees a valid or safe image | For transparent PNGs, first disable alpha blending before filling with transparent color. |
| Confusing the operation with a related API | GD provides simple pixel-level operations; Imagick provides another image-processing API with distinct requirements. |
Key Takeaways
- Controls whether a GD image retains its full alpha-channel information on encoding.
- For transparent PNGs, first disable alpha blending before filling with transparent color.
- Choose the companion API described in the comparison table when the job differs.
Use these examples as a starting point, then validate the result with the actual PHP build, dependencies and inputs used by your application.