CKTIS / PHP
Parâmetro passado por referência (&$users)
O símbolo `&` antes do parâmetro `$users` permite que a função altere a variável do código que a chama sem devolver o array. Na chamada, passe a variável sem `&`.
Versão: PHP 8.3; extension availability may vary
Sintaxe
function addUser(array &$users, string $name): void { $users[] = $name; }
$users = ['Ada'];
addUser($users, 'Lin');Em array &$users, array indica o tipo do argumento e & indica a passagem por referência. O parâmetro local e a variável do código que chama a função são dois nomes para o mesmo valor. Aqui, & não representa um ponteiro nem um operador AND bit a bit, e a função não devolve uma referência.
Chame addUser($users, 'Lin') sem & e passe uma variável inicializada. Também é válida uma referência devolvida por uma função, mas não um array literal: addUser(['Ada'], 'Lin') lança um Error. O PHP verifica o tipo array à entrada da função, não à saída. Passar uma variável que contém uma cadeia de caracteres lança um TypeError.
$users[] = $name acrescenta um elemento no fim, enquanto uma atribuição normal como $users = [] substituiria todo o valor da variável no código que fez a chamada. A alteração continua visível após a chamada, embora a função não devolva nenhum valor (void). Sem &, o array é passado por valor por omissão e, neste exemplo, só o array local é alterado.
Use & quando a intenção for alterar a variável no código que chama a função e documente esse efeito, pois não é visível na chamada. Se couber a esse código decidir se substitui o array, receba-o por valor e devolva o array alterado.
Exemplos
<?php
function addUser(array &$users, string $name): void
{
$users[] = $name;
}
$users = ['Ada'];
echo implode(', ', $users), "\n";
addUser($users, 'Lin');
echo implode(', ', $users), "\n";
Resultado
Ada Ada, Lin
O exemplo usa o PHP 8.3 na linha de comandos e não precisa de extensões opcionais. Espera-se `Ada` antes da chamada e `Ada, Lin` depois. Se remover apenas `&` da declaração, o resultado esperado é `Ada` nas duas linhas.
Lições relacionadas
- PHP · Lição 28 · Intermédio · Versão: 3