func_get_arg
(PHP 4, PHP 5)
func_get_arg — 引数のリストから要素をひとつ返す
説明
ユーザが定義した関数の引数リストから、指定した引数を取得します。
この関数は、 func_num_args()および func_get_args()と組み合わせて使用され、これにより ユーザ定義の関数が可変長の引数リストをとることができるようになります。
パラメータ
- arg_num
-
引数の位置。関数の引数はゼロから数え始めます。
返り値
指定した引数、あるいはエラー時に FALSE を返します。
変更履歴
| バージョン | 説明 |
|---|---|
| 5.3.0 | この関数はパラメータリスト内で使用できるようになりました。 |
エラー / 例外
ユーザ定義関数の外部からコールされた場合、あるいは arg_num が実際に渡された引数の数より多い場合に警告を発生します。
例
例1 func_get_arg() の例
<?php
function foo()
{
$numargs = func_num_args();
echo "Number of arguments: $numargs<br />\n";
if ($numargs >= 2) {
echo "二番目の引数は " . func_get_arg(1) . " です。<br />\n";
}
}
foo (1, 2, 3);
?>
注意
注意: この関数は、 カレントスコープに依存してパラメータの詳細を決定しますので、 関数パラメータとして使用することはできません。 もし、この値を渡さなければならない場合、戻り値を変数に割り当て、 その変数を渡してください。
注意: この関数は、渡された引数のみのコピーを返します。 デフォルトの (渡されていない) 引数については感知しません。