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

CKTIS / PHP

Parâmetro por referência `&$res`

O sinal `&` antes de `$res` permite à função alterar a variável fornecida pelo código que a chama, em vez de devolver um valor para a substituir.

Versão: PHP 8.3; extension availability may vary

Sintaxe

function writeSum(int $left, int $right, int &$res): void { /* ... */ }
$total = 0;
writeSum(2, 3, $total);

Na assinatura de uma função, &$res indica um parâmetro passado por referência. Durante a chamada, o nome local $res é um alias da variável do código que chama a função. Ao contrário da passagem por valor habitual, uma atribuição a $res altera essa variável. res é um nome comum, não uma palavra-chave; aqui, & não indica um ponteiro nem uma devolução por referência.

Escreve & na declaração, não na chamada: writeSum(2, 3, $total). Para o argumento passado por referência, usa uma variável, não um literal como 0 nem uma expressão calculada como 2 + 3. Também podes passar uma referência devolvida por uma função declarada para devolver por referência.

Em PHP 8.3, o tipo em int &$res é verificado à entrada da função e não volta a ser verificado à saída. A declaração, por si só, não garante que a variável continue a conter um int após a chamada. Dentro da função, unset($res) elimina apenas a ligação local, não a variável do código que fez a chamada.

Documenta os argumentos que a função pode sobrescrever. Se só precisas de produzir um resultado, sem alterar a variável do código que chama a função, um return normal costuma ser mais claro. Esta sintaxe faz parte da linguagem PHP e não requer extensões adicionais.

Exemplos

<?php
declare(strict_types=1);

function writeSum(int $left, int $right, int &$res): void
{
    $res = $left + $right;
}

$total = 0;
echo "before: ", $total, "\n";
writeSum(2, 3, $total);
echo "after: ", $total, "\n";

Resultado

before: 0
after: 5

`$total` começa com o valor `0`. A atribuição através de `$res` altera-o para `5`, embora `writeSum()` tenha o tipo de retorno `void` e não devolva um resultado.

Lições relacionadas

  • PHP · Lição 70 · Avançado · Versão: 2

Fontes