PHP 4, PHP 5, PHP 7, PHP 8
key - Fetch a key from an array
Code Examples

key( array|object$array ): int|string|null

key returns the index element of the current array position.



The array.

Return Values

The key function simply returns the key of the array element that's currently being pointed to by the internal pointer. It does not move the pointer in any way. If the internal pointer points beyond the end of the elements list or the array is empty, key returns null.


Version Description
8.1.0 Calling this function on objects is deprecated. Either use get_mangled_object_vars on the object first, or use ArrayIterator.

Related Functions

Example of key

Show all examples for key

PHP Version: