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)
La estructura de lenguaje foreach proporciona una forma sencilla de
recorrer array y objetos Traversable.
foreach generará un error cuando se utilice con
una variable que contenga un tipo de datos diferente o con una variable no inicializada.
foreach puede eventualmente obtener la clave de cada elemento:
foreach (iterable_expression as $value) {
statement_list
}
foreach (iterable_expression as $key => $value) {
statement_list
}
La primera forma revisa el array
iterable_expression. En cada iteración, el valor del
elemento actual se asigna a $value.
La segunda forma asignará además la clave del elemento actual
a la variable $key en cada iteración.
Es importante señalar que foreach no modifica el puntero
interno del array, que es utilizado por funciones como
current() y key().
Es posible personalizar la iteración sobre objetos.
Ejemplo #1 Usos comunes de foreach
<?php
/* Ejemplo: valor únicamente */
$array = [1, 2, 3, 17];
foreach ($array as $value) {
echo "Valor actual de \$array: $value.\n";
}
/* Ejemplo: clave y valor */
$array = [
"uno" => 1,
"dos" => 2,
"tres" => 3,
"diecisiete" => 17
];
foreach ($array as $key => $value) {
echo "\$array[$key] => $value.\n";
}
/* Ejemplo: arrays clave-valor multidimensionales */
$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 "Valor en la posición x=$x y y=$y: $value\n";
}
}
/* Ejemplo: arrays dinámicos */
foreach (range(1, 5) as $value) {
echo "$value\n";
}
?>Nota:
foreachno soporta la posibilidad de suprimir los mensajes de error utilizando el@.
(PHP 5 >= 5.5.0, PHP 7, PHP 8)
Es posible iterar sobre un array de arrays y descomponer el array anidado
en variables de bucle utilizando la
desestructuración de array
mediante [] o utilizando el constructor de lenguaje list() como valor.
Nota: Es importante señalar que la desestructuración de array mediante
[]solo es posible a partir de PHP 7.1.0
En los dos ejemplos siguientes, $a será definido sobre
el primer elemento del array anidado y $b contendrá
el segundo elemento:
<?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";
}
?>El resultado del ejemplo sería:
A: 1; B: 2 A: 3; B: 4
Cuando hay menos variables que elementos en el array, los elementos restantes serán ignorados. De manera similar, los elementos pueden ser ignorados utilizando una coma:
<?php
$array = [
[1, 2, 3],
[3, 4, 6],
];
foreach ($array as [$a, $b]) {
// Note que no hay $c aquí.
echo "$a $b\n";
}
foreach ($array as [, , $c]) {
// Ignorar $a y $b
echo "$c\n";
}
?>El resultado del ejemplo sería:
1 2 3 4 5 6
Se generará una notificación si no hay suficientes elementos en el array para llenar la función list():
<?php
$array = [
[1, 2],
[3, 4],
];
foreach ($array as [$a, $b, $c]) {
echo "A: $a; B: $b; C: $c\n";
}
?>El resultado del ejemplo sería:
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:
Es posible modificar directamente los elementos del array en un bucle precediendo
$value con &.
En este caso, el valor será asignado por
referencia.
<?php
$arr = [1, 2, 3, 4];
foreach ($arr as &$value) {
$value = $value * 2;
}
// $arr ahora es [2, 4, 6, 8]
unset($value); // romper la referencia con el último elemento
?>
La referencia a $value del último elemento del array
permanece incluso después del bucle foreach. Se recomienda
destruir estas referencias utilizando unset().
De lo contrario, se producirá el siguiente comportamiento:
<?php
$arr = [1, 2, 3, 4];
foreach ($arr as &$value) {
$value = $value * 2;
}
// $arr ahora es [2, 4, 6, 8]
// sin unset($value), $value sigue siendo una referencia al último elemento: $arr[3]
foreach ($arr as $key => $value) {
// $arr[3] será actualizado con cada valor de $arr...
echo "{$key} => {$value} ";
print_r($arr);
}
// ...hasta que finalmente el penúltimo valor sea copiado en el último valor
?>El resultado del ejemplo sería:
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 )
Ejemplo #2 Iterar sobre los valores de un array constante por referencia
<?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";
}