Returns an array comprising a function's argument list

Descrierea

func_get_args ( void ) : array

Gets an array of the function's argument list.

This function may be used in conjunction with func_get_arg() and func_num_args() to allow user-defined functions to accept variable-length argument lists.

Valorile întoarse

Returns an array in which each element is a copy of the corresponding member of the current user-defined function's argument list.

Istoricul schimbărilor

Versiune	Descriere
5.3.0	This function can now be used in parameter lists.
5.3.0	If this function is called from the outermost scope of a file which has been included by calling include or require from within a function in the calling file, it now generates a warning and returns `FALSE`.

Erori/Excepții

Generates a warning if called from outside of a user-defined function.

Exemple

Example #1 func_get_args() example


<?php
function foo()
{
    $numargs = func_num_args();
    echo "Number of arguments: $numargs \n";
    if ($numargs >= 2) {
        echo "Second argument is: " . func_get_arg(1) . "\n";
    }
    $arg_list = func_get_args();
    for ($i = 0; $i < $numargs; $i++) {
        echo "Argument $i is: " . $arg_list[$i] . "\n";
    }
}

foo(1, 2, 3);
?>

Exemplul de mai sus va afișa:

Number of arguments: 3 
Second argument is: 2
Argument 0 is: 1
Argument 1 is: 2
Argument 2 is: 3

Example #2 func_get_args() example before and after PHP 5.3


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

foo('First arg', 'Second arg');
?>

fga.inc
<?php

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

?>

Output previous to PHP 5.3:

array (
  0 => 'First arg',
  1 => 'Second arg',
)

Output in PHP 5.3 and later:

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

Example #3 func_get_args() example of byref and byval arguments


<?php
function byVal($arg) {
    echo 'As passed     : ', var_export(func_get_args()), PHP_EOL;
    $arg = 'baz';
    echo 'After change  : ', var_export(func_get_args()), PHP_EOL;
}

function byRef(&$arg) {
    echo 'As passed     : ', var_export(func_get_args()), PHP_EOL;
    $arg = 'baz';
    echo 'After change  : ', var_export(func_get_args()), PHP_EOL;
}

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

Exemplul de mai sus va afișa în PHP 7:

As passed : array (
0 => 'bar',
)
After change : array (
0 => 'baz',
)
As passed : array (
0 => 'bar',
)
After change : array (
0 => 'baz',
)

Exemplul de mai sus va afișa în PHP 5:

As passed : array (
0 => 'bar',
)
After change : array (
0 => 'bar',
)
As passed : array (
0 => 'bar',
)
After change : array (
0 => 'baz',
)

Note

Notă:
Deoarece această funcție își determină detaliile parametrilor în dependență de circumstanță, ea nu poate fi utilizată în calitate de parametru-funcție în versiunile anterioare 5.3.0. Dacă trebuie transmisă această valoare, atunci rezultatele trebuie atribuite unei variabile, și această variabilă trebuie transmisă.

Notă:
Dacă argumentele sunt transmise prin referință atunci orice schimbare a lor va fi reflectată în valorile întoarse de această funcție. Începând cu PHP 7 valorile curente vor fi întoarse de asemenea și atunci când argumentele sunt transmise prin valoare.

Notă: This function returns a copy of the passed arguments only, and does not account for default (non-passed) arguments.

func_get_args