Les fonctions
PHP Manual

Les arguments de fonction

Des informations peuvent être passées à une fonction en utilisant une liste d'arguments, dont chaque expression est séparée par une virgule. Les arguments seront évalués depuis la gauche vers la droite.

PHP supporte le passage d'arguments par valeur (comportement par défaut), le passage par référence, et des valeurs d'arguments par défaut. Une liste variable d'arguments est également supportée.

Exemple #1 Nombre variable d'argument sous forme de tableau

<?php
function takes_array($input)
{
    echo 
"$input[0] + $input[1] = "$input[0]+$input[1];
}

takes_array(array(2,3));
?>

Passage d'arguments par référence

Par défaut, les arguments sont passés à la fonction par valeur (Ainsi changer la valeur d'un argument dans la fonction ne change pas sa valeur à l'extérieur de la fonction). Si vous voulez que vos fonctions puissent changer la valeur des arguments, vous devez passer ces arguments par référence.

Si vous voulez qu'un argument soit toujours passé par référence, vous pouvez ajouter un '&' devant l'argument dans la déclaration de la fonction :

Exemple #2 Passage d'arguments par référence

<?php
function add_some_extra(&$string)
{
    
$string .= ', et un peu plus.';
}
$str 'Ceci est une chaîne';
add_some_extra($str);
echo 
$str;  
?>

Valeur par défaut des arguments

Vous pouvez définir comme en C++ des valeurs par défaut pour les arguments de type scalaire :

Exemple #3 Valeur par défaut des arguments de fonctions

<?php
function servir_cafe ($type "cappuccino")
{
    return 
"Servir un $type.\n";
}
echo 
servir_cafe();
echo 
servir_cafe(null);
echo 
servir_cafe("espresso");
?>

L'exemple ci-dessus va afficher :

Servir un cappuccino.
Servir un.
Servir un espresso.

PHP vous autorise à utiliser des tableau ainsi que le type spécial NULL comme valeur par défaut, par exemple :

Exemple #4 Utilisation de type non scalaire comme valeur par défaut

<?php
function servir_cafe($types = array("cappuccino"), $coffeeMaker NULL)
{
    
$device is_null($coffeeMaker) ? "les mains" $coffeeMaker;
    return 
"Préparation d'une tasse de ".join(", "$types)." avec $device.\n";
}
echo 
servir_cafe();
echo 
servir_cafe(array("cappuccino""lavazza"), "une cafetière");
?>

La valeur par défaut d'un argument doit obligatoirement être une constante, et ne peut être ni une variable, ni un membre de classe, ni un appel de fonction.

Il est à noter que si vous utilisez des arguments avec valeur par défaut avec d'autres sans valeur par défaut, les premiers doivent être placés à la suite de tous les paramètres sans valeur par défaut. Sinon, cela ne fonctionnera pas. Considérons le code suivant :

Exemple #5 Les arguments sans valeur par défaut doivent être en premiers : erreur

<?php
function faireunyaourt ($type "acidophilus"$flavour)
{
    return 
"Préparer un bol de $type $flavour.\n";
}
 
echo 
faireunyaourt("framboise");   // ne fonctionne pas comme voulu
?>

L'exemple ci-dessus va afficher :

Warning: Missing argument 2 in call to makeyogurt() in 
/usr/local/etc/httpd/htdocs/phptest/functest.html on line 41
Préparer un bol de framboise .

Maintenant comparons l'exemple précédent avec l'exemple suivant :

Exemple #6 Les arguments sans valeur par défaut doivent être en premiers : valide

<?php
function faireunyaourt ($flavour$type "acidophilus")
{
    return 
"Préparer un bol de $type $flavour.\n";
}
 
echo 
faireunyaourt ("framboise");   // fonctionne comme voulu
?>

L'exemple ci-dessus va afficher :

Préparer un bol de acidophilus framboise.

Note: Depuis PHP 5, les arguments passés par référence peuvent avoir une valeur par défaut.

Nombre d'arguments variable

PHP supporte les fonctions à nombre d'arguments variable. Ceci est implémenté en utilisant le mot clé ... en PHP 5.6 et suivants, et en utilisant les fonctions func_num_args(), func_get_arg() et func_get_args() en PHP 5.5 et antérieurs.

... en PHP 5.6+

En PHP 5.6 et suivants, la liste des arguments peut inclure le mot clé ... pour indiquer que cette fonction accepte un nombre variable d'arguments. Les arguments seront passés dans la variable fournie sous forme d'un tableau ; par exemple :

Exemple #7 Utilisation de ...

<?php
function sum(...$numbers) {
    
$acc 0;
    foreach (
$numbers as $n) {
        
$acc += $n;
    }
    return 
$acc;
}

echo 
sum(1234);
?>

L'exemple ci-dessus va afficher :

10

Vous pouvez aussi utiliser le mot clé ... lors de l'appel aux fonctions pour extraire le tableau, la variable Traversable ou le litéral dans la liste d'arguments :

Exemple #8 Utilisation de ... pour fournir des arguments

<?php
function add($a$b) {
    return 
$a $b;
}

echo 
add(...[12])."\n";

$a = [12];
echo 
add(...$a);
?>

L'exemple ci-dessus va afficher :

3
3

Vous pouvez spécifier des arguments classiques avant le mot clé .... Dans ce cas, seuls les arguments finaux qui ne correspondent pas à un argument classique seront ajoutés au tableau généré par ....

Il est également possible d'ajouter un transtypage avant le mot clé .... Si ce transtypage est présent, alors tous les arguments capturés par ... seront des objets de la classe visée.

Exemple #9 Transtypage d'arguments variables

<?php
function total_intervals($unitDateInterval ...$intervals) {
    
$time 0;
    foreach (
$intervals as $interval) {
        
$time += $interval->$unit;
    }
    return 
$time;
}

$a = new DateInterval('P1D');
$b = new DateInterval('P2D');
echo 
total_intervals('d'$a$b).' jours';

// Ceci échouera, car null n'est pas un objet DateInterval.
echo total_intervals('d'null);
?>

L'exemple ci-dessus va afficher :

3 jours
Catchable fatal error: Argument 2 passed to total_intervals() must be an instance of DateInterval, null given, called in - on line 14 and defined in - on line 2

Pour finir, vous pouvez passer des arguments variables par référence en préfixant le mot clé ... d'un ET commercial (&).

Les anciennes versions de PHP

Aucune syntaxe spéciale n'est nécessaire pour spécifier qu'une fonction est variable ; cependant, l'accès aux arguments de la fonction nécessite l'utilisation des fonctions func_num_args(), func_get_arg() et func_get_args().

Le premier exemple ci-dessus doit être implémenté comme ceci en PHP 5.5 et antérieurs :

Exemple #10 Accès aux arguments variables en PHP 5.5 et antérieurs

<?php
function sum() {
    
$acc 0;
    foreach (
func_get_args() as $n) {
        
$acc += $n;
    }
    return 
$acc;
}

echo 
sum(1234);
?>

L'exemple ci-dessus va afficher :

10


Les fonctions
PHP Manual