array_keys() - 配列のキーの一覧を取得する
公開日:
array_keysは、指定した配列のキーの一覧を取得する関数です。第2引数に値を指定すると、その値を持つキーだけに絞り込むことができます。
構文
array array_keys ( array $array [, mixed $search_value = null [, bool $strict = false ]] )パラメータ
$array
対象の配列。
$search_value
初期値: null
値を指定すると、この値を持つキーだけに絞り込む。
$strict
初期値: false
第2引数で検索する場合、厳密な比較を行なうか否か。
返り値
array
キーの一覧の配列。
サンプルコード
キーの一覧を取得する
対象の配列のキー一覧を、配列で取得します。
php
<?php
// 配列
$queue = [
"a" => 1 ,
"b" => 2 ,
"c" => 3 ,
] ;
// 実行
$result = array_keys( $queue ) ;
// 返り値
print_r( $result ) ;結果 (出力内容) - PHP7.0.21
Array
(
[0] => a
[1] => b
[2] => c
)キーを絞り込む
第2引数に値を指定すると、その値を持つキーだけに絞り込めます。比較は$a==$bで行なわれるので、数値の1と文字列の"1"は同じ扱いとなります。
php
<?php
// 配列
$queue = [
"a" => 1 ,
"b" => 2 ,
"c" => "1" ,
"d" => 2 ,
"e" => "1" ,
] ;
// 実行
$result = array_keys( $queue, "1" ) ;
// 返り値
print_r( $result ) ;結果 (出力内容) - PHP7.0.21
Array
(
[0] => a
[1] => c
[2] => e
)厳密に比較する
第3引数にtrueを指定すれば、型も考慮した厳密な比較($a===$b)を行ないます。
php
<?php
// 配列
$queue = [
"a" => 1 ,
"b" => 2 ,
"c" => "1" ,
"d" => 2 ,
"e" => "1" ,
] ;
// 実行
$result = array_keys( $queue, "1", true ) ;
// 返り値
print_r( $result ) ;結果 (出力内容) - PHP7.0.21
Array
(
[0] => c
[1] => e
)サンドボックス
ソースコードを編集してarray_keys()の挙動を確認して下さい。
参考リンク
- PHP - 公式マニュアル。