関数に渡された引数を取得 - func_get_arg関数、func_get_args関数

プログラミング言語PHPで、定義済みの関数一覧を連想配列で取得する関数 func_get_arg()、func_get_args()を紹介します。

func_get_arg関数

mixed func_get_arg ( int $arg_num )
指定した引数の値を取得します。

引数
$arg_num
値を取得する引数の番号を指定します。
番号はゼロからはじまります。

返り値
指定した引数の値を返します。
指定した引数の値がおかしい場合（エラーの場合）は、falseを返します。

サンプルコード

hogeという関数に渡された引数の値を取得するサンプルコードです。

func_get_arg( 引数の番号 )

<?php
function hoge() {
  var_dump( func_get_arg(0) );
  var_dump( func_get_arg(1) );
  var_dump( func_get_arg(2) );
  var_dump( func_get_arg(3) );
  var_dump( func_get_arg(4) );
}

hoge(5, 3.14, 'Hello', array('Windows', 'Mac', 'Linux') );
?>

実行結果です。渡した引数（整数型、浮動小数点型、文字列、配列）が取得されています。指定した引数の番号がおかしな場合はエラーなので、falseが返されています。

int(5)
float(3.14)
string(5) "Hello"
array(3) {
  [0]=>
  string(7) "Windows"
  [1]=>
  string(3) "Mac"
  [2]=>
  string(5) "Linux"
}
bool(false)

func_get_args関数

array func_get_args ( void )
関数の引数を配列で取得します。

返り値
関数の引数を配列で返します。

サンプルコード

hogehogeという関数に渡された引数の値を配列で取得するサンプルコードです。

func_get_args()

<?php
function hogehoge() {
  var_dump( func_get_args() );
}

hogehoge(5, 3.14, 'Hello', array('Windows', 'Mac', 'Linux') );
?>

実行結果です。渡した引数（整数型、浮動小数点型、文字列、配列）が配列で取得されています。

array(4) {
  [0]=>
  int(5)
  [1]=>
  float(3.14)
  [2]=>
  string(5) "Hello"
  [3]=>
  array(3) {
    [0]=>
    string(7) "Windows"
    [1]=>
    string(3) "Mac"
    [2]=>
    string(5) "Linux"
  }
}

関数処理 の人気記事

1. PHP関数リファレンス