php-doc-en/reference/funchand/functions/func-num-args.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.func-num-args" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>func_num_args</refname>
  <refpurpose>Returns the number of arguments passed to the function</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>func_num_args</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Gets the number of arguments passed to the function.
  </para>
  <para>
   This function may be used in conjunction with 
   <function>func_get_arg</function> and <function>func_get_args</function>
   to allow user-defined functions to accept variable-length argument lists.
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the number of arguments passed into the current user-defined
   function.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.3.0</entry>
       <entry>
        This function can now be used in parameter lists.
       </entry>
      </row>
      <row>
       <entry>5.3.0</entry>
       <entry>
        If this function is called from the outermost scope of a file
        which has been included by calling <link linkend="function.include"><literal>include</literal></link>
        or <link linkend="function.require"><literal>require</literal></link> from within a function in the
        calling file, it now generates a warning and returns -1.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Generates a warning if called from outside of a user-defined function.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>func_num_args</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
function foo()
{
    $numargs = func_num_args();
    echo "Number of arguments: $numargs\n";
}

foo(1, 2, 3);   
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Number of arguments: 3
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title><function>func_num_args</function> example before and
    after PHP 5.3</title>
    <programlisting role="php">
<![CDATA[
test.php
<?php
function foo() {
    include './fna.php';
}

foo('First arg', 'Second arg');
?>

fna.php
<?php

$num_args = func_num_args();
var_export($num_args);

?>
]]>
    </programlisting>
    <para>
     Output previous to PHP 5.3:
    </para>
    <screen>
<![CDATA[
2
]]>
    </screen>
    <para>
     Output in PHP 5.3 and later will be something similar to:
    </para>
    <screen>
<![CDATA[
Warning: func_num_args():  Called from the global scope - no function
context in /home/torben/Desktop/code/ml/fna.php on line 3
-1
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.funcnoparam;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>func_get_arg</function></member>
    <member><function>func_get_args</function></member>
    <member><methodname>ReflectionFunctionAbstract::getNumberOfParameters</methodname></member>
   </simplelist>
  </para>
 </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:"~/.phpdoc/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
-->