PHP | Imagick previousImage() Function

The Imagick::previousImage() function is an inbuilt function in PHP which is used to move to the previous image within the Imagick instance. An Imagick instance may consist of a list of images within it and Imagick previousImage() moves the pointer/cursor to the previous image in the image list within an Imagick instance.

Syntax:

bool Imagick::previousImage( void )

Parameters: This function doesn’t accepts any parameter.

Return Value: This function returns TRUE on success.

Exceptions: This function throws ImagickException on error.

Below given programs illustrate the Imagick::previousImage() function in PHP:

Program 1:

<?php

// Create a new imagick object
$imagick = new Imagick(
'https://media.geeksforgeeks.org/wp-content/uploads/geeksforgeeks-13.png');

// Add a image to the imagick object.
$imagick->addImage(new Imagick(
'https://media.geeksforgeeks.org/wp-content/uploads/20190918234528/colorize1.png'));

// Get the index
$index1 = $imagick->getIteratorIndex();
echo 'Before: ' . $index1 . '<br>';

// Move the cursor to first image
$imagick->previousImage();
$imagick->previousImage();

// Get the index
$index2 = $imagick->getIteratorIndex();
echo 'After: ' . $index2 . '<br>';
?>

Output:

Before: 1
After: 0

Program 2:

<?php

// Create a new imagick object
$imagick = new Imagick(
'https://media.geeksforgeeks.org/wp-content/uploads/20190918234528/colorize1.png');

// Add a image to the imagick object.
$imagick->addImage(new Imagick(
'https://media.geeksforgeeks.org/wp-content/uploads/geeksforgeeks-13.png'));

// Move the cursor to first image
$imagick->previousImage();
$imagick->previousImage();

// Display the image
header("Content-Type: image/png");
echo $imagick->getImageBlob();
?>

Output:

Reference: https://www.php.net/manual/en/imagick.previousimage.php