PHP Australia Conference 2015

func_num_args

(PHP 4, PHP 5)

func_num_argsRetourne le nombre d'arguments passés à la fonction

Description

int func_num_args ( void )

Récupère le nombre d'arguments passés à la fonction.

func_get_arg() peut être utilisé conjointement à func_num_args() et func_get_args() pour permettre aux fonctions utilisateurs d'accepter un nombre variable d'arguments.

Valeurs de retour

Retourne le nombre d'arguments passés à la fonction utilisateur courante. function.

Historique

Version Description
5.3.0 Cette fonction peut maintenant être utilisée dans des listes de paramètres.
5.3.0 Si cette fonction est appelée dans un fichier inclus avec include ou require logé dans une fonction, elle génèrera une alerte et retournera -1.

Erreurs / Exceptions

Génère une alerte si elle est appelée hors d'une fonction utilisateur.

Exemples

Exemple #1 Exemple avec func_num_args()

<?php
function foo()
{
    
$numargs func_num_args();
    echo 
"Nombre d'arguments : $numargs\n";
}

foo(123);    // affiche ''
?>

L'exemple ci-dessus va afficher :

Nombre d'arguments: 3

Exemple #2 Exemples func_num_args() avant et après PHP 5.3

test.php
 <?php
 
function foo() {
     include 
'./fna.inc';
 }
 
 
foo('Argument 1''Argument 2');
 
?>
 
 fna.php
 <?php
 
 $num_args 
func_num_args();
 
var_export($num_args);
 
 
?>

Sortie avant PHP 5.3:

 2
 

L'affichage depuis PHP 5.3 ressemble à quelque chose comme :

 Warning: func_num_args():  Called from the global scope - no function
 context in /home/torben/Desktop/code/ml/fna.inc on line 3
 -1
 

Notes

Note:

Parce que cette fonction dépend de la portée courante pour déterminer les détails des paramètres, ils ne peuvent être utilisés en tant que paramètre d'une fonction dans les versions antérieures à 5.3.0. Si vous devez passer cette valeur, assignez les résultats à une variable et utilisez-la.

add a note add a note

User Contributed Notes 6 notes

up
9
jared at ws-db dot com
9 years ago
Just a note for anyone wondering. This function doesn't include params that have a default value, unless you pass one in to overwrite the default param value. Not sure if that makes sense, so here's an example:

<?php
function helloWorld($ArgA, $ArgB="HelloWorld!") {
  return
func_num_args();
}

// The following will return 1
$Returns1 = helloWorld("HelloWorld!");

// The following will return 2
$Returns2 = helloWorld("HelloWorld!", "HowdyWorld!");
?>
up
2
luisguillermo dot quevedovelez at gmail dot com
2 years ago
I had defined a function function_name(){ ...} as a drupal callback.
I try to get how many params where passed

I got a Error and my Site falls down

I've replaced func_get_args() instead func_num_args() and my Site was restored.

I conclude you can not use  func_num_args() in callbacks.

Hope it helps.
up
2
ashley at dcs dot warwick dot ac dot uk
12 years ago
If you want to pass the parameters on intact to another function, use func_get_args and call_user_func_array (careful - this one is only available in recent PHP versions).  For example:

<?php
/* Print an HTML tag.  This accepts a variable number of arguments:
   the first should be the name of the tag, followed by pairs of
   arguments that describe keys and values.  The values are printed
   with surrounding double quote characters.  */
function printTag() {
 
$numArgs = func_num_args();
  if (
$numArgs < 1) die("printTag given no arguments");
 
  echo
"<" . func_get_arg(0);
  for (
$i = 1; $i < $numArgs; $i+=2) {
    echo
" " . func_get_arg($i);
    if (
$i+1 < $numArgs)
      echo
"=\"" . func_get_arg($i+1) . "\"";
  }
  echo
">";
 
}

/* Print an HTML tag with a newline on the end */
function printTagNL() {
 
$args = func_get_args();
 
call_user_func_array("printTag", $args);
  echo
"\n";
}

printTagNL("input", "type", "hidden", "name", "SORTORDER", "value", $columnNo);
?>
up
1
andy at arakka dot co dot th
9 years ago
func_num_args() can be used in conjunction with named arguments, also. For example:

<?php
function DebugShow( $label, $value ) {
  echo
"# " . $label ;
  if (
func_num_args() > 1 ) echo " = " . $value ;
  echo
"<br>";
}
?>
up
1
Dennis Robinson from basnetworks dot net
5 years ago
This function comes in handy, and I believe is the only solution, when you have an optional parameter that can take any type of data.

For example:

<?php

// $data can be of any type, including null
function my_function($name, $data = null)
{
    if (
$data !== null)
    {
       
// Do something with $data
        // If you call my_function('something'), this WILL NOT be reached
        // If you call my_function('something', null), this WILL NOT be reached
   
}
}

?>

The problem with the above function is that you will never be able to use null as the value for $data.  To fix this, use func_num_args() like so:

<?php

// $data can be of any type, including null
function my_function($name, $data = null)
{
    if (
func_num_args() >= 2)
    {
       
// Do something with $data
        // If you call my_function('something'), this WILL NOT be reached
        // If you call my_function('something', null), this WILL be reached
   
}
}

?>

This solution works because func_num_args() reports exactly how many arguments were passed when the function was called.  It does not take into account when default argument values are used.
up
0
thalis at NOSPAMcs dot pitt dot edu
12 years ago
The idea of func_get_args() is to construct functions of variable number of parameters like

<?php
function var_param_func(){
    if(
func_num_args()==0){
       
//do one thing
   
}
    if(
func_num_args()==1)
       
//do another thing
        //get the args with func_get_args()
   
}
}
?>
To Top