The 7th Annual China PHP Conference

func_get_args

(PHP 4, PHP 5, PHP 7)

func_get_argsRetourne les arguments d'une fonction sous la forme d'un tableau

Description

func_get_args ( void ) : array

Récupère les arguments d'une fonction sous la forme d'un tableau.

func_get_arg() peut être utilisé conjointement à func_num_args() et func_get_args() pour permettre aux fonctions utilisateurs d'accepter un nombre variable d'arguments.

Valeurs de retour

Retourne un tableau dont chaque élément est une copie du membre correspondant de la liste d'arguments de la fonction.

Historique

Version Description
5.3.0 Cette fonction peut maintenant être utilisée dans des listes de paramètres.
5.3.0 Si cette fonction est appelée dans un fichier inclus avec include ou require logé dans une fonction, elle génèrera une alerte et retournera FALSE.

Erreurs / Exceptions

Générera une alerte si elle est appelée hors d'une fonction.

Exemples

Exemple #1 Exemple avec func_get_args()

<?php
function foo()
{
    
$numargs func_num_args();
    echo 
"Nombre d'arguments : $numargs \n";
    if (
$numargs >= 2) {
        echo 
"Le second argument est : " func_get_arg(1) . "\n";
    }
    
$arg_list func_get_args();
    for (
$i 0$i $numargs$i++) {
        echo 
"L'argument $i est : " $arg_list[$i] . "\n";
    }
}

foo(123);
?>

L'exemple ci-dessus va afficher :

Nombre d'arguments : 3
Le second argument est : 2
L'argument 0 est : 1
L'argument 1 est : 2
L'argument 2 est : 3

Exemple #2 Exemples func_get_args() avant et après PHP 5.3

test.php
<?php
function foo() {
    include 
'./fga.inc';
}

foo('Argument 1''Argument 2');
?>

fga.inc
<?php

$args 
func_get_args();
var_export($args);

?>

Sortie avant PHP 5.3:

array (
  0 => 'Argument 1',
  1 => 'Argument 2',
)

Sortie depuis PHP 5.3

Warning: func_get_args():  Called from the global scope - no function
context in /home/torben/Desktop/code/ml/fga.inc on line 3
false

Exemple #3 Exemple func_get_args() avec des arguments par référence et par valeur

<?php
function byVal($arg) {
    echo 
'Tel que passé     : 'var_export(func_get_args()), PHP_EOL;
    
$arg 'baz';
    echo 
'Après changement  : 'var_export(func_get_args()), PHP_EOL;
}

function 
byRef(&$arg) {
    echo 
'Tel que passé     : 'var_export(func_get_args()), PHP_EOL;
    
$arg 'baz';
    echo 
'Après changement  : 'var_export(func_get_args()), PHP_EOL;
}

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

Résultat de l'exemple ci-dessus en PHP 7 :


Tel que passé : array (
0 => 'bar',
)
Après changement : array (
0 => 'baz',
)
Tel que passé : array (
0 => 'bar',
)
Après changement : array (
0 => 'baz',
)

Résultat de l'exemple ci-dessus en PHP 5 :


Tel que passé : array (
0 => 'bar',
)
Après changement : array (
0 => 'bar',
)
Tel que passé : array (
0 => 'bar',
)
Après changement : array (
0 => 'baz',
)

Notes

Note:

Parce que cette fonction dépend de la portée courante pour déterminer les détails des paramètres, ils ne peuvent pas être utilisés en tant que paramètre d'une fonction dans les versions de PHP antérieures à 5.3.0. Si cette valeur doit être passée, le résultat doit être assigné à une variable et cette variable doit être passée.

Note:

Si les arguments sont passés par référence, toutes leurs modifications seront reflétées dans les valeurs retournées par cette fonction. À partir de PHP 7, les valeurs courantes seront aussi retournées si les arguments sont passés par leur valeur.

Note: Cette fonction retourne uniquement une copie des arguments passés, et ne compte ne traite pas les arguments par défaut (non passés).

add a note add a note

User Contributed Notes 9 notes

up
43
T.M.
14 years ago
Simple function to calculate average value using dynamic arguments:
<?php
function average(){
    return
array_sum(func_get_args())/func_num_args();
}
print
average(10, 15, 20, 25); // 17.5
?>
up
4
foxkeys at gmail dot com
3 years ago
Merge func_get_args() with function defaults
<?php
class utils {
 
/**
   * @param mixed[] $args
   * @param ReflectionMethod $reflectionMethod
   *
   * @return array
   */
 
public static function mergeArgsWithDefaults( $args, \ReflectionMethod $reflectionMethod ) {
    foreach (
array_slice( $reflectionMethod->getParameters(), count( $args ) ) as $param ) {
     
/**
       * @var ReflectionParameter $param
       */
     
$args[] = $param->getDefaultValue();
    }
    return
$args;
  }
}

class 
sampleParent {
  const
USER_FILE_TYPE_FILE = 'FILE';
  public function
select( $idUserFile = null, $idUserFileType = self::USER_FILE_TYPE_FILE ) {
    echo
'[$idUserFile=>' . $idUserFile . ', $idUserFileType=>' . $idUserFileType, ']<br/>' . PHP_EOL;
  }
}

class
sample extends sampleParent {
  const
USER_FILE_TYPE_IMG = 'IMG';
  public function
select( $idUserFile = null, $idUserFileType = self::USER_FILE_TYPE_IMG ) {
    return
call_user_func_array( 'parent::select', \utils::mergeArgsWithDefaults( func_get_args(), new ReflectionMethod( __CLASS__, __FUNCTION__ ) ) );
  }
}

$sample1 = new sampleParent();
$sample1->select();//Prints "" / self::USER_FILE_TYPE_FILE
$sample1->select(1);//Prints 1 / self::USER_FILE_TYPE_FILE
$sample1->select(2, 'test 1');//Prints 2 / "test 1"
echo '<br/>' . PHP_EOL;
$sample2 = new sample();
$sample2->select();//Prints "" / self::USER_FILE_TYPE_IMG
$sample2->select(3);//Prints 3 / self::USER_FILE_TYPE_IMG
$sample2->select(4, 'test 2');//Prints 4 / "test 2"
?>
up
15
anderson at francotecnologia dot com
10 years ago
How to create a polymorphic/"overloaded" function

<?php
function select()
{
   
$t = '';
   
$args = func_get_args();
    foreach (
$args as &$a) {
       
$t .= gettype($a) . '|';
       
$a = mysql_real_escape_string($a);
    }
    if (
$t != '') {
       
$t = substr($t, 0, - 1);
    }
   
$sql = '';
    switch (
$t) {
        case
'integer':
           
// search by ID
           
$sql = "id = {$args[0]}";
            break;
        case
'string':
           
// search by name
           
$sql = "name LIKE '%{$args[0]}%'";
            break;
        case
'string|integer':
           
// search by name AND status
           
$sql = "name LIKE '%{$args[0]}%' AND status = {$args[1]}";
            break;
        case
'string|integer|integer':
           
// search by name with limit
           
$sql = "name LIKE '%{$args[0]}%' LIMIT {$args[1]},{$args[2]}";
            break;
        default:
           
// :P
           
$sql = '1 = 2';
    }
    return
mysql_query('SELECT * FROM table WHERE ' . $sql);
}
$res = select(29); // by ID
$res = select('Anderson'); // by name
$res = select('Anderson', 1); // by name and status
$res = select('Anderson', 0, 5); // by name with limit
?>
up
1
ario [a] mail [dot] utexas [dot] edu
12 years ago
"Because this function depends on the current scope to determine parameter details, it cannot be used as a function parameter. If you must pass this value, assign the results to a variable, and pass the variable."

This means that the following code generates an error:

<?php

function foo($list)
{
  echo
implode(', ', $list);
}

function
foo2()
{
 
foo(func_get_args());
}

foo2(1, 2, 3);

?>

However, you can easily get around this by doing the following:

<?php

function foo($list)
{
  echo
implode(', ', $list);
}

function
foo2()
{
 
foo($args = func_get_args());
}

foo2(1, 2, 3);

?>

This captures the context from foo2(), making this legal.  You get the expected output:

"1, 2, 3"
up
2
mitko at edabg dot com
10 years ago
<?php
/*
This example demonstrate how to use unknown variable arguments by reference.
func_get_args() don't return arguments by reference, but
debug_backtrace() "args" is by reference.
In PHP 5 this have no particular sense, because calling with arguments by reference
is depreciated and produce warning.
*/

class foo {

    var
$bar = "default bar";
   
    function
foo(/*variable arguments*/) {
// func_get_args returns copy of arguments
//        $args = func_get_args();
// debug_backtrace returns arguments by reference           
       
$stack = debug_backtrace();
       
$args = array();
        if (isset(
$stack[0]["args"]))
            for(
$i=0; $i < count($stack[0]["args"]); $i++)
               
$args[$i] = & $stack[0]["args"][$i];
       
call_user_func_array(array(&$this, 'bar'), $args);
    }
   

    function
bar($bar = NULL) {
        if (isset(
$bar))
           
$this->bar = & $bar;
    }
}

$global_bar = "bar global";
$foo = & new foo();
echo
"foo->bar:    ".$foo->bar."</br>\n";
$foo->bar = "new bar";
echo
"global_bar:  ".$global_bar."</br>\n";
/*
Result:
foo->bar:    default bar</br>
global_bar:  bar global</br>
*/

$foo = & new foo(&$global_bar);
echo
"foo->bar:    ".$foo->bar."</br>\n";
$foo->bar = "new bar";
echo
"global_bar:  ".$global_bar."</br>\n";
/*
Result:
foo->bar:    bar global</br>
global_bar:  new bar</br>
*/

?>
up
1
OpenTechnologist
7 years ago
please note that optional parameters are not seen/passed by func_get_args(), as well as func_get_arg().

ex:

<?php
function testfunc($optional = 'this argument is optional..') {
   
$args = func_get_args();
   
var_dump($args);
    echo
$optional;
}
?>

test case #1:
testfunc('argument no longer optional..');

result for #1:
array(1) {
    [0]=>  string(20) "argument no longer optional.."
}
argument no longer optional..

test case #2:
testfunc('argument no longer optional..','this is an extra argument');

result for #2:
array(2) {
    [0]=>  string(29) "argument no longer optional.."
    [1]=>  string(25) "this is an extra argument"
}
argument no longer optional..

test case #3: -- RESULTS IN AN EMPTY ARRAY
testfunc();

result for #3:
array(0) {
}
this argument is optional..
up
0
daveNO at ovumSPAMdesign dot com
17 years ago
<?php
// How to simulate named parameters in PHP.
// By Dave Benjamin <dave@ovumdesign.com>

// Turns the array returned by func_get_args() into an array of name/value
// pairs that can be processed by extract().
function varargs($args) {
   
$count = count($args);
    for (
$i = 0; $i < $count; $i += 2) {
       
$result[$args[$i]] = $args[$i + 1];
    }
   
    return
$result;
}

// Example
function test(&$ref1, &$ref2) {
   
// Default arguments go here.
   
$foo = "oof";
   
   
// Do some magic.
   
extract(varargs(func_get_args()));

    echo
nl2br("\n\$var1 = $var1");
    echo
nl2br("\n\$var2 = $var2");
    echo
nl2br("\n\$foo = $foo\n\n");
   
   
// Modify some variables that were passed by reference.
    // Note that func_get_args() doesn't pass references, so they
    // need to be explicitly declared in the function definition.
   
$ref1 = 42;
   
$ref2 = 84;
}

$a = 5;
$b = 6;

echo
nl2br("Before calling test(): \$a = $a\n");
echo
nl2br("Before calling test(): \$b = $b\n");

// Try removing the 'foo, "bar"' from the following line.
test($a, $b, var1, "abc", var2, "def", foo, "bar");

echo
nl2br("After calling test(): \$a = $a\n");
echo
nl2br("After calling test(): \$b = $b\n");
?>
up
0
Anonymous
18 years ago
You can pass a variable number of arguments to a function whilst keeping references intact by using an array. The disadvantage of course, is that the called function needs to be aware that it's arguments are in an array.

<?php
// Prints "hello mutated world"
function mutator($args=null) {
$n=count($args);
while(
$i<$n) $args[$i++] = "mutated";
}
$a = "hello";
$b = "strange";
$c = "world";
mutator(array($a, &$b, $c));
echo
"$a $b $c";
?>
up
-3
maarten at ba dot be
6 years ago
it seems that this function only returns a copy and loses it's byref information, use this dirty non-efficient workaround instead:

at the moment of writing it currently returns all of them as references, instead of only the ones who are passed that way...

<?php
function func_get_args_byref() {
       
$trace = debug_backtrace();
        return
$trace[1]['args'];
}
?>
To Top