Overview
KB
Technical FAQ
PHP Manual
CSS2 Manual
HTML Manual
JS Guide
JS Reference
PhpDock Manual
Nu-Coder Manual
PhpExpress Manual
PHP Joomla
Development
Learn PHP
 
<Imagick::getInterlaceSchemeImagick::getNumberImages>
^ImagickLast updated: Mon, 26 Oct 2026

Imagick::getIteratorIndex

(PECL imagick 2, PECL imagick 3)

Imagick::getIteratorIndex — Gets the index of the current active image

Description

public function Imagick::getIteratorIndex(): int

Returns the index of the current active image within the Imagick object. This method is available if Imagick has been compiled against ImageMagick version 6.2.9 or newer.

Parameters

This function has no parameters.

Return Values

Returns an integer containing the index of the image in the stack.

Errors/Exceptions

Throws ImagickException on error.

Examples

Example #1 Using Imagick::getIteratorIndex():

Create images, set and get the iterator index 

<?php
$im = new Imagick();
$im->newImage(100, 100, new ImagickPixel("red"));
$im->newImage(100, 100, new ImagickPixel("green"));
$im->newImage(100, 100, new ImagickPixel("blue"));

$im->setIteratorIndex(1);
echo $im->getIteratorIndex();
?>

See Also


<Imagick::getInterlaceSchemeImagick::getNumberImages>
^ImagickLast updated: Mon, 26 Oct 2026