PHP 8.4.0 RC2 available for testing

func_get_arg

(PHP 4, PHP 5, PHP 7, PHP 8)

func_get_argRetorna um item de uma lista de argumentos

Descrição

func_get_arg(int $position): mixed

Obtém o argumento especificado de uma lista de argumentos de uma função definida pelo usuário.

Esta função pode ser usada juntamente com func_get_args() e func_num_args() para permitir que funções definidas pelo usuário aceitem listas de argumentos com comprimento variável.

Parâmetros

position

O índice do argumento. Argumentos de função são contados iniciando de zero.

Valor Retornado

Retorna o argumento especificado, ou false em caso de erro.

Erros/Exceções

Gera um alerta se chamada fora de uma função definida pelo usuário, ou se position for maior que o número de argumentos realmente passados.

Exemplos

Exemplo #1 Exemplo de func_get_arg()

<?php
function foo()
{
$numargs = func_num_args();
echo
"Número de argumentos: $numargs<br />\n";
if (
$numargs >= 2) {
echo
"Segundo argumento é: " . func_get_arg(1) . "<br />\n";
}
}

foo (1, 2, 3);
?>

O exemplo acima produzirá:

Número de argumentos: 3
Segundo argumento é: 2

Exemplo #2 Exemplo de func_get_arg() com argumentos por valor e por referência

<?php
function byVal($arg) {
echo
'Como passado : ', var_export(func_get_arg(0)), PHP_EOL;
$arg = 'baz';
echo
'Depois da mudança: ', var_export(func_get_arg(0)), PHP_EOL;
}

function
byRef(&$arg) {
echo
'Como passado : ', var_export(func_get_arg(0)), PHP_EOL;
$arg = 'baz';
echo
'Depois da mudança: ', var_export(func_get_arg(0)), PHP_EOL;
}

$arg = 'bar';
byVal($arg);
byRef($arg);
?>

O exemplo acima produzirá:


Como passado : 'bar'
Depois da mudança: 'baz'
Como passado : 'bar'
Depois da mudança: 'baz'

Notas

Nota:

A partir do PHP 8.0.0, a família de funções func_*() deve ser mais transparente em relação aos argumentos nomeados, tratando os argumentos como se fossem todos passados posicionalmente, e os argumentos ausentes são substituídos por seus valores padrão. Esta função ignora a coleção de argumentos variádicos nomeados desconhecidos. Argumentos nomeados desconhecidos que são coletados só podem ser acessados por meio do parâmetro variádico.

Nota:

Se os argumentos forem passados por referência, qualquer alteração nos argumentos será refletida nos valores retornados por esta função. A partir do PHP 7, os valores atuais também serão retornados se os argumentos forem passados por valor.

Nota: Esta função retorna uma cópia apenas dos argumentos informados, e não leva em consideração argumentos padrão (não informados).

Veja Também

add a note

User Contributed Notes 5 notes

up
8
beta3designs [at] gmail [dot] com
15 years ago
This functions seems so powerful... just when i saw it i thought about writing a fast average of n numbers function so here it is, it is very simple... example usage included.

<?php

//Calculate the average of the numbers given

function avg(){
$sum = 0;
for(
$i = 0; $i < func_num_args(); $i++){
$sum += func_get_arg($i);
}
$avg = $sum / func_num_args();
return
$avg;
}

echo
sprintf("%.2f",avg(2,1,2,1,3,4,5,1,3,6));
?>
up
1
gordon at abetz-rouse dot com dot au
4 years ago
This function may work differently from php5 to php7, in the latter it seems to reference the variable, while in php5 it returns the original argument.
I have confirmed with the versions below, but this will require further confirmation as to whether this is a 5 versus 7 issue.

function test( $test ){

$test = '123';

echo func_get_arg(0);

}

test( '321' );

//in php 5.5.9, this script will write '321'
//in php 7.0.33, this script will write '123'
up
0
mightye (at) mightye (dot) org
20 years ago
func_get_arg() returns a *copy* of the argument, to my knowledge there is no way to retrieve references to a variable number of arguments.

I have a module system in my game at http://lotgd.net where I'd like to be able to pass a variable number of arguments to functions in a module, and pass them by reference if the module asks for it by reference, but you can't accept optional parameters as references, nor can you retrieve the reference on a variable number of arguments. Looks like my modules will have to do with out the ability to accept parameters to their functions by reference.
up
-3
anders at ingemann dot fakestuff dot de
20 years ago
I actually think that there is need for such "do absolutely everything" functions. I use them mostly as tools for rapid prototyping.
And there is a method with which you may be able to pass several strings to a function: ereg();
Another use for such functions is to create little code snippets for other people out there. They won't have to edit the function any longer if they do not use a parameter. They just don't name it when calling the function.
This results in allrounder functions that are very robust in their use.Normally you just have a little code snippet (e.g. ip-blocking snippets). Through this type of programming you have whole functions.
up
-5
mw atto lanfear dotto com
19 years ago
func_get_arg() does not appear to be allowed to be used as a function argument itself within class constructors in PHP 5.0.2 (wonk-ay!!!):

<?php

class ABC
{
function
__construct()
{
foreach (
func_get_args() as $name => $value)
{
echo <<<EOT
<br/>
$name : $value <br/>
<br/>

EOT;
}
}
}

class
DEF extends ABC
{
function
__construct()
{
parent::__construct(func_get_arg(0),
func_get_arg(1),
func_get_arg(2));
}
}

$def = new DEF(123123, "asdfasdf", "blahblahblah");

?>

The above script generates:

Fatal error: func_get_arg(): Can't be used as a function parameter in c:\Inetpub\wwwroot\phpwasrc\chapter10\xxx.php on line 23

There are, however, no problems when passing these as parameters to regular functions.
To Top