PHPのarray_search()：値から配列のキーを検索する

array_search($value, $array)は、$valueと等しい最初の要素のキーを返し、一致する要素がなければfalseを返します。見つかったキーが0のこともあるので、if (($key = array_search('pear', $fruits)) !== false)のように、結果は!== falseで判定します。

<?php
$fruits = ['apple', 'pear', 'plum'];

$key = array_search('pear', $fruits);
var_dump($key);

$key = array_search('kiwi', $fruits);
var_dump($key);

$prices = ['apple' => 1.20, 'pear' => 0.90];
echo array_search(0.90, $prices), "\n";   // works with string keys too

あるかないかだけが知りたいなら、in_array()が直接答えてくれます。array_search()は、たとえば値を変更したり削除したりするために、値がどこにあるかを知る必要があるときに使います。

0とfalseの落とし穴

array_search()でいちばんよくあるバグです。値が最初の要素でキーが0のとき、if ($key)は0をfalseとして扱います。値がすぐそこにあるのに、コードは「見つからない」と言うのです。本当のfalseにだけ一致する!== falseで比較しましょう。

<?php
$queue = ['Ada', 'Linus', 'Grace'];

if (array_search('Ada', $queue)) {
    echo "Wrong check: found\n";
} else {
    echo "Wrong check: not found\n";      // this runs, key is 0
}

$key = array_search('Ada', $queue);
if ($key !== false) {
    echo "Right check: found at $key\n";
}

0 == falseはtrueなので、!= falseにもif ($key)と同じバグがあります。両者を区別できるのは厳密な演算子だけです。

厳密な検索

in_array()と同じく、array_search()も第三引数にtrueを渡さない限り==で比較します。ゆるいモードでは文字列が数値に一致し、nullが0に一致するので、予想外のキーが返ってきます。

<?php
$ids = [10, 20, 30];
var_dump(array_search('20', $ids));         // loose: "20" == 20
var_dump(array_search('20', $ids, true));   // strict: no match

$stock = ['apples' => 5, 'pears' => 0];
var_dump(array_search(null, $stock));       // null == 0: finds 'pears'
var_dump(array_search(null, $stock, true));

値に一致するすべてのキーを探す

array_search()は最初の一致で止まります。array_keys($array, $value)は一致するすべてのキーを配列で返し、trueを足せば厳密な比較になります。一致がなければ空の結果になるので、0とfalseの混同は起きません。

<?php
$seats = ['A1' => 'free', 'A2' => 'taken', 'A3' => 'free', 'A4' => 'taken'];

echo array_search('free', $seats), "\n";          // first only
print_r(array_keys($seats, 'free', true));       // all of them

$colors = ['red', 'blue', 'red', 'green', 'red'];
echo implode(', ', array_keys($colors, 'red')), "\n";

array_columnで多次元配列を検索する

array_search()はネストした配列の中までは見ません。行のリストなら、検索するフィールドをarray_column()で取り出します。そのリストの位置は行番号と一致するので、結果がそのまま行の添字になります。

<?php
$users = [
    ['id' => 101, 'name' => 'Ada',   'email' => 'ada@example.com'],
    ['id' => 102, 'name' => 'Linus', 'email' => 'linus@example.com'],
    ['id' => 103, 'name' => 'Grace', 'email' => 'grace@example.com'],
];

$i = array_search('linus@example.com', array_column($users, 'email'), true);
if ($i !== false) {
    echo "Found {$users[$i]['name']} with id {$users[$i]['id']}\n";
}

// When rows are looked up often, index them once by the field instead
$byEmail = array_column($users, null, 'email');
echo $byEmail['grace@example.com']['id'], "\n";

array_column()は出力に0から番号を振り直すので、行が欠番なく0, 1, 2と番号付けされているときしか対応がとれません。unset()やarray_filter()のあとは番号に欠番ができるので、先に行にarray_values()を実行するか、最後の2行のようにキー付きの検索を使います。インデックスキーの形についてはarray_column()で詳しく説明しています。

大文字小文字を区別しない検索

array_search()は文字列を正確に比較します。大文字小文字を無視するには両辺を小文字にします。array_map()はキーを保つので、返ってくるキーは元の配列のキーです。

<?php
$tags = ['first' => 'PHP', 'second' => 'Laravel', 'third' => 'MySQL'];

var_dump(array_search('mysql', $tags, true));

$lower = array_map('strtolower', $tags);
$key = array_search(strtolower('mysql'), $lower, true);
var_dump($key);
echo $tags[$key], "\n";

検索して置き換える、または削除する

検索するいちばんの理由は、見つけた要素を操作することです。キーがわかれば、代入して変更するかunset()で削除します。その前に必ず!== falseで確認してください。unset($arr[false])はキーが0の要素を黙って削除してしまいます。

<?php
$todo = ['buy milk', 'call Ada', 'write report'];

$key = array_search('call Ada', $todo, true);
if ($key !== false) {
    $todo[$key] = 'call Ada (done)';
}

$key = array_search('buy milk', $todo, true);
if ($key !== false) {
    unset($todo[$key]);
}

$todo = array_values($todo);   // renumber after unset
print_r($todo);