PHP マニュアル
前のページ次のページ

array_search

(PHP 4 >= 4.0.5, PHP 5)

array_search --  指定した値を配列で検索し、見つかった場合に対応するキーを返す

説明

mixed array_search ( mixed needle, array haystack [, bool strict] )

haystackにおいて needleを検索し、配列中に見付かった場合にそ のキーを返します。そうでない場合にFALSEを返します。

注意: もし needle が文字列の場合、 大文字小文字を区別して比較が行われます。

注意: PHP 4.2.0以前では、array_search() は、 失敗した場合にFALSEではなく NULL を返します。

オプションの3番目のパラメータstrictに TRUEが指定された場合、array_search()は haystackの中で needleの型に一致するかどうかも確認します。

もし haystack に 1 つ以上の needle に見つかった場合、 最初にマッチしたキーが返されます。 全てのマッチした値に対するキーを返すためには、代わりに array_keys() にパラメータ search_value を付けて使用してください。

例 1. array_search() の例

<?php
$array = array(0 => 'blue', 1 => 'red', 2 => 'green', 3 => 'red');

$key = array_search('green', $array); // $key = 2;
$key = array_search('red', $array);   // $key = 1;
?>

警告

この関数は論理値 FALSE を返す可能性がありますが、FALSE として評価される 0 や "" といった値を返す可能性もあります。 詳細については 論理値の セクションを参照してください。この関数の返り値を調べるには ===演算子 を 使用してください。

array_keys(), array_values(), array_key_exists(), in_array() も参照ください。

前のページホーム次のページ
array_reverse上に戻るarray_shift