JavaScript Editor Javascript debugger     Website design 

Imagick::commentImage

Adds a comment to your image ()
bool Imagick::commentImage ( string comment )

Warning:

This function is currently not documented; only the argument list is available.

Warning:

This function is EXPERIMENTAL. The behaviour of this function, the name of this function, and anything else documented about this function may change without notice in a future release of PHP. Use this function at your own risk.

Adds a comment to your image.

Parameters

comment

The comment to add

Return Values

Returns TRUE on success.

Examples

Example 1037. Using Imagick::commentImage():

Commenting an image and retrieving the comment:

<?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");

?>