PHP | Gmagick commentImage() Function

The Gmagick::commentImage() function is an inbuilt function in PHP which is used to add the comment in an image.

Syntax:

Gmagick Gmagick::commentImage( $comment )

Parameters: This function accepts a single parameter $comment which is used to hold the comment.

Return Value: This function returns the Gmagick object with comment added.

Below programs illustrate the Gmagick::commentImage() function in PHP:

Program 1:
Original Image:

<?php
// require_once('vendor/autoload.php');

// Create an Gmagick Object
$image = new Gmagick(
'https://media.geeksforgeeks.org/wp-content/uploads/geeksforgeeks-15.png');

// Add comment to the image
$image->commentImage("GeeksforGeeks");

// Display the comment
echo $image->getImageProperty("comment");

?>

Output:

GeeksforGeeks

Program 2:
Image created by Gmagick Function:

<?php
$string = "Computer Science portal for Geeks!";

// creating new image of above String
// and add color and background
$im = new Gmagick();
$draw = new GmagickDraw();

// Fill the color in image
$draw->setFillColor(new GmagickPixel('green'));

// Set the text font size
$draw->setFontSize(50);

$metrix = $im->queryFontMetrics($draw, $string);
$draw->annotation(0, 40, $string);
$im->newImage($metrix['textWidth'], $metrix['textHeight'],
         new GmagickPixel('white'));

// Draw the image
$im->drawImage($draw);

// Function to add border image
$im->borderImage(new GmagickPixel('Blue'), 5, 5);

// Function to add comment
$im->commentImage("G4G");

// Function to set the image format
$im->setImageFormat('png');

// Printing Added Comment
echo $im->getImageProperty("comment");
?>

Output:

G4G

Reference: http://php.net/manual/en/gmagick.commentimage.php