(PHP 4, PHP 5)
func_get_arg — Return an item from the argument list
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.
arg_num
The argument offset. Function arguments are counted starting from zero.
Returns the specified argument, or FALSE on error.
| Wersja | Opis |
|---|---|
| 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.
|
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.
Przykład #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);
?>
Przykład #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
Przykład #3 func_get_arg() example of byref and byval arguments
<?php
function byVal($arg) {
echo 'As passed : ', var_export(func_get_arg(0)), PHP_EOL;
$arg = 'baz';
echo 'After change : ', var_export(func_get_arg(0)), PHP_EOL;
}
function byRef(&$arg) {
echo 'As passed : ', var_export(func_get_arg(0)), PHP_EOL;
$arg = 'baz';
echo 'After change : ', var_export(func_get_arg(0)), PHP_EOL;
}
$arg = 'bar';
byVal($arg);
byRef($arg);
?>
Powyższy przykład wyświetli:
Informacja:
Jako że działanie tej funkcji zależy od aktualnego zasięgu, nie może ona być użyta jako parametr funkcji w wersjach przed PHP 5.3.0. Jeśli konieczne jest przekazanie tej wartości, należy przypisać wynik działania tej funkcji do zmiennej, a następnie przekazać tę zmienną jako parametr.
Informacja:
Jeśli argumenty są przekazane przez referencję, wszystkie zmiany na argumentach będą miały odzwierciedlenie w wartościach zwracanych przez tę funkcję
Informacja: This function returns a copy of the passed arguments only, and does not account for default (non-passed) arguments.