PHP array_keys() Function

Last Updated : 20 Jun, 2023

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.

$input_array (mandatory): Refers to the array that we want to operate on.
$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 corresponding to this element only otherwise it will return all keys of the array.
$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:

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));

?>

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.

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));

?>

Output:

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

Reference: http://php.net/manual/en/function.array-keys.php

PHP array_keys() Function

chinmoy lenka

Improve

Article Tags :

Practice Tags :

Misc

Similar Reads

PHP array_chunk() Function

The array_chunk() function is an inbuilt function in PHP which is used to split an array into parts or chunks of given size depending upon the parameters passed to the function. The last chunk may contain fewer elements than the desired size of the chunk. Syntaxarray array_chunk( $array, $size, $pre

2 min read

PHP array_combine() Function

The array_combine() function is an inbuilt function in PHP which is used to combine two arrays and create a new array by using one array for keys and another array for values. That is all elements of one array will be the keys of new array and all elements of the second array will be the values of t

2 min read

PHP array_count_values() Function

The array_count_values() is an inbuilt function in PHP which is used to count all the values inside an array. In other words we can say that array_count_values() function is used to calculate the frequency of all of the elements of an array. Syntax: array array_count_values( $array ) Parameters: Thi

2 min read

PHP array_diff_assoc() Function

This inbuilt function of PHP is used to get the difference between one or more arrays. This function compares both the keys and values between one or more arrays and returns the difference between them. So, the function generally compares two arrays according to there keys and values and returns the

2 min read

PHP array_diff_key() Function

This inbuilt function of PHP is used to get the difference between one or more arrays. This function compares the keys between one or more arrays and returns the difference between them. So, the function generally compares two arrays according to their keys and returns the elements that are present

2 min read

PHP array_diff_uassoc() Function

The array_diff_uassoc() function is a built-in function in PHP and is used to get the difference between one or more arrays using an user-defined function to compare the keys. This function compares both the keys and values between one or more arrays to and returns the elements from the first array

4 min read

PHP array_diff_ukey() Function

The array_diff_ukey() function is an inbuilt function in PHP. It is used to compares the key two or more arrays using a user-defined function, and return an array, which is array1 and its not present any others array2, array3 or more... Syntax: array_diff_ukey($array1, $array2, $array3..., arr_diffu

4 min read

PHP array_diff() function

The array_diff() is an inbuilt function in PHP ans is used to calculate the difference between two or more arrays. This function computes difference according to the values of the elements, between one or more array and return differences in the form of a new array. This function basically returns a

2 min read

PHP array_fill_keys() Function

The array_fill_keys() function is a builtin function in PHP and is used to create a new array filled with the given keys and value provided as an array to the function. Syntax: array array_fill_keys ( $keys, $value ) Parameters: This function accepts two parameters, keys and their values to be prese

3 min read

PHP array_fill() function

The array_fill() is an inbuilt-function in PHP and is used to fill an array with values. This function basically creates an user-defined array with a given pre-filled value. Syntax: array_fill($start_index, $number_elements, $values) Parameter: The array_fill() function takes three parameters and ar

2 min read