Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / PHP

Parâmetros passados por referência (&$tasks, &$used)

O sinal `&` em `$tasks` e `$used` permite à função alterar ambas as variáveis de quem a chama sem ter de as devolver.

Versão: PHP 8.3; extension availability may vary

Sintaxe

function addTask(array &$tasks, array &$used, string $name): void { /* ... */ }
addTask($tasks, $used, 'Review');

Em PHP 8.3, escreve-se & imediatamente antes do nome de cada parâmetro na declaração: array &$tasks, array &$used. Não se escreve & na chamada addTask($tasks, $used, 'Review'). Como $name não tem &, o argumento correspondente é passado por valor, o comportamento predefinido.

Durante a chamada, cada parâmetro por referência é um alias local da variável passada pelo código que chamou a função. Alterar um elemento do array ou atribuir um novo valor ao parâmetro altera essa variável. As alterações continuam visíveis depois da chamada, mesmo com o tipo de retorno void. O & num parâmetro não indica que a função devolve por referência.

O mais simples é passar variáveis inicializadas. Também se pode passar o resultado de uma função que devolve por referência. Não uses um literal como [] nem o resultado de uma expressão comum no lugar de $tasks ou $used: um literal nessa posição provoca um erro.

A declaração array é verificada à entrada da função: passar uma variável que não contém um array provoca um TypeError. O PHP não volta a verificar estes tipos de parâmetros quando a função termina. Documenta os argumentos que a função altera, porque isso não é visível na chamada. Esta funcionalidade não requer nenhuma extensão adicional.

Exemplos

<?php

function addTask(array &$tasks, array &$used, string $name): void
{
    $tasks[] = $name;
    $used[$name] = true;
}

$tasks = [];
$used = [];
addTask($tasks, $used, 'Review');

echo $tasks[0], "\n";
echo $used['Review'] ? "used\n" : "unused\n";

Resultado

Review
used

Depois da chamada, `$tasks[0]` contém `Review` e `$used['Review']` tem o valor `true`. Por isso, o programa escreve `Review` e, na linha seguinte, `used`.

Lições relacionadas

  • PHP · Lição 12 · Básico · Versão: 2

Fontes