Copies a rectangular region from one GD image onto another.
What It Does
imagecopy() does not resize; imagecopyresampled() performs smooth resampling. Source and destination rectangles must be chosen carefully; it does not resize.
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);
$src = imagecreatetruecolor(40, 40);
imagefilledrectangle($src, 0, 0, 39, 39, imagecolorallocate($src, 200, 65, 60));
imageline($src, 0, 0, 39, 39, imagecolorallocate($src, 255, 255, 255));
$ok = imagecopy($im, $src, 10, 10, 0, 0, 45, 45);
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);
$src = imagecreatetruecolor(40, 40);
imagefilledrectangle($src, 0, 0, 39, 39, imagecolorallocate($src, 200, 65, 60));
imageline($src, 0, 0, 39, 39, imagecolorallocate($src, 255, 255, 255));
$ok = imagecopy($im, $src, 60, 20, 8, 8, 30, 30);
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);
$src = imagecreatetruecolor(40, 40);
imagefilledrectangle($src, 0, 0, 39, 39, imagecolorallocate($src, 200, 65, 60));
imageline($src, 0, 0, 39, 39, imagecolorallocate($src, 255, 255, 255));
imagecopy($im, $src, 60, 20, 8, 8, 30, 30);
if (!imagepng($im, __DIR__ . "/imagecopy-demo.png")) throw new RuntimeException("Unable to save");For production, apply the compatibility and edge-case limits described below.
Important Behavior and Edge Cases
Source and destination rectangles must be chosen carefully; it does not resize.
Comparison with Related Functions and Tools
| Subject | Key difference |
|---|---|
| imagecopy() | imagecopy() does not resize; imagecopyresampled() performs smooth resampling. |
Common Beginner Mistakes
| Mistake | Correct approach |
|---|---|
| Calling imagecopy() without its required input or supported extension | Check the extension, supply valid arguments, and handle false or exceptions according to the function. |
| Assuming imagecopy() guarantees a valid or safe image | Source and destination rectangles must be chosen carefully; it does not resize. |
| Confusing the operation with a related API | imagecopy() does not resize; imagecopyresampled() performs smooth resampling. |
Key Takeaways
- Copies a rectangular region from one GD image onto another.
- Source and destination rectangles must be chosen carefully; it does not resize.
- 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.