PHPのarray_keys()関数とは？使い方と具体例をわかりやすく解説

PHPのarray_keys()関数は、配列に含まれるすべてのキーを配列として返す組み込み関数です。連想配列からキーの一覧だけを取り出したい場合や、特定の値を持つ要素のキーを調べたい場合に便利です。

基本構文

array_keys(arr, value, strict)

パラメータ

• arr − キーを取得する対象となる配列を指定します。このパラメータは必須です。

• value − 値を指定すると、その値を持つ要素のキーのみが返されます。省略した場合は、配列内のすべてのキーが返されます。

• strict − 検索時に厳密な比較（===）を行うかどうかを指定します。true を設定すると、データ型まで一致した場合のみマッチとみなされます。デフォルトは false です。

戻り値

array_keys()関数は、指定された配列のすべてのキーを格納した新しい配列を返します。value パラメータが指定されている場合は、その値に一致する要素のキーのみを含む配列が返されます。

使用例：すべてのキーを取得する

まず、連想配列からすべてのキーを取得する基本的な例を見てみましょう。

<?php
$arr = array("one" => "Pen", "two" => "Pencil", "three" => "Paper", "four" => "Notepad");
print_r(array_keys($arr));
?>

出力結果

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

このように、元の配列のキーである「one」「two」「three」「four」が、添字付きの配列として返されています。

使用例：特定の値に対応するキーを検索する

次に、value パラメータを使って、特定の値「Notepad」に対応するキーだけを取得する例を紹介します。

<?php
$arr = array("one" => "Pen", "two" => "Notepad", "three" => "Paper", "four" => "Notepad");
print_r(array_keys($arr, "Notepad"));
?>

出力結果

Array
(
[0] => two
[1] => four
)

「Notepad」という値を持つ要素は2つあるため、対応するキー「two」と「four」の両方が返されました。このように、同じ値が複数存在する場合でも、該当するすべてのキーが取得できます。

まとめ

array_keys()関数を使うことで、配列のキー一覧を簡単に取得できます。value パラメータと strict パラメータを組み合わせれば、より柔軟なキーの検索も可能です。配列操作の頻度が高いPHPプログラミングにおいて、覚えておくと非常に役立つ関数といえるでしょう。