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

CKTIS / PHP

Parâmetro passado por referência (`&$st`)

O sinal `&` antes do nome do parâmetro permite à função alterar a variável do código que a chama. Escreve `&$st` na declaração, mas chama a função sem `&`: `markReady($status)`.

Versão: PHP 8.3; extension availability may vary

Sintaxe

function markReady(string &$st): void { $st .= '!'; }
markReady($status);

Em PHP 8.3, string &$st indica que o argumento é passado por referência. Dentro da função, $st é um alias local de $status, a variável do código que fez a chamada: os dois nomes referem-se ao mesmo valor. Escrever através de $st altera $status, e a alteração continua visível depois de a função terminar. Sem &, a passagem é feita por valor por omissão, pelo que uma atribuição ao parâmetro não altera a variável original.

Coloca & antes do nome do parâmetro na declaração, não na chamada. Passa uma variável inicializada, como em markReady($status). O literal em markReady('Ready') não é uma variável e provoca um erro. Também não passes expressões comuns que calculam um valor; o resultado de uma função que devolve por referência é um caso distinto permitido.

O tipo string do parâmetro é verificado à entrada da função, mas não volta a ser verificado à saída. : void significa que a função não devolve nenhum valor; o efeito é visível na variável passada. Usa & quando a alteração dessa variável for intencional e documenta-a, pois a chamada, por si só, não a indica.

Exemplos

<?php
function markReady(string &$st): void
{
    $st .= '!';
}

$status = 'Ready';
echo $status, "\n";
markReady($status);
echo $status, "\n";

Resultado

Ready
Ready!

A primeira linha mostra `Ready`. A função acrescenta `!` através de `$st`, pelo que a segunda linha mostra `Ready!`. Se retirares apenas `&` da declaração, ambas as linhas mostram `Ready`.

Lições relacionadas

  • PHP · Lição 34 · Intermédio · Versão: 3

Fontes