(PHP 4, PHP 5, PHP 7, PHP 8)
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.
positionThe argument offset. Function arguments are counted starting from zero.
Returns the specified argument, or false on error.
Generates a warning if called from outside of a user-defined function, or
if position is greater than the number of arguments
actually passed.
Приклад #1 func_get_arg() 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";
}
}
foo(1, 2, 3);
?>Поданий вище приклад виведе:
Number of arguments: 3 Second argument is: 2
Приклад #2 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);
?>Поданий вище приклад виведе:
Зауваження:
Починаючи з PHP 8.0.0, сімейство функцій func_*() стало більш прозорим щодо названих параметрів, обробляючи їх так, ніби всі передані позиційно, а пропущеним аргументам призначаються стандартні значення. Ця функція ігнорує набір невідомих названих варіативних параметрів. Набір невідомих названих параметрів доступний через варіативний параметр.
Зауваження:
Якщо параметри передаються за посиланням, то будь-які зміни їхніх значень буде відображено у значеннях, які повертає ця функція. Починаючи з PHP 7, поточні значення також буде повернено, якщо параметри передано за значенням.
Зауваження: This function returns a copy of the passed arguments only, and does not account for default (non-passed) arguments.
... syntax