func_get_arg
(PHP 4, PHP 5)
func_get_arg — Return an item from the argument list
Description
Gets the specified argument from a user-defined function's argument list.
This function may be used in conjunction with func_get_args() and func_num_args() to allow user-defined functions to accept variable-length argument lists.
Parameters
- arg_num
-
The argument offset. Function arguments are counted starting from zero.
Return Values
Returns the specified argument, or FALSE on error.
Changelog
| Version | Description |
|---|---|
| 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. |
Errors/Exceptions
Generates a warning if called from outside of a user-defined function, or if arg_num is greater than the number of arguments actually passed.
Examples
Example #1 func_get_arg() 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";
}
}
foo (1, 2, 3);
?>
Example #2 func_get_arg() example before and after PHP 5.3
test.php
<?php
function foo() {
include './fga.inc';
}
foo('First arg', 'Second arg');
?>
fga.php
<?php
$arg = func_get_arg(1);
var_export($arg);
?>
Output previous to PHP 5.3:
'Second arg'
Output in PHP 5.3 and later:
Warning: func_get_arg(): Called from the global scope - no function context in /home/torben/Desktop/code/ml/fga.inc on line 3 false
Notes
Note:
Because this function depends on the current scope to determine parameter details, it cannot be used as a function parameter in versions prior to 5.3.0. If this value must be passed, the results should be assigned to a variable, and that variable should be passed.
Note: This function returns a copy of the passed arguments only, and does not account for default (non-passed) arguments.
See Also
- func_get_args() - Returns an array comprising a function's argument list
- func_num_args() - Returns the number of arguments passed to the function