GetIterator

:::info[Note] This is a point-in-time snapshot of the API documentation from January 2026. Going forward, we will not be maintaining a public copy of these references, and recommend users to refer to the built-in signature helpers available in the Hack LSP instead for complete and up-to-date information. :::

Returns an iterator that points to beginning of the current Set

public function getIterator(): KeyedIterator<arraykey, Tv>;

Returns

• KeyedIterator<arraykey,Tv> - A KeyedIterator that allows you to traverse the current Set.

Examples

This example shows how to get an iterator from a Set and how to consume it:

$s = Set {'red', 'green', 'blue', 'yellow'};

// Get an iterator for the Set of colors
$iterator = $s->getIterator();

// Print each color using the iterator
while ($iterator->valid()) {
  echo $iterator->current()."\n";
  $iterator->next();
}