func_get_arg

(PHP 4, PHP 5)

func_get_argLiefert ein bestimmtes Funktionsargument

Beschreibung

mixed func_get_arg ( int $arg_num )

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(123);
?>

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:


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.

add a note add a note

User Contributed Notes 4 notes

up
2
beta3designs [at] gmail [dot] com
6 years ago
This functions seems so powerful... just when i saw it i thought about writing a fast average of n numbers function so here it is, it is very simple... example usage included.

<?php

//Calculate the average of the numbers given

function avg(){
   
$sum = 0;
    for(
$i = 0; $i < func_num_args(); $i++){
       
$sum += func_get_arg($i);
    }
   
$avg = $sum / func_num_args();
    return
$avg;
}

echo
sprintf("%.2f",avg(2,1,2,1,3,4,5,1,3,6));
?>
up
1
anders at ingemann dot fakestuff dot de
11 years ago
I actually think that there is need for such "do absolutely everything" functions. I use them mostly as tools for rapid prototyping.
And there is a method with which you may be able to pass several strings to a function: ereg();
Another use for such functions is to create little code snippets for other people out there. They won't have to edit the function any longer if they do not use a parameter. They just don't name it when calling the function.
This results in allrounder functions that are very robust in their use.Normally you just have a little code snippet (e.g. ip-blocking snippets). Through this type of programming you have whole functions.
up
-1
mightye (at) mightye (dot) org
11 years ago
func_get_arg() returns a *copy* of the argument, to my knowledge there is no way to retrieve references to a variable number of arguments.

I have a module system in my game at http://lotgd.net where I'd like to be able to pass a variable number of arguments to functions in a module, and pass them by reference if the module asks for it by reference, but you can't accept optional parameters as references, nor can you retrieve the reference on a variable number of arguments.  Looks like my modules will have to do with out the ability to accept parameters to their functions by reference.
up
-1
mw atto lanfear dotto com
10 years ago
func_get_arg() does not appear to be allowed to be used as a function argument itself within class constructors in PHP 5.0.2 (wonk-ay!!!):

<?php

class ABC
{
    function
__construct()
    {
        foreach (
func_get_args() as $name => $value)
        {
    echo <<<EOT
    <br/>
   
$name : $value <br/>
    <br/>

EOT;
        }
    }
}

class
DEF extends ABC
{
    function
__construct()
    {
       
parent::__construct(func_get_arg(0),
                                   
func_get_arg(1),
                                   
func_get_arg(2));
    }
}

$def = new DEF(123123, "asdfasdf", "blahblahblah");

?>

The above script generates:

Fatal error: func_get_arg(): Can't be used as a function parameter in c:\Inetpub\wwwroot\phpwasrc\chapter10\xxx.php on line 23

There are, however, no problems when passing these as parameters to regular functions.
To Top