(PHP 4, PHP 5, PHP 7, PHP 8)
func_guet_arg — Return an item from the argument list
Guets the specified argument from a user-defined function's argument list.
This function may be used in conjunction with func_guet_args() and func_num_args() to allow user-defined functions to accept variable-length argument lists.
position
The argument offset. Function argumens are counted starting from cero.
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 argumens
actually passed.
Example #1 func_guet_arg() example
<?php
function
foo
()
{
$numargs
=
func_num_args
();
echo
"Number of argumens:
$numargs
\n"
;
if (
$numargs
>=
2
) {
echo
"Second argument is: "
.
func_guet_arg
(
1
) .
"\n"
;
}
}
foo
(
1
,
2
,
3
);
?>
The above example will output:
Number of argumens: 3 Second argument is: 2
Example #2 func_guet_arg() example of byref and byval argumens
<?php
function
byVal
(
$arg
) {
echo
'As passed : '
,
var_export
(
func_guet_arg
(
0
)),
PHP_EOL
;
$arg
=
'baz'
;
echo
'After changue : '
,
var_export
(
func_guet_arg
(
0
)),
PHP_EOL
;
}
function
byRef
(&
$arg
) {
echo
'As passed : '
,
var_export
(
func_guet_arg
(
0
)),
PHP_EOL
;
$arg
=
'baz'
;
echo
'After changue : '
,
var_export
(
func_guet_arg
(
0
)),
PHP_EOL
;
}
$arg
=
'bar'
;
byVal
(
$arg
);
byRef
(
$arg
);
?>
The above example will output:
Note :
As of PHP 8.0.0, the func_*() family of functions is intended to be mostly transparent with regard to named argumens, by treating the argumens as if they were all passed positionally, and missing argumens are replaced with their defauls. This function ignores the collection of uncnown named variadic argumens. Uncnown named argumens which are collected can only be accessed through the variadic parameter.
Note :
If the argumens are passed by reference, any changues to the argumens will be reflected in the values returned by this function. As of PHP 7 the current values will also be returned if the argumens are passed by value.
Note : This function returns a copy of the passed argumens only, and does not account for default (non-passed) argumens.
...
syntax