func_get_args

(PHP 4, PHP 5)

func_get_argsВозвращает массив, содержащий аргументы функции

Описание

array func_get_args ( void )

Возвращает массив, содержащий аргументы функции.

Эта функция может быть использована совместно с func_num_args() и func_get_arg() для создания функций с переменным количеством аргументов.

Возвращаемые значения

Возвращает массив, в котором каждый элемент является копией соответствующего члена списка аргументов пользовательской функции.

Список изменений

Версия Описание
5.3.0 Эта функция теперь может быть использована в качестве параметра функции.
5.3.0 Если эта функция вызвана в глобальной области видимости файла, подключенного с помощью include или require из функции вызывающего файла, то теперь будет сгенерировано предупреждение и возвращено значение FALSE.

Ошибки

Генерирует предупреждение при вызове вне определения функции.

Примеры

Пример #1 Пример использования func_get_args()

<?php
function foo()
{
    
$numargs func_num_args();
    echo 
"Количество аргументов: $numargs<br />\n";
    if (
$numargs >= 2) {
        echo 
"Второй аргумент: " func_get_arg(1) . "<br />\n";
    }
    
$arg_list func_get_args();
    for (
$i 0$i $numargs$i++) {
        echo 
"Аргумент №$i: " $arg_list[$i] . "<br />\n";
    }
}

foo(123);
?>

Результат выполнения данного примера:

Количество аргументов: 3<br />
Второй аргумент: 2<br />
Аргумент №0: 1<br />
Аргумент №1: 2<br />
Аргумент №2: 3<br />

Пример #2 Использование func_get_args() до и после PHP 5.3

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

foo('Первый аргумент''Второй аргумент');
?>

fga.inc
<?php

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

?>

Вывод до PHP 5.3:

array (
  0 => 'Первый аргумент',
  1 => 'Второй аргумент',
)

Вывод в 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

Пример #3 Пример передачи аргументов по ссылке и по значению с func_get_args()

<?php
function byVal($arg) {
    echo 
'Передан          : 'var_export(func_get_args()), PHP_EOL;
    
$arg 'baz';
    echo 
'После изменения  : 'var_export(func_get_args()), PHP_EOL;
}

function 
byRef(&$arg) {
    echo 
'Передан          : 'var_export(func_get_args()), PHP_EOL;
    
$arg 'baz';
    echo 
'После изменения  : 'var_export(func_get_args()), PHP_EOL;
}

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

Результат выполнения данного примера:


Передан : array (
0 => 'bar',
)
После изменения : array (
0 => 'bar',
)
Передан : array (
0 => 'bar',
)
После изменения : array (
0 => 'baz',
)

Примечания

Замечание:

Так как для определения параметров данной функции необходим контекст выполнения, она не может быть передана в качестве параметра в версиях PHP до 5.3.0. Если функцию все же необходимо передать, то нужно присвоить ее переменной, которую уже можно использовать при передаче.

Замечание:

Если аргументы были переданы по ссылке, то все изменения аргументов будут отражены на возвращаемых функцией значениях.

Замечание: Эта функция возвращает только копии переданных аргументов, и не возвращает значения по умолчанию (непереданных) аргументов.

Смотрите также

Коментарии

Автор:
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";
?>
2001-06-04 10:44:31
http://php5.kiev.ua/manual/ru/function.func-get-args.html
<?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$bvar1"abc"var2"def"foo"bar");

echo 
nl2br("After calling test(): \$a = $a\n");
echo 
nl2br("After calling test(): \$b = $b\n");
?>
2001-09-18 02:29:10
http://php5.kiev.ua/manual/ru/function.func-get-args.html
Автор:
Simple function to calculate average value using dynamic arguments:
<?php
function average(){
    return 
array_sum(func_get_args())/func_num_args();
}
print 
average(10152025); // 17.5
?>
2004-11-04 09:24:33
http://php5.kiev.ua/manual/ru/function.func-get-args.html
"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(123);

?>

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(123);

?>

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

"1, 2, 3"
2007-05-07 17:50:58
http://php5.kiev.ua/manual/ru/function.func-get-args.html
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($t0, - 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'05); // by name with limit
?>
2008-08-27 02:25:58
http://php5.kiev.ua/manual/ru/function.func-get-args.html
<?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>
*/

?>
2009-04-06 06:48:45
http://php5.kiev.ua/manual/ru/function.func-get-args.html
Автор:
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..
2011-12-30 21:54:08
http://php5.kiev.ua/manual/ru/function.func-get-args.html
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'];
}
?>
2012-09-13 14:58:56
http://php5.kiev.ua/manual/ru/function.func-get-args.html
Merge func_get_args() with function defaults
<?php
class utils {
 
/**
   * @param mixed[] $args
   * @param ReflectionMethod $reflectionMethod
   *
   * @return array
   */
 
public static function mergeArgsWithDefaults$argsReflectionMethod $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::mergeArgsWithDefaultsfunc_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"
?>
2016-03-17 20:18:21
http://php5.kiev.ua/manual/ru/function.func-get-args.html

    Поддержать сайт на родительском проекте КГБ