Draws an outlined polygon by connecting its vertices.
What It Does
GD provides simple pixel-level operations; Imagick provides another image-processing API with distinct requirements. Use the modern three-argument signature; do not pass deprecated num_points.
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);
$blue = imagecolorallocate($im, 34, 92, 166);
$ok = imagepolygon($im, [10, 10, 100, 10, 60, 80], $blue);
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);
$red = imagecolorallocate($im, 200, 65, 60);
$ok = imagepolygon($im, [20, 20, 110, 20, 110, 70, 20, 70], $red);
var_dump($ok);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);
$red = imagecolorallocate($im, 200, 65, 60);
imagepolygon($im, [20, 20, 110, 20, 110, 70, 20, 70], $red);
if (!imagepng($im, __DIR__ . "/imagepolygon-demo.png")) throw new RuntimeException("Unable to save");For production, apply the compatibility and edge-case limits described below.
Important Behavior and Edge Cases
Use the modern three-argument signature; do not pass deprecated num_points.
Comparison with Related Functions and Tools
| Subject | Key difference |
|---|---|
| imagepolygon() | GD provides simple pixel-level operations; Imagick provides another image-processing API with distinct requirements. |
Common Beginner Mistakes
| Mistake | Correct approach |
|---|---|
| Calling imagepolygon() without its required input or supported extension | Check the extension, supply valid arguments, and handle false or exceptions according to the function. |
| Assuming imagepolygon() guarantees a valid or safe image | Use the modern three-argument signature; do not pass deprecated num_points. |
| Confusing the operation with a related API | GD provides simple pixel-level operations; Imagick provides another image-processing API with distinct requirements. |
Key Takeaways
- Draws an outlined polygon by connecting its vertices.
- Use the modern three-argument signature; do not pass deprecated num_points.
- 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.