Generator::key

(PHP 5 >= 5.5.0, PHP 7, PHP 8)

Generator::key — Get the yielded key

public function Generator::key(): mixed

Gets the key of the yielded value.

This function has no parameters.

Returns the yielded key.

Example #1 Generator::key() example

<?php

function Gen()
{
    yield 'key' => 'value';
}

$gen = Gen();

echo "{$gen->key()} => {$gen->current()}";

The above example will output:

key => value