PHPのforeach：キーと値、インデックス、参照渡し

foreach ($array as $value)は、要素ごとに1回ブロックを実行し、$valueには現在の要素が入ります。キーも取得するにはforeach ($array as $key => $value)と書きます。

<?php
$colors = ['red', 'green', 'blue'];

foreach ($colors as $color) {
    echo $color, "\n";
}

$ages = ['Ada' => 36, 'Linus' => 28, 'Grace' => 45];

foreach ($ages as $name => $age) {
    echo "$name is $age\n";
}

foreachはキーがどうであれどんな配列にも使え、カウンターを管理したり長さを確認したりする必要がありません。PHPでいちばんよく書くループです。

キーと値でループする

$key => $valueの名前は自由に選べます：$name => $age、$id => $user、$k => $v。リストではキーは位置0, 1, 2です。連想配列では、自分で定義した文字列のキーです。

<?php
$config = [
    'host' => 'localhost',
    'port' => 8080,
    'debug' => true,
];

foreach ($config as $key => $value) {
    printf("%-6s = %s\n", $key, var_export($value, true));
}

// Only the keys
foreach (array_keys($config) as $key) {
    echo "key: $key\n";
}

// Keys like "1" become integers
$codes = ["1" => 'one', "01" => 'zero one'];
foreach ($codes as $key => $value) {
    echo gettype($key), " key ", var_export($key, true), " => $value\n";
}

最後のループは、よく驚かれる細かい点を示しています。"1"のように整数に見える文字列のキーは、整数の1として保存されます。"01"は正規の整数表記ではないので、文字列のままです。

foreachでインデックスを取得する

リストではキーがインデックスなので、foreach ($items as $i => $item)だけで十分です。連想配列には数値の位置がないので、カウンターを持ちます。最初や最後の要素だけ扱いを変えるには、キーをarray_key_first()やarray_key_last()と比較します。

<?php
$steps = ['Preheat', 'Mix', 'Bake'];

foreach ($steps as $i => $step) {
    echo "Step ", $i + 1, ": $step\n";   // index starts at 0
}

$scores = ['Ada' => 91, 'Linus' => 78, 'Grace' => 85];
$position = 1;
foreach ($scores as $name => $score) {
    echo "#$position $name ($score)\n";
    $position++;
}

$last = array_key_last($scores);
foreach ($scores as $name => $score) {
    echo $name, $name === $last ? "\n" : ", ";
}

最後のループは名前の間にカンマを出力し、最後の名前のあとには出力しません。まさにこの用途ならimplode(', ', array_keys($scores))のほうが短く書けます。array_key_last()による確認は、区切り文字が違うだけでなく、最後の回で別の処理が必要な場合のためのものです。

foreachで配列の値を変更する（参照渡し）

$valueはコピーです。これに代入しても配列は何も変わりません。配列を変えるには、&$valueで参照としてループするか、キーを使って書き戻します。

<?php
$prices = [10, 25, 40];

foreach ($prices as $price) {
    $price = $price * 2;          // changes the copy only
}
echo implode(', ', $prices), "\n";

foreach ($prices as &$price) {
    $price = $price * 2;          // changes the array
}
unset($price);                    // break the reference (see next section)
echo implode(', ', $prices), "\n";

foreach ($prices as $key => $price) {
    $prices[$key] = $price + 1;   // same effect, no reference
}
echo implode(', ', $prices), "\n";

どちらも動きます。キーを使う方法はループのあとに隠れた状態が残らないので、こちらを好むチームも多くあります。配列を変えるのではなく新しい配列を作るなら、array_map()という選択肢もあります。

関連する疑問として、ループ中に要素を追加するとどうなるでしょうか。普通のforeachはループ開始時点の配列を順に処理するので、中で$prices[] = ...としても回数は増えません。参照のループは現在の配列を処理するので、新しい要素も処理します。

参照渡しのforeachとunset()の落とし穴

foreach ($arr as &$v)のあとも、変数$vは配列の最後の要素への参照のままです。あとで普通のループに同じ名前の$vを使うと、毎回その最後の要素に書き込まれます。実行して最後の項目を見てください。

<?php
$letters = ['a', 'b', 'c'];

foreach ($letters as &$v) {
    $v = strtoupper($v);
}
// missing: unset($v);

foreach ($letters as $v) {
    // each pass assigns to $v, which is still $letters[2]
}

print_r($letters);   // C was overwritten

$fixed = ['a', 'b', 'c'];
foreach ($fixed as &$v) {
    $v = strtoupper($v);
}
unset($v);           // the fix
foreach ($fixed as $v) {
}
print_r($fixed);

2つ目のループは$letters[2]にA、次にB、最後に最後の要素自身の値を代入しますが、最後の回の時点でその位置にはすでにBが入っています。直し方は1行で、参照によるforeachの直後に必ずunset($v);を書きます。

foreachでのbreakとcontinue

breakはループを抜け、continueは次の要素に飛びます。よくあるのは検索のパターンで、必要なものが見つかるまでループし、見つかったらbreakして配列の残りを確認しないようにします。

<?php
$orders = [
    ['id' => 101, 'status' => 'paid'],
    ['id' => 102, 'status' => 'cancelled'],
    ['id' => 103, 'status' => 'paid'],
    ['id' => 104, 'status' => 'pending'],
];

foreach ($orders as $order) {
    if ($order['status'] === 'cancelled') {
        continue;               // skip this one
    }
    echo "Order {$order['id']}: {$order['status']}\n";
}

$found = null;
foreach ($orders as $order) {
    if ($order['status'] === 'pending') {
        $found = $order;
        break;                  // stop searching
    }
}
echo "First pending: ", $found['id'] ?? 'none', "\n";

ネストしたループでは、break 2で内側とその外側のループを抜け、continue 2で外側のループの次の回に進みます。

ネストした配列とlist()を使ったforeach

データの行は、配列の中の配列です。行をループしてから各行をループするか、配列の分割代入を使ってforeachの行で直接フィールドを取り出します。リストには[$a, $b]、連想配列の行には['key' => $var]を使います。list($a, $b)は[$a, $b]の古い書き方です。

<?php
$users = [
    ['name' => 'Ada', 'langs' => ['PHP', 'Python']],
    ['name' => 'Linus', 'langs' => ['C']],
];

// Nested foreach
foreach ($users as $user) {
    echo $user['name'], ":";
    foreach ($user['langs'] as $lang) {
        echo " $lang";
    }
    echo "\n";
}

// Destructuring associative rows
foreach ($users as ['name' => $name, 'langs' => $langs]) {
    echo "$name knows ", count($langs), " language(s)\n";
}

// Destructuring list rows (list() is the same as [])
$points = [[1, 2], [3, 5], [8, 13]];
foreach ($points as [$x, $y]) {
    echo "($x, $y) ";
}
echo "\n";
foreach ($points as list($x, $y)) {
    echo $x + $y, " ";
}

[...] =構文については、要素の読み飛ばしやネストしたパターンも含め、分割代入のページで詳しく説明しています。

foreachでHTMLのリストや表を作る

テンプレートでは、foreach (...):とendforeach;のコロン形式でタグの間でもループを読みやすく保てます。このブロックは表を作り、列の見出しはリンクになっています。Pageタブで見出しをクリックすると、$_GET['sort']がセットされた状態で同じスクリプトがもう一度実行され、行が新しい順番で返ってきます。

<?php
$products = [
    ['name' => 'Keyboard', 'price' => 49.0, 'stock' => 12],
    ['name' => 'Mouse', 'price' => 19.5, 'stock' => 40],
    ['name' => 'Monitor', 'price' => 189.0, 'stock' => 3],
    ['name' => 'Cable', 'price' => 6.25, 'stock' => 0],
];

$sort = $_GET['sort'] ?? 'name';
if (!in_array($sort, ['name', 'price', 'stock'], true)) {
    $sort = 'name';
}
usort($products, fn($a, $b) => $a[$sort] <=> $b[$sort]);

$total = 0;
foreach ($products as $p) {
    $total += $p['price'] * $p['stock'];
}
?>
<style>
    table { border-collapse: collapse; font-family: sans-serif; }
    th, td { border: 1px solid #ccc; padding: 4px 10px; }
    .out { color: #999; }
</style>
<table>
    <tr>
        <?php foreach (['name', 'price', 'stock'] as $col): ?>
            <th><a href="?sort=<?= $col ?>"><?= ucfirst($col) ?></a><?= $col === $sort ? ' ▲' : '' ?></th>
        <?php endforeach; ?>
    </tr>
    <?php foreach ($products as $p): ?>
        <tr class="<?= $p['stock'] === 0 ? 'out' : '' ?>">
            <td><?= htmlspecialchars($p['name']) ?></td>
            <td><?= number_format($p['price'], 2) ?></td>
            <td><?= $p['stock'] ?></td>
        </tr>
    <?php endforeach; ?>
</table>
<p>Stock value: <?= number_format($total, 2) ?></p>

このブロックには真似したい習慣が2つあります。URLから来たsortの値は、使う前に許可された列の一覧と照合しています。そして、ユーザーのテキストを含みうる値をHTMLに出力するときは、すべてhtmlspecialchars()を通しています。

null、空の配列、オブジェクトに対するforeach

空の配列は問題ありません。本体が実行されないだけです。null、文字列、数値はだめで、PHPは警告を表示してループを飛ばします。$tags = null; foreach ($tags as $tag)では次のように表示されます。

Warning: foreach() argument must be of type array|object, null given in /var/www/html/index.php on line 4

これがいちばんよく起きるのは、デコードしたJSONの任意の項目のように、ときどき欠けるデータです。??で空の配列にフォールバックしましょう。

foreach ($data['tags'] ?? [] as $tag) {
    echo $tag;
}

このメッセージにあるobjectは本当です。オブジェクトに対するforeachは、ループが実行される場所から見えるプロパティ（クラスの外ならpublicなもの）を、プロパティ名をキーとして順に処理します。IteratorやIteratorAggregateを実装したクラスとジェネレーターは、foreachに何を見せるかを自分で決めます。

foreach、for、array_mapの使い分け

手早い判断方法：ループの本体が要素ごとに新しい値を計算するだけなら、array_map(fn($x) => $x * 2, $a)で1行で表せます。副作用がある（出力する、保存する、複数のものを同時に数える）か、breakが必要なら、foreachを書きましょう。