Argumentos de funções
Informações podem ser passadas para funções através da lista de argumentos, que é uma
lista de expressões delimitados por vírgulas. Os argumentos são avaliados
da esquerda para a direita, e antes que a função seja efetivamente chamada
(avaliação antecipada eager).
O PHP suporta a passagem de argumentos por valor (o padrão), passagem por
referência, e valores padrões de
argumentos. lista de argumentos de
tamanho variável e argumentos nomeados
também são suportadas.
Exemplo #1 Passando arrays para funções
<?php
function takes_array($input)
{
echo "$input[0] + $input[1] = ", $input[0]+$input[1];
}
?>
A partir do PHP 8.0.0, a lista de argumentos de uma função pode incluir uma vírgula final,
que será ignorada. Isto é particularmente útil nos casos que a quantidade de argumentos é
longa ou contém nomes longos, sendo conveniente listar os argumentos verticalmente.
Exemplo #2 Argumentos de função com uma vírgula final
<?php
function takes_many_args(
$primeiro,
$segundo,
$uma_variavel_com_nome_longo,
$parametro_com_default = 5,
$de_novo = 'argumento padrão', // Essa vírgula final não era permitida antes do PHP 8.0.0.
)
{
// ...
}
?>
Passando argumentos por referência
Por padrão, argumentos de função são passados por valor (de forma que se
você mudar o valor do parâmetro dentro da função, ele não é alterado fora
da função). Para permitir que uma função modifique os
seus argumentos, eles devem ser passados por referência.
Para ter um argumento para uma função sempre passado por referência, adicione
antes dele um "e comercial" (&) ao nome do argumento na definição da função:
Exemplo #3 Passando parâmetros de função por referência
<?php
function add_some_extra(&$string)
{
$string .= ' e alguma coisa mais.';
}
$str = 'Isto é uma string,';
add_some_extra($str);
echo $str; // imprime 'Isto é uma string, e alguma coisa mais.'
?>
É um erro passar um argumento por valor onde é esperado a passagem por referência.
Valores padrão de argumentos
Uma função pode definir valores padrão para argumentos usando sintaxe similar
a atribuição de uma variável. O padrão é usado apenas quando o parâmetro não
é especificado. Em particular, note que passar null não
atribui o valor padrão.
Exemplo #4 Utilizando parâmetros padrão em funções
<?php
function makecoffee($type = "cappuccino")
{
return "Fazendo uma xícara de café $type.\n";
}
echo makecoffee();
echo makecoffee(null);
echo makecoffee("espresso");
?>
O exemplo acima produzirá:
Fazendo uma xícara de café cappuccino.
Fazendo uma xícara de café.
Fazendo uma xícara de café espresso.
Valores padrões de parâmetro podem ser valores escalares, arrays,
o tipo especial null e, a partir do PHP 8.1.0, objetos usando a
sintaxe new ClassName().
Exemplo #5 Usando tipos não escalares como valores padrões
<?php
function fazercafe($tipos = array("cappuccino"), $cafeteira = NULL)
{
$dispositivo = is_null($cafeteira) ? "mãos" : $cafeteira;
return "Fazendo uma xícara de ".join(", ", $tipos)." com $dispositivo.\n";
}
echo fazercafe();
echo fazercafe(array("cappuccino", "lavazza"), "chaleira");?>
Exemplo #6 Usando objetos como valores padrão (a partir do PHP 8.1.0)
<?php
class CafeteiraPadrao {
public function preparar() {
return 'Fazendo café.';
}
}
class CafeteiraChique {
public function preparar() {
return 'Preparando um belo café só para você.';
}
}
function fazercafe($cafeteira = new CafeteiraPadrao)
{
return $cafeteira->preparar();
}
echo fazercafe();
echo fazercafe(new CafeteiraChique);
?>
O valor padrão precisa ser uma expressão constante, não (por
exemplo) uma variável, um membro de classe ou uma chamada de função.
Note que quaisquer argumentos opcionais devem ser especificados após os
argumentos obrigatórios, caso contrário, eles não podem ser omitidos das chamadas.
Considere o seguinte exemplo:
Exemplo #7 Uso incorreto de parâmetros padrão de função
<?php
function fazeriogurte($recipiente = "tigela", $sabor)
{
return "Fazendo um(a) $recipiente de iogurte de $sabor.\n";
}
echo fazeriogurte("framboesa"); // "framboesa" é $recipiente, não $sabor
?>
O exemplo acima produzirá:
Fatal error: Uncaught ArgumentCountError: Too few arguments
to function fazeriogurte(), 1 passed in example.php on line 42
Agora, compare o que está acima com este:
Exemplo #8 Uso correto de parâmetros padrão de função
<?php
function fazeriogurte($sabor, $recipiente = "tigela")
{
return "Fazendo um(a) $recipiente de iogurte de $sabor.\n";
}
echo fazeriogurte("framboesa"); // "framboesa" é $sabor
?>
O exemplo acima produzirá:
Fazendo um(a) tigela de iogurte de framboesa.
A partir do PHP 8.0.0, argumentos nomeados
podem ser usados para pular vários parâmetros opcionais.
Exemplo #9 Uso correto de argumentos padrão de função
<?php
function fazeriogurte($recipiente = "tigela", $sabor = "framboesa", $estilo = "Grego")
{
return "Fazendo um(a) $recipiente de iogurte $estilo de $sabor.\n";
}
echo fazeriogurte(estilo: "natural");
?>
O exemplo acima produzirá:
Fazendo um(a) tigela de iogurte natural de framboesa.
A partir do PHP 8.0.0, declarar argumentos obrigatórios após argumentos opcionais
está depreciado. Isso geralmente pode ser resolvido descartando
o valor padrão, pois nunca será usado.
Uma exceção a essa regra são argumentos no formato
Type $param = null, onde o padrão null torna o tipo implicitamente
anulável. Este uso continua permitido, embora seja recomendado usar um
tipo anulável explícito.
Exemplo #10 Declarando argumentos opcionais após argumentos obrigatórios
<?php
function foo($a = [], $b) {} // Padrão não utilizado; depreciado a partir do PHP 8.0.0
function foo($a, $b) {} // Funcionalmente equivalente, sem notícia de depreciação
function bar(A $a = null, $b) {} // Ainda permitido; $a é obrigatório porém anulável
function bar(?A $a, $b) {} // Recomendado
?>
Nota:
A partir do PHP 7.1.0, omitir um parâmetro que não especifica um padrão
lança um ArgumentCountError; em versões anteriores
isso emitia um Aviso.
Nota:
Argumentos passados por referência podem ter um valor padrão.
Número variável de argumentos
O PHP suporta argumentos em quantidade variável em
funções definidas pelo usuário, utilizando o token
....
Nota:
Também é possível emular argumentos variáveis utilizando as funções
func_num_args(),
func_get_arg(), e
func_get_args().
Esta técnica não é recomendada dado que ela era necessária apenas antes da introdução
do token ....
Lista de argumentos que contém o token
... token para indicam que a função aceita uma
quantidade variável de argumentos. Os argumentos serão passados
na variável como um array:
Exemplo #11 Utilizando ... para acessar argumentos variáveis
<?php
function sum(...$numbers) {
$acc = 0;
foreach ($numbers as $n) {
$acc += $n;
}
return $acc;
}
echo sum(1, 2, 3, 4);
?>
O exemplo acima produzirá:
Você também pode utilizar ... quando chamando funções para
transformar uma variável array, Traversable ou
literal em uma lista de argumentos.
Exemplo #12 Utilizando ... para fornecer argumentos
<?php
function add($a, $b) {
return $a + $b;
}
echo add(...[1, 2])."\n";
$a = [1, 2];
echo add(...$a);
?>
O exemplo acima produzirá:
Você pode especificar argumentos posicionais antes do indicador.
.... Nesse caso comente os argumentos finais,
que não pareiam com um argumento posicional, serão adicionados ao
array gerado por ....
É também possível adicionar um
type hint antes do indicador
.... Se presente então todos os argumentos
capturados por ... deverão conformar com o tipo do parâmetro.
Exemplo #13 Argumentos variáveis com type hint
<?php
function total_intervals($unit, DateInterval ...$intervals) {
$time = 0;
foreach ($intervals as $interval) {
$time += $interval->$unit;
}
return $time;
}
$a = new DateInterval('P1D');
$b = new DateInterval('P2D');
echo total_intervals('d', $a, $b).' days';
// This will fail, since null isn't a DateInterval object.
echo total_intervals('d', null);
?>
O exemplo acima produzirá:
3 days
Catchable fatal error: Argument 2 passed to total_intervals() must be an instance of DateInterval, null given, called in - on line 14 and defined in - on line 2
Finalmente, você também pode passar argumentos variáveis
por referência ao
prefixar ... com um
&.
Versões anteriores do PHP
Funções com argumentos variáveis não precisam de sintaxe específica.
O acesso aos argumentos da função precisam utilizar.
func_num_args(), func_get_arg()
e func_get_args().
O primeiro exemplo acima seria implementado em versões anteriores do PHP:
Exemplo #14 Acessando argumentos variáveis em versões anteriores do PHP
<?php
function sum() {
$acc = 0;
foreach (func_get_args() as $n) {
$acc += $n;
}
return $acc;
}
echo sum(1, 2, 3, 4);
?>
O exemplo acima produzirá:
Argumentos nomeados
O PHP 8.0.0 introduziu argumentos nomeados como uma extensão aos
parâmetros posicionais. Argumentos nomeados permitem a passagem de argumentos para uma
função utilizando-se os nomes de parâmetros, ao invés da posição do parâmetro.
Isto torna o significado do argumento auto documentável, e tornam os argumentos
independente de ordem, além de permitir pular argumentos com defaults.
Argumentos nomeados são passados ao prefixar o valor um o nome do parâmetro
e um dois pontos. Usar palavras reservadas como nomes de parâmetro é permitido.
O nome de parâmetro precisa ser um identificados, e uma resolução dinâmica
não é permitida.
Exemplo #15 Sintaxe dos argumentos nomeados
<?php
minhaFuncao(nomeParametro: $valor);
array_foobar(array: $value);
// NÃO suportado
nome_funcao($variaveoQueGuardaNomeDoParametro: $valor);
?>
Exemplo #16 Comparando argumentos posicionais e nomeados
<?php
// Utilizando argumentos posicionais:
array_fill(0, 100, 50);
// Utilizando argumetos nomeados:
array_fill(start_index: 0, count: 100, value: 50);
?>
A ordem em que argumentos nomeados são passados não importa.
Exemplo #17 Mesmo exemplo com argumentos em ordem diferente
<?php
array_fill(value: 50, count: 100, start_index: 0);
?>
Argumentos nomeados podem ser combinados com argumentos posicionais. Nesse caso,
os argumentos nomeados precisam estar depois dos argumentos posicionais.
Também é possível especificar somente alguns dos argumentos opcionais de
uma função, independente da ordem.
Exemplo #18 Combinando argumentos posicionais e nomeados
<?php
htmlspecialchars($string, double_encode: false);
// Mesmo que
htmlspecialchars($string, ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401, 'UTF-8', false);
?>
Passar o mesmo argumento mais de uma vez resulta em um Error.
Exemplo #19 Erro lançado ao passar o mesmo argumento nomeado mais de uma vez
<?php
function foo($param) { ... }
foo(param: 1, param: 2);
// Error: Named parameter $param overwrites previous argument
foo(1, param: 2);
// Error: Named parameter $param overwrites previous argument
?>
A partir do PHP 8.1.0, é possível usar argumentos nomeados após desempacotar os argumentos.
Um argumento nomeado não deve sobrepor argumentos já desempacotados.
Exemplo #20 Usando argumentos nomeados após desempacotar
<?php
function foo($a, $b, $c = 3, $d = 4) {
return $a + $b + $c + $d;
}
var_dump(foo(...[1, 2], d: 40)); // 46
var_dump(foo(...['b' => 2, 'a' => 1], d: 40)); // 46
var_dump(foo(...[1, 2], b: 20)); // Fatal error. Named parameter $b overwrites previous argument
?>
