php8.5
Home/ Manual/ imagick / imagick/ Imagick::commentImage

Imagick::commentImage

PHP function Edit on GitHub ✎

(PECL imagick 2, PECL imagick 3)

Adds a comment to your image

Description

Imagick::commentImage(string $comment): bool

Adds a comment to your image.

Parameters

comment

The comment to add

Return Values

Success

Errors/Exceptions

Throws

Examples

Using Imagick::commentImage():

Commenting an image and retrieving the comment:

php
<?php

/* Create new Imagick object */
$im = new imagick();

/* Create an empty image */
$im->newImage(100, 100, new ImagickPixel("red"));

/* Add comment to the image */
$im->commentImage("Hello World!");

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

?>

Source: reference/imagick/imagick/commentimage.xml · from the official PHP manual (php/doc-en)