PHPのお勉強！

PHP TOP
PHP 8.4.2 Released!

    func_get_arg

    (PHP 4, PHP 5, PHP 7, PHP 8)

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

    説明

    func_get_arg(int $position): mixed

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

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

    パラメータ

    position

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

    戻り値

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

    エラー / 例外

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

    例

    例1 func_get_arg() の例

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

    foo(1, 2, 3);
    ?>

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

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

    例2 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);
    ?>

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


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

    注意

    注意:

    PHP 8.0.0 以降における func_*() 関数ファミリは、名前付き引数に関しては、ほぼ透過的に動作するはずです。つまり、渡された全ての引数は位置を指定したかのように扱われ、引数が指定されない場合は、デフォルト値で置き換えられるということです。 この関数は、未知の名前付きの可変長引数を無視します。 未知の名前付き引数は、可変長引数を通じてのみアクセスできます。

    注意:

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

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

    参考

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 5 notes

    up
    8
    beta3designs [at] gmail [dot] com
    15 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
    gordon at abetz-rouse dot com dot au
    4 years ago
    This function may work differently from php5 to php7, in the latter it seems to reference the variable, while in php5 it returns the original argument.
    I have confirmed with the versions below, but this will require further confirmation as to whether this is a 5 versus 7 issue.

    function test( $test ){

    $test = '123';

    echo func_get_arg(0);

    }

    test( '321' );

    //in php 5.5.9, this script will write '321'
    //in php 7.0.33, this script will write '123'
    up
    0
    mightye (at) mightye (dot) org
    20 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
    -3
    anders at ingemann dot fakestuff dot de
    20 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
    -5
    mw atto lanfear dotto com
    20 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.
    ＋add a note
    To Top