Liefert ein bestimmtes Funktionsargument

Beschreibung

func_get_arg ( int $arg_num ) : mixed

Liefert das mit arg_num angegebene Argument aus der Liste der Argumente einer benutzerdefinierten Funktion.

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

arg_num: Der Offset des Arguments. Funktionsargumente werden mit 0 beginnend gezählt.

Rückgabewerte

Liefert das gewünschte Argument oder FALSE bei Fehlern.

Changelog

Version	Beschreibung
5.3.0	Diese Funktion kann nun auch in Parameterlisten genutzt werden.
5.3.0	Wird diese Funktion aus dem äußersten Geltungsbereich einer Datei aufgerufen, die durch den Aufruf von include oder require innerhalb einer Funktion in der aufrufenden Datei inkludiert wurde, wird nun eine Warnung generiert und `FALSE` zurückgegeben.

Fehler/Exceptions

Die Funktion generiert eine Warnung wenn sie außerhalb einer benutzerdefinierten Funktion aufgerufen wird oder wenn arg_num 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 vor and nach PHP 5.3


test.php
<?php
function foo() {
    include './fga.inc';
}

foo('Erstes Argument', 'Zweites Argument');
?>

fga.inc
<?php

$arg = func_get_arg(1);
var_export($arg);

?>

Ausgabe vor PHP 5.3:

'Zweites Argument'

Ausgabe in PHP 5.3 und neuer:

Warning: func_get_arg():  Called from the global scope - no function
context in /home/torben/Desktop/code/ml/fga.inc on line 3
false

Beispiel #3 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 mit PHP 7:

Wie übergeben : 'bar'
Nach Änderung : 'baz'
Wie übergeben : 'bar'
Nach Änderung : 'baz'

Das oben gezeigte Beispiel erzeugt folgende Ausgabe mit PHP 5:

Wie übergeben : 'bar'
Nach Änderung : 'bar'
Wie übergeben : 'bar'
Nach Änderung : 'baz'

Anmerkungen

Hinweis:
Da diese Funktion bei der Ermittlung der Parameterdetails von dem aktuellen Ausführungskontext abhängt, kann sie in PHP-Versionen vor 5.3.0 selbst nicht als Funktionsparameter genutzt werden. Wenn Sie ihre Ergebnisse tatsächlich weitergeben müssen, so müssen Sie diese zunächst einer Variablen zuweisen und dann diese Variable übergeben

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 liefert eine Kopie des übergebenen Arguments. Sie hat nur Zugriff auf tatsächlich übergebene Argumente, Vorgabewerte von Parametern sind für sie nicht sichtbar.

func_get_arg