PHP | array_keys() Function

The array_keys() is a built-in function in PHP and is used to return either all the keys of and array or the subset of the keys.

Syntax:

array array_keys($input_array, $search_value, $strict)

Parameters: The function takes three parameters out of which one is mandatory and other two are optional.

  1. $input_array (mandatory): Refers to the array that we want to operate on.
  2. $search_value (optional): Refers to the value of the array by which we want to search the array for the key elements. If this parameter is passed then the function will return keys coressponding to this element only otherwise it will return all keys of the array.
  3. $strict (optional): Determines if strict comparison (===) should be used during the search. false is the default value.

Return Value: The function returns an array containing either all of the keys or subset of keys the input array depending upon the parameters passed.

Examples:

Input :  $input_array = ("one" => "shyam", 2 => "rishav", 
                                          "three" => "gaurav")         
Output :
Array
(
    [0] => one
    [1] => 2
    [2] => three
)

Input : $input_array = ("one", "two", "three", "one", 
                          "four", "three", "one", "one")
        $search_value = "one"
Output :
Array
(
    [0] => 0
    [1] => 3
    [2] => 6
    [3] => 7
)

In the below program, we have passed a simple associative array to the function array_keys(), to print all of its keys:

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
  
// PHP function to illustrate the use of array_keys()
function get_Key($array)
{
    $result = array_keys($array);
    return($result);
}
  
$array = array("one" => "shyam", 2 => "rishav"
                             "three" => "gaurav");
print_r(get_Key($array));
  
?>

chevron_right


Output:

Array
(
    [0] => one
    [1] => 2
    [2] => three
)

In the below program, along with the array we have passed a value only for which the key position is returned.

filter_none

edit
close

play_arrow

link
brightness_4
code

<?php
  
// PHP function to illustrate the use of array_keys()
function get_Key($array, $search_value)
{
    $result = array_keys($array, $search_value);
    return($result);
}
  
$array = array("one", "two", "three", "one", "four"
                               "three", "one", "one");
$search_value = "one";
print_r(get_Key($array, $search_value));
  
?>

chevron_right


Output:

Array
(
    [0] => 0
    [1] => 3
    [2] => 6
    [3] => 7
)

Reference: http://php.net/manual/en/function.array-keys.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.




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.