PHP Manual: func_get_args


Enter the keyword for better results

func_get_args

(PHP 4, PHP 5)

func_get_args -- Returns an array comprising a function's argument list

Description

array func_get_args ( void )

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.

Return Values

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

Errors/Exceptions

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

Examples

Example 1. func_get_args() example

<?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";
    }
    
$arg_list = func_get_args();
    for (
$i = 0; $i < $numargs; $i++) {
        echo
"Argument $i is: " . $arg_list[$i] . "<br />\n";
    }
}

foo(1, 2, 3);
?>

Notes

Note: 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.

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