func_get_arg
(PHP 4, PHP 5, PHP 7, PHP 8)
func_get_arg — Liefert ein bestimmtes Funktionsargument
Beschreibung
Gibt das mit position
angegebene Argument aus der
Liste der Argumente einer benutzerdefinierten Funktion zurück.
Diese Funktion kann zusammen mit func_get_args() und func_num_args() genutzt werden, um benutzerdefinierte Funktionen mit einer variablen Anzahl von Argumenten zu implementieren.
Parameter-Liste
-
position
-
Die Position des Arguments. Funktionsargumente werden mit 0 beginnend gezählt.
Rückgabewerte
Gibt das gewünschte Argument zurück oder false
bei Fehlern.
Fehler/Exceptions
Die Funktion generiert eine Warnung, wenn sie außerhalb einer
benutzerdefinierten Funktion aufgerufen wird oder wenn
position
größer ist als die Anzahl der tatsächlich
übergebenen Argumente.
Beispiele
Beispiel #1 func_get_arg()-Beispiel
<?php
function foo()
{
$numargs = func_num_args();
echo "Anzahl der Funktionsargumente: $numargs\n";
if ($numargs >= 2) {
echo "Das zweite Argument ist: " . func_get_arg(1) . "\n";
}
}
foo(1, 2, 3);
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
Anzahl der Funktionsargumente: 3 Das zweite Argument ist: 2
Beispiel #2 func_get_arg()-Beispiel zu byref- und byval-Argumenten
<?php
function byVal($arg) {
echo 'Wie übergeben : ', var_export(func_get_arg(0)), PHP_EOL;
$arg = 'baz';
echo 'Nach Änderung : ', var_export(func_get_arg(0)), PHP_EOL;
}
function byRef(&$arg) {
echo 'Wie übergeben : ', var_export(func_get_arg(0)), PHP_EOL;
$arg = 'baz';
echo 'Nach Änderung : ', var_export(func_get_arg(0)), PHP_EOL;
}
$arg = 'bar';
byVal($arg);
byRef($arg);
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
Wie übergeben : 'bar'
Nach Änderung : 'baz'
Wie übergeben : 'bar'
Nach Änderung : 'baz'
Anmerkungen
Hinweis:
Seit PHP 8.0.0 sollte die func_*()-Familie von Funktionen in Bezug auf benannte Parameter weitgehend transparent sein, indem die Parameter so behandelt werden, als wären sie alle an der richtigen Stelle übergeben worden und fehlende Parameter durch ihre Standardwerte ersetzt. Diese Funktion ignoriert die Erfassung unbekannter benannter variadischer Parameter. Auf unbekannte benannte Parameter, die erfasst werden, kann nur über den variadischen Parameter zugegriffen werden.
Hinweis:
Wenn die Parameter als Referenzen übergeben werden, so finden sich alle Änderungen an diesen Parametern in den Rückgabewerten dieser Funktion wieder.
Hinweis: Diese Funktion gibt nur eine Kopie der übergebenen Argumente zurück und berücksichtigt keine (nicht übergebenen) Standardargumente.