PHP | key() Function

The key() function is an inbuilt function in PHP which is used to return the index of the element of a given array to which the internal pointer is currently pointing. The current element may be starting or next element which depends on the cursor position. By default cursor position is at zero index i.e, at starting element of the given array.

Syntax:

key($array)

Parameters: This function accepts a single parameter $array. It is the array for which we want to find the current element pointed by the internal pointer.

Return Value: It returns the index of current element of the given array. If the input array is empty then the key() function will return NULL.

Below programs illustrate the key() function in PHP:

Program 1:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
  
// input array 
$arr = array("Ram", "Geeta", "Shita", "Ramu");
  
// Here key function prints the index of 
// current element of the array.
echo "The index of the current element of".
                    " the array is: " . key($arr);
                      
?>

chevron_right


Output:

The index of the current element of the array is: 0

Program 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
  
// input array 
$arr=array("Ram", "Geeta", "Shita", "Ramu");
  
// next function increase the internal pointer
// to point next to the current element.
next($arr);
  
// Here key function prints the index of 
// the current element of the array.
echo "The index of the current element of".
                " the array is: " . key($arr);
                  
?>

chevron_right


Output:

The index of the current element of the array is: 1

Progam 3:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
  
// input array 
$arr = array("0", "F", "D", "4");
  
// using next() function to increment
// internal pointer two times
next($arr);
next($arr);
  
// Here key function prints the index of
// element of the current array position.
echo "The index of the current element of".
                " the array is: " . key($arr);
                  
?>

chevron_right


Output:

The index of the current element of the array is: 2

Reference:
http://php.net/manual/en/function.key.php



My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.



Improved By : shubham_singh



Article Tags :
Practice Tags :


Be the First to upvote.


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.