func_num_args

関数に渡された引数の数を返す

説明

int func_num_args()

関数に渡された引数の数を取得します。

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

パラメータ

この関数にはパラメータはありません。

戻り値

現在のユーザー定義関数に渡された引数の数を返します。

エラー / 例外

ユーザー定義関数の外部からコールされた場合に警告を発生します。

例

例1 func_num_args の例

<?php
function foo()
{
    echo "引数の数: ", func_num_args(), PHP_EOL;
}

foo(1, 2, 3);
?>

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

引数の数: 3

注意

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

参考

... 構文
func_get_arg
func_get_args
ReflectionFunctionAbstract::getNumberOfParameters