func_get_arg

(PHP 4, PHP 5, PHP 7)

func_get_argZwraca element z listy argumentów

Opis

func_get_arg ( int $arg_num ) : mixed

Pobiera podany element z listy argumentów funkcji zdefiniowanej przez użytkownika.

Ta funkcja może być użyta w połączeniu z func_get_args() i func_num_args(), aby funkcje zdefiniowane przez użytkownika mogły przyjmować zmienną ilość argumentów.

Parametry

arg_num

Pozycja argumentu. Argumenty funkcji są liczone poczynając od zera.

Zwracane wartości

Zwraca określony argument lub FALSE w wypadku błędu.

Rejestr zmian

Wersja Opis
5.3.0 Ta funkcja może być teraz użyta w listach parametrów.
5.3.0 Jeśli ta funkcja jest wywoływana z najbardziej zewnętrznego zasięgu pliku dołączonego przez wywołanie include lub require wewnątrz funkcji w wykonującym pliku, generuje teraz ostrzeżenie i zwraca FALSE

Błędy/Wyjątki

Generuje ostrzeżenie jeżeli wywołanie nastąpiło z zewnątrz funkcji zdefiniowanej przez użytkownika lub jeżeli arg_num jest większa od rzeczywistej liczby przekazanych parametrów.

Przykłady

Przykład #1 Przykład użycia func_get_arg()

<?php
function foo()
{
     
$numargs func_num_args();
     echo 
"Liczba argumentów: $numargs\n";
     if (
$numargs >= 2) {
         echo 
"Drugi argument: " func_get_arg(1) . "\n";
     }
}

foo(123);
?>

Powyższy przykład wyświetli:

Liczba argumentów: 3
Drugi argument: 2

Przykład #2 Przykład func_get_arg() przed i po PHP 5.3

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

foo('Pierwszy argument''Drugi argument');
?>

fga.inc
<?php

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

?>

Wynik przed PHP 5.3:

'Drugi argument'

Wynik w PHP 5.3 i późniejszych:

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

Przykład #3 Przykład func_get_arg() z argumentami przez referencję

<?php
function byVal($arg) {
    echo 
'Przekazno     : 'var_export(func_get_arg(0)), PHP_EOL;
    
$arg 'baz';
    echo 
'Po zmianie    : 'var_export(func_get_arg(0)), PHP_EOL;
}

function 
byRef(&$arg) {
    echo 
'Przekazano     : 'var_export(func_get_arg(0)), PHP_EOL;
    
$arg 'baz';
    echo 
'Po zmianie     : 'var_export(func_get_arg(0)), PHP_EOL;
}

$arg 'bar';
byVal($arg);
byRef($arg);
?>

Powyższy przykład w PHP 7 wyświetli:


Przekazano : 'bar'
Po zmianie : 'baz'
Przekazano : 'bar'
Po zmianie : 'baz'

Powyższy przykład w PHP 5 wyświetli:


Przekazano : 'bar'
Po zmianie : 'bar'
Przekazano : 'bar'
Po zmianie : 'baz'

Notatki

Informacja:

Jako że działanie tej funkcji zależy od aktualnego zasięgu, nie może ona być użyta jako parametr funkcji w wersjach przed PHP 5.3.0. Jeśli konieczne jest przekazanie tej wartości, należy przypisać wynik działania tej funkcji do zmiennej, a następnie przekazać tę zmienną jako parametr.

Informacja:

Jeśli argumenty są przekazane przez referencję, wszystkie zmiany na argumentach będą miały odzwierciedlenie w wartościach zwracanych przez tę funkcję. Od PHP 7 aktualne wartości zostaną zwrócone także jeśli argumenty są przekazane poprzez wartość.

Informacja: Ta funkcja zwraca tylko kopię przekzanyych argumentów i nie bierze pod uwagę argumentów domyślnych, które nie zostały przekazane.

add a note add a note

User Contributed Notes 4 notes

up
6
beta3designs [at] gmail [dot] com
10 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
0
mightye (at) mightye (dot) org
16 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
-2
mw atto lanfear dotto com
15 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.
up
-2
anders at ingemann dot fakestuff dot de
15 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.
To Top