W3cubDocs

/PHP

Iterator::key

(PHP 5, PHP 7, PHP 8)

Iterator::keyReturn the key of the current element

Description

abstract public Iterator::key ( ) : scalar

Returns the key of the current element.

Parameters

This function has no parameters.

Return Values

Returns scalar on success, or null on failure.

Errors/Exceptions

Issues E_NOTICE on failure.

© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/iterator.key.php