array_keys

(PHP 4, PHP 5)

array_keys — 配列のキーすべて、あるいはその一部を返す

説明

array array_keys ( array $input [, mixed $search_value = NULL [, bool $strict = false ]] )

array_keys() は、配列 input から全てのキー (数値および文字列) を返します。

オプション search_value が指定された場合、指定した値に関するキーのみが返されます。指定されない場合は、 input から全てのキーが返されます。

パラメータ

input: 返すキーを含む配列。
search_value: 指定した場合は、これらの値を含むキーのみを返します。
strict: 検索時に厳密な比較 (===) を行うかどうか。

返り値

input のすべてのキーを配列で返します。

変更履歴

バージョン	説明
5.0.0	`strict` パラメータが追加されました。

例

例1 array_keys() の例


<?php
$array = array(0 => 100, "color" => "red");
print_r(array_keys($array));

$array = array("blue", "red", "green", "blue", "blue");
print_r(array_keys($array, "blue"));

$array = array("color" => array("blue", "red", "green"),
               "size"  => array("small", "medium", "large"));
print_r(array_keys($array));
?>

上の例の出力は以下となります。

Array
(
    [0] => 0
    [1] => color
)
Array
(
    [0] => 0
    [1] => 3
    [2] => 4
)
Array
(
    [0] => color
    [1] => size
)

参考

array_values() - 配列の全ての値を返す
array_key_exists() - 指定したキーまたは添字が配列にあるかどうかを調べる
array_search() - 指定した値を配列で検索し、見つかった場合に対応するキーを返す