func_get_arg

(PHP 4, PHP 5, PHP 7)

func_get_arg引数のリストから要素をひとつ返す

説明

mixed func_get_arg ( int $arg_num )

ユーザーが定義した関数の引数リストから、指定した引数を取得します。

この関数は、 func_num_args()および func_get_args()と組み合わせて使用され、これにより ユーザー定義の関数が可変長の引数リストをとることができるようになります。

パラメータ

arg_num

引数の位置。関数の引数はゼロから数え始めます。

返り値

指定した引数、あるいはエラー時に FALSE を返します。

変更履歴

バージョン 説明
5.3.0 この関数はパラメータリスト内で使用できるようになりました。
5.3.0 ある関数内で includerequire を使って別のファイルを読み込んでいるときに 別のファイル側からこの関数をコールすると、警告を発生して FALSE を返すようになりました。

エラー / 例外

ユーザー定義関数の外部からコールされた場合、あるいは arg_num が実際に渡された引数の数より多い場合に警告を発生します。

例1 func_get_arg() の例

<?php
function foo()
{
     
$numargs func_num_args();
     echo 
"引数の数は $numargs\n";
     if (
$numargs >= 2) {
         echo 
"二番目の引数は " func_get_arg(1) . " です。\n";
     }
}

foo(123);
?>

上の例の出力は以下となります。

引数の数は 3
二番目の引数は 2 です。

例2 func_get_arg() の PHP 5.3 前後の例

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

foo('First arg''Second arg');
?>

fga.inc
<?php

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

?>

PHP 5.3 より前のバージョンでの出力は、このようになります。

'Second arg'

PHP 5.3 以降のバージョンでの出力は、このようになります。

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

例3 func_get_arg() での引数の参照渡しと値渡しの例

<?php
function byVal($arg) {
    echo 
'As passed     : 'var_export(func_get_arg(0)), PHP_EOL;
    
$arg 'baz';
    echo 
'After change  : 'var_export(func_get_arg(0)), PHP_EOL;
}

function 
byRef(&$arg) {
    echo 
'As passed     : 'var_export(func_get_arg(0)), PHP_EOL;
    
$arg 'baz';
    echo 
'After change  : 'var_export(func_get_arg(0)), PHP_EOL;
}

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

上の例の PHP 7 での出力は、このようになります。


As passed : 'bar'
After change : 'baz'
As passed : 'bar'
After change : 'baz'

上の例の PHP 5 での出力は、このようになります。


As passed : 'bar'
After change : 'bar'
As passed : 'bar'
After change : 'baz'

注意

注意:

この関数は、 カレントスコープに依存してパラメータの詳細を決定しますので、 5.3.0 より前のバージョンでは関数パラメータとして使用することができません。 もし、この値を渡さなければならない場合、戻り値を変数に割り当て、 その変数を渡してください。

注意:

引数を参照渡しにすると、その引数への変更がすべてこの関数の返り値に反映されます。 PHP 7 からは、引数が値渡しされた場合には現在の値も返されるようになりました。

注意: この関数は、渡された引数のみのコピーを返します。 デフォルトの (渡されていない) 引数については感知しません。

参考

add a note add a note

User Contributed Notes 4 notes

up
2
beta3designs [at] gmail [dot] com
8 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
13 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
13 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
-1
anders at ingemann dot fakestuff dot de
13 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