CKTIS / PHP
Parámetro de tipo array pasado por referencia: `array &$product`
`array &$product` exige un array en la llamada y permite que la función modifique la variable del código que la llama sin devolver el array.
Versión: PHP 8.3; extension availability may vary
Sintaxis
function restock(array &$product): void { $product['stock'] += 2; }
// Call with an array variable containing a numeric 'stock' value, without &:
$item = ['stock' => 3];
restock($item);En function restock(array &$product): void, array declara el tipo de entrada, & indica el paso por referencia y $product es el nombre local del parámetro. La referencia se aplica a la variable que contiene el array completo; no convierte sus elementos en referencias.
Antes de llamar a restock($item), asigna a $item un array con un valor numérico en la clave stock, por ejemplo ['stock' => 3]. El & va en la declaración, no en la llamada. Un literal de array no es un argumento válido para este parámetro, pero una función que devuelve un array por referencia sí puede proporcionar uno.
$product y $item se refieren al mismo valor. La función puede cambiar un elemento o sustituir el array completo, y el cambio sigue siendo visible después de la llamada. : void indica que no hay valor de retorno, no que no haya efectos secundarios. Sin &, el paso es por valor y el mismo cambio en un elemento normal se queda dentro de la función; los elementos que ya son referencias pueden seguir compartiéndose.
PHP comprueba el tipo array al entrar en la función y lanza un TypeError si la variable proporcionada no contiene un array. No comprueba las claves ni los tipos de los elementos, ni vuelve a comprobar el tipo del parámetro al salir. Por tanto, un array vacío supera la comprobación de tipo, pero PHP 8.3 emite una advertencia cuando += intenta leer la clave stock, que no existe. Al modificar una variable normal, asegúrate de que siga conteniendo un array si el código que llama a la función así lo espera.
Ejemplos
<?php
function restock(array &$product): void
{
$product['stock'] += 2;
}
$item = ['stock' => 3];
echo $item['stock'], "\n";
restock($item);
echo $item['stock'], "\n";
Resultado
3 5
La salida muestra `3` y después `5`. La función suma `2` a `$product['stock']`, así que `$item['stock']` vale `5` después de la llamada aunque la función no devuelva ningún valor.
Lecciones relacionadas
- PHP · Lección 20 · Avanzado · Versión: 2