PHP array_search() 関数

PHP Array 関数

例

配列内でキー値 "red" を検索し、そのキー名を返します：

<?php
$a=array("a"=>"red","b"=>"green","c"=>"blue");
echo array_search("red",$a);
?>

実行例

定義と用法

array_search() 関数は配列内で特定のキー値を検索し、対応するキー名を返します。

詳細な説明

array_search() 関数と in_array() 同じように、配列内でキー値を検索します。その値が見つかった場合、一致する要素のキー名が返されます。見つからない場合は false が返されます。

PHP 4.2.0 以前は、関数が失敗した場合、null ではなく false を返していました。

もし第3引数 strict true に設定されている場合、データタイプと値が一致する要素のみを返します。

構文

array_search(value,array,strict)
パラメータ 説明
value 必須。検索するキーバリューを指定します。
array 必須。検索する配列を指定します。
strict

オプション。このパラメータが TRUE に設定されている場合、関数は配列内でデータタイプと値が一致する要素を検索します。可能な値：

  • true
  • false - デフォルト

true に設定されている場合、配列内で指定された値のデータタイプと値が一致する要素を検索します。数字 5 と文字列 5 は異なります（例 2 を参照）。

技術的詳細

返り値：

指定されたキーバリューが配列内に見つかった場合、対応するキー名を返します。見つからない場合は FALSE を返します。

配列内で指定されたキーバリューが複数回見つかった場合、最初に見つかったキーバリューに対応するキー名を返します。
PHP バージョン： 4.0.5+
更新履歴：

無効なパラメータを関数に渡した場合、関数は NULL を返します（PHP 5.3.0 以降のすべての PHP 関数に適用されます）。

PHP 4.2.0 以降、検索失敗時は FALSE ではなく NULL を返します。

さらに多くの例

例 1

配列内でキーバリュー 5 を検索し、そのキー名を返します（注意「」）：

<?php
$a=array("a"=>"5","b"=>5,"c"=>"5");
echo array_search(5,$a,true);
?>

実行例

PHP Array 関数