func_get_arg

func_get_arg -- Return an item from the argument list.

Description

int func_get_arg(int arg_num);

Returns the argument which is at the arg_num'th offset into a user-defined function's argument list. Function arguments are counted starting from zero. func_get_arg() will generate a warning if called from outside of a function definition.

If arg_num is greater than the number of arguments actually passed, a warning will be generated and func_get_arg() will return FALSE.

  1 
  2 <?php
  3 function foo() {
  4      $numargs = func_num_args();
  5      echo "Number of arguments: $numargs<br>\n";
  6      if ($numargs >= 2) {
  7          echo "Second argument is: " . func_get_arg (1) . "<br>\n";
  8      }
  9 } 
 10 
 11 foo (1, 2, 3);
 12 ?>
 13       

func_get_arg() may be used in conjunction with func_num_args() and func_get_args() to allow user-defined functions to accept variable-length argument lists.

Note: This function was added in PHP 4.