php8.5
Home/ Manual/ spl / arrayobject/ ArrayObject::getIterator

ArrayObject::getIterator

PHP function Edit on GitHub ✎

(PHP 5, PHP 7, PHP 8)

Create a new iterator from an ArrayObject instance

Description

ArrayObject::getIterator(): Iterator

Create a new Iterator (default is ArrayIterator) from an ArrayObject instance.

Parameters Parameters

Return Values

An iterator from an ArrayObject.

Examples

ArrayObject::getIterator() example

php
<?php

$array = [
    '1' => 'one',
    '2' => 'two',
    '3' => 'three',
];

$arrayobject = new ArrayObject($array);

$iterator = $arrayobject->getIterator();

while ($iterator->valid()) {
    echo $iterator->key() . ' => ' . $iterator->current() . "\n";

    $iterator->next();
}

?>

The above example will output:

output
1 => one
2 => two
3 => three

Source: reference/spl/arrayobject/getiterator.xml · from the official PHP manual (php/doc-en)