PHP array_search()関数

PHP Array Reference完全な PHP Array リファレンスマニュアル

例

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

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

例を実行 »

定義と使用法

array_search() 関数は、配列内で特定の値を検索し、対応するキー名を返すために使用されます。値が見つからない場合は false を返します。


構文

array_search(mixed $needle, array $haystack, bool $strict = false): int|string|false

パラメータ 説明
$needle 必須。配列内で検索するキー値を指定します。
$haystack 必須。検索対象の配列を指定します。
$strict オプション。デフォルトは false で、値のみを比較し、型は比較しません。このパラメータが TRUE に設定されている場合、関数は配列内でデータ型と値の両方が一致する要素を検索します。可能な値:
  • true
  • false - デフォルト
true に設定すると、配列内で指定された値の型を確認します。数値 5 と文字列 5 は異なります(例 2 を参照)。

技術詳細

戻り値: 配列内で指定されたキー値が見つかった場合は対応するキー名を返し、それ以外の場合は FALSE を返します。配列内でキー値が複数回見つかった場合は、最初に見つかったキー値に一致するキー名を返します。
PHP バージョン: 4.0.5+
更新ログ: 関数に無効なパラメータを渡すと、関数は NULL を返します(これは PHP 5.3.0 以降のすべての PHP 関数に適用されます)。

PHP 4.2.0 以降、検索に失敗した場合、この関数は NULL ではなく FALSE を返します。


その他の例

例

<?php
$numbers = array(1, "2", 3);
$key = array_search(2, $numbers);        // 厳密モードを有効にしない場合、キー名 1 を返す
$key_strict = array_search(2, $numbers, true);  // 厳密モードを有効にした場合、false を返す
?>

例 1

配列内でキー値 5 を検索し、そのキー名を返します("" に注意):

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

例を実行 »


PHP Array Reference完全な PHP Array リファレンスマニュアル その他の拡張機能