func_get_arg

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

func_get_argRetorna um item para uma lista de argumentos

Descrição

func_get_arg ( int $arg_num ) : mixed

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

Esta função pode ser usada juntamente com func_get_arg() e func_num_args() para usar com variável lista de argumentos.

Parâmetros

arg_num

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

Valor Retornado

Retorna o argumento especificado, ou false em erro.

Changelog

Versão Descrição
5.3.0 Esta função pode agora ser usada na lista de parâmetros.

Erros

Gera um aviso se chamado fora de uma função definida pelo usuário, ou se arg_num é maior que o número de argumentos passado.

Exemplos

Exemplo #1 Exemplo da func_get_arg()

<?php
function foo()
{
     
$numargs func_num_args();
     echo 
"Number of arguments: $numargs<br />\n";
     if (
$numargs >= 2) {
     echo 
"Second argument is: " func_get_arg(1) . "<br />\n";
     }


foo (123);
?>

Notas

Nota:

Devido a esta função depender do escopo atual para definir os detalhes dos parâmetros, ela não pode ser usada como o parâmetro de uma função. Se este valor precisa ser passado, os resultados devem ser atribuídos para uma variável, e esta variável deve ser re passada.

Nota: Esta função retorna somente uma cópia dos argumentos passados, e não conta por argumentos padrão (não passado).

Veja Também

  • func_get_args() - Retorna um array contendo uma lista de argumentos da função
  • func_num_args() - Retorna o número de argumentos passados para a função

add a note add a note

User Contributed Notes 5 notes

up
8
beta3designs [at] gmail [dot] com
14 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
1
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
-4
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.
up
-5
anders at ingemann dot fakestuff dot de
19 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.
To Top