An easier way to unpack nested array elements
$array = [
[1, 2],
[3, 4],
];
foreach ($array as [$a, $b]) {
echo "A: $a; B: $b\n";
}
(PHP 4, PHP 5, PHP 7, PHP 8)
foreach
は、
配列と Traversable
オブジェクトを反復処理する簡単な方法を提供します。
それらと異なるデータ型や、未初期化の変数と一緒に foreach
を使うと、エラーが発生します。
foreach
は、オプションで以下のようにして要素ごとの key
も取得できます。
foreach (iterable_expression as $value) { statement_list } foreach (iterable_expression as $key => $value) { statement_list }
最初の形式は、iterable_expression
で指定した反復可能な値に
関してループ処理を行います。各反復において現在の要素の値が
$value
に代入されます。
2番目の形式は、さらに各反復で現在の要素のキーを変数
$key
に代入します。
foreach
は、
current() や
key()
のような関数で使われる、内部的な配列のポインタを変更しない点に注意して下さい。
オブジェクトの反復処理をカスタマイズ することもできます。
例1 一般的な foreach
の使用法
<?php
/* 例: 値のみ */
$array = [1, 2, 3, 17];
foreach ($array as $value) {
echo "Current element of \$array: $value.\n";
}
/* 例: キーと値 */
$array = [
"one" => 1,
"two" => 2,
"three" => 3,
"seventeen" => 17
];
foreach ($array as $key => $value) {
echo "Key: $key => Value: $value\n";
}
/* 例: 多次元のキーと値の配列 */
$grid = [];
$grid[0][0] = "a";
$grid[0][1] = "b";
$grid[1][0] = "y";
$grid[1][1] = "z";
foreach ($grid as $y => $row) {
foreach ($row as $x => $value) {
echo "Value at position x=$x and y=$y: $value\n";
}
}
/* Example: dynamic arrays */
foreach (range(1, 5) as $value) {
echo "$value\n";
}
?>
注意:
foreach
は、@
を使ってエラーメッセージを抑制する機能はサポートしていません。
(PHP 5 >= 5.5.0, PHP 7, PHP 8)
配列の配列を反復処理し、
ネストした配列をループ変数に展開させることができます。
配列の分解
を []
で行うか、list()
言語構造を反復処理の値として指定します。
注意:
[]
による 配列の分解 処理は、PHP 7.1.0 以降でのみ利用可能である点に注意しましょう。
以下の例は両方、
$a
にネストされた配列の最初の要素が設定され、
$b
には二番目の要素が含まれます:
<?php
$array = [
[1, 2],
[3, 4],
];
foreach ($array as [$a, $b]) {
echo "A: $a; B: $b\n";
}
foreach ($array as list($a, $b)) {
echo "A: $a; B: $b\n";
}
?>
上の例の出力は以下となります。
A: 1; B: 2 A: 3; B: 4
配列の要素より少ない変数が指定された場合、 残りの要素は無視されます。 同様に、以下のようにしてカンマを使うことで要素をスキップできます:
<?php
$array = [
[1, 2, 5],
[3, 4, 6],
];
foreach ($array as [$a, $b]) {
// Note that there is no $c here.
echo "$a $b\n";
}
foreach ($array as [, , $c]) {
// Skipping over $a and $b
echo "$c\n";
}
?>
上の例の出力は以下となります。
1 2 3 4 5 6
以下のように、list() を埋めるだけの十分な要素数が配列にない場合、警告が発生します:
<?php
$array = [
[1, 2],
[3, 4],
];
foreach ($array as [$a, $b, $c]) {
echo "A: $a; B: $b; C: $c\n";
}
?>
上の例の出力は以下となります。
Notice: Undefined offset: 2 in example.php on line 7 A: 1; B: 2; C: Notice: Undefined offset: 2 in example.php on line 7 A: 3; B: 4; C:
ループ中で、
$value
の前に &
をつけることで、配列の要素を直接変更することができます。
この場合、値は リファレンス
として代入されます。
<?php
$arr = [1, 2, 3, 4];
foreach ($arr as &$value) {
$value = $value * 2;
}
// $arr is now [2, 4, 6, 8]
unset($value); // break the reference with the last element
?>
配列の最後の要素の $value
へのリファレンスは、
foreach
が終了した後も残ったままです。
このリファレンスは unset() することをお勧めします。
そうしないと、以下のようなことが起きてしまいます:
<?php
$arr = [1, 2, 3, 4];
foreach ($arr as &$value) {
$value = $value * 2;
}
// $arr は現在 [2, 4, 6, 8]
// unset($value) しないと、$value はまだ最後の要素 $arr[3] を指した状態のままです
foreach ($arr as $key => $value) {
// $arr[3] は $arr の値ごとに更新され続けてしまいます...
echo "{$key} => {$value} ";
print_r($arr);
}
// ...最終的に、最後から2番目の値が最後の値にコピーされるまで
?>
上の例の出力は以下となります。
0 => 2 Array ( [0] => 2, [1] => 4, [2] => 6, [3] => 2 ) 1 => 4 Array ( [0] => 2, [1] => 4, [2] => 6, [3] => 4 ) 2 => 6 Array ( [0] => 2, [1] => 4, [2] => 6, [3] => 6 ) 3 => 6 Array ( [0] => 2, [1] => 4, [2] => 6, [3] => 6 )
例2 定数の配列の値を、リファレンスで反復処理する
<?php
foreach ([1, 2, 3, 4] as &$value) {
$value = $value * 2;
}
?>
An easier way to unpack nested array elements
$array = [
[1, 2],
[3, 4],
];
foreach ($array as [$a, $b]) {
echo "A: $a; B: $b\n";
}
<?php
$array = [
[1, 2, 3],
[3, 4, 6],
];
foreach ($array as [$a, $b]) {
// Observe que não existe $c aqui.
echo "$a $b\n";
}
foreach ($array as [, , $c]) {
// Pulando $a e $b
echo "$c\n";
}
?>
I would like to correct this example above!
The answer of this algorithm is:
1 2
3 4
3
6