php-doc-en/reference/funchand/functions/func-get-arg.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/funchand.xml, last change in rev 1.1 -->
  <refentry id="function.func-get-arg">
   <refnamediv>
    <refname>func_get_arg</refname>
    <refpurpose>Return an item from the argument list</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>mixed</type><methodname>func_get_arg</methodname>
      <methodparam><type>int</type><parameter>arg_num</parameter></methodparam>
     </methodsynopsis>
    <simpara>
     Returns the argument which is at the
     <parameter>arg_num</parameter>'th offset into a user-defined
     function's argument list. Function arguments are counted starting
     from zero. <function>func_get_arg</function> will generate a
     warning if called from outside of a function definition.
     This function cannot be used directly as a function parameter. Instead,
     its result may be assigned to a variable, which can then be passed to
     the function.
    </simpara>
    <simpara>
     If <parameter>arg_num</parameter> is greater than the number of
     arguments actually passed, a warning will be generated and
     <function>func_get_arg</function> will return &false;.
    </simpara>

    &note.funcnoparam;

    <para>
     <informalexample>
      <programlisting role="php">
<![CDATA[
<?php
function foo() 
{
     $numargs = func_num_args();
     echo "Number of arguments: $numargs<br />\n";
     if ($numargs >= 2) {
     echo "Second argument is: " . func_get_arg(1) . "<br />\n";
     }
} 

foo (1, 2, 3);
?>
]]>
      </programlisting>
     </informalexample>
    </para>
    <simpara>
     <function>func_get_arg</function> may be used in conjunction with
     <function>func_num_args</function> and
     <function>func_get_args</function> to allow user-defined
     functions to accept variable-length argument lists.
    </simpara>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->