PHPの連想配列：キーと値の追加・ループ・ソート

連想配列は、各値を自分で選んだキーの下にkey => valueの形で格納します：$user = ['name' => 'Ada', 'age' => 36];。値は$user['name']で読み、キーに代入すれば追加や変更ができます：$user['email'] = 'ada@example.com';。

<?php
$user = [
    'name' => 'Ada',
    'age'  => 36,
    'city' => 'London',
];

echo $user['name'], "\n";
echo $user['age'], "\n";

$user['email'] = 'ada@example.com';   // add a pair
$user['city']  = 'Paris';             // change a value

print_r($user);

ほかの言語では、同じ構造が辞書、マップ、ハッシュなどと呼ばれます。PHPでは、キーが0, 1, 2ではなく文字列であるだけの普通の配列です。

ペアを追加・変更・削除する

存在しないキーに代入すると、末尾に追加されます。存在するキーに代入すると、位置はそのままで値が置き換わります。unset()はペアを削除します。

<?php
$stock = ['apples' => 10, 'pears' => 4];

$stock['plums'] = 7;      // new key: added at the end
$stock['apples'] = 12;    // existing key: value replaced
$stock['pears']--;        // change in place
unset($stock['plums']);   // remove a pair

print_r($stock);

ここではarray_push()は役に立ちません。数値のキーで値を追加することしかできないからです。複数のペアを一度に追加するには、新しい値が優先されるarray_merge($stock, $more)か、既存のキーの値が残る$stock + $moreを使います。2つの違いはarray_mergeのページで比べています。

キーと値でループする

foreach ($array as $key => $value)は、追加された順番にペアを処理します。値だけが必要なら$key =>を省きます。

<?php
$capitals = [
    'France'  => 'Paris',
    'Japan'   => 'Tokyo',
    'Brazil'  => 'Brasília',
];

foreach ($capitals as $country => $capital) {
    echo "The capital of $country is $capital.\n";
}

foreach ($capitals as $capital) {
    echo mb_strtoupper($capital), "\n";
}

すべてのキーやすべての値を取得する

array_keys()はキーを普通のリストで返し、array_values()は値を返します。どちらも0から番号が振り直されます。array_keys()に2つ目の引数を渡すとその値を持つキーだけを返すので、ある値に対応するすべてのキーを探せます。

<?php
$grades = ['Ada' => 'A', 'Linus' => 'B', 'Grace' => 'A'];

print_r(array_keys($grades));
print_r(array_values($grades));
print_r(array_keys($grades, 'A'));    // keys whose value is 'A'

echo array_search('B', $grades), "\n"; // first key with value 'B'

キーを1つだけなら、array_search()が最初に一致したキーを、なければfalseを返します。その結果を!== falseで比較しなければならない理由はarray_searchのページで説明しています。

キーが存在するか確認する

isset($arr['key'])は定番で最速の確認方法ですが、キーが存在していても値がnullならfalseを返します。その場合、array_key_exists('key', $arr)はtrueを返します。既定値付きで読むなら、??演算子が両方を一度に行います。

<?php
$settings = ['theme' => 'dark', 'font' => null];

var_dump(isset($settings['theme']));
var_dump(isset($settings['font']));            // null counts as not set
var_dump(array_key_exists('font', $settings)); // the key is there

$size = $settings['size'] ?? 14;               // default when missing
echo $size, "\n";

キーや値で並べ替える

ksort()はキーで、asort()は値で並べ替え、どちらも各キーを値と結びつけたまま保ちます。krsort()とarsort()は逆順に並べ替えます。連想配列にsort()を使ってはいけません。キーを捨てて0から番号を振り直してしまいます。

<?php
$population = ['Tokyo' => 37, 'Delhi' => 32, 'Shanghai' => 29, 'Cairo' => 22];

ksort($population);       // A to Z by city
print_r($population);

arsort($population);      // largest value first
print_r($population);

sort($population);        // keys are lost
print_r($population);

これらはすべてその場で並べ替えてtrueを返すので、$sorted = ksort($arr)で得られるのは配列ではなくtrueです。独自の順番にはuasort()とuksort()を使います。

入れ替え、集計、JSONへの変換

キーと値のデータでは、決まった1行の処理が何度も出てきます。array_flip()はキーと値を入れ替え、array_count_values()は各値が何回現れるかを数え、json_encode()は配列をJSONオブジェクトにします。

<?php
$codes = ['red' => '#f00', 'green' => '#0f0', 'blue' => '#00f'];

print_r(array_flip($codes));           // look up a name by code

$votes = ['yes', 'no', 'yes', 'yes', 'no'];
print_r(array_count_values($votes));   // value => how many times

echo json_encode($codes), "\n";

よくあるミス：存在しないキーを読む

存在しないキーを読むとnullが返りますが、自分の環境のPHPでは警告も表示されます。

<?php
$user = ['name' => 'Ada'];
echo $user['phone'];

Warning: Undefined array key "phone" in /var/www/html/index.php on line 3

決して警告を出さない??で既定値を与えるか、存在しない場合に別の処理が必要なら、先にisset()で確認します。

<?php
$user = ['name' => 'Ada', 'email' => 'ada@example.com'];

$phone = $user['phone'] ?? 'no phone on file';
echo $phone, "\n";

if (isset($user['email'])) {
    echo "Send mail to {$user['email']}\n";
}

ダブルクォートの文字列の中では、"{$user['email']}"のように参照を波括弧で囲みます。波括弧がないと、PHPは引用符なしの"$user[email]"の形しか受け付けず、間違えやすくなります。