Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / PHP

Paramètre passé par référence (&$users)

Le signe `&` devant le paramètre `$users` permet à la fonction de modifier la variable de l’appelant sans renvoyer le tableau. À l’appel, la variable s’écrit sans `&`.

Version : PHP 8.3; extension availability may vary

Syntaxe

function addUser(array &$users, string $name): void { $users[] = $name; }
$users = ['Ada'];
addUser($users, 'Lin');

Dans array &$users, array indique le type de l’argument et & marque le passage par référence. Le paramètre local et la variable de l’appelant sont deux noms pour la même valeur. Ici, & ne désigne ni un pointeur ni un opérateur ET bit à bit, et la fonction ne renvoie pas de référence.

Appelez addUser($users, 'Lin') sans & et passez une variable initialisée. Une référence renvoyée par une fonction est également valide, mais pas un tableau littéral : addUser(['Ada'], 'Lin') déclenche une Error. PHP vérifie le type array à l’entrée de la fonction, pas à sa sortie. Passer une variable contenant une chaîne déclenche une TypeError.

$users[] = $name ajoute un élément, tandis qu’une affectation ordinaire comme $users = [] remplacerait toute la valeur de la variable de l’appelant. La modification reste visible après l’appel, même si la fonction ne renvoie aucune valeur (void). Sans &, le tableau est passé par valeur par défaut et l’ajout ne modifie que le tableau local dans cet exemple.

Utilisez & lorsque la modification de la variable de l’appelant est voulue et documentez cet effet, car il n’est pas visible à l’appel. Si l’appelant doit choisir de remplacer ou non son tableau, recevez-le par valeur et renvoyez le tableau modifié.

Exemples

<?php
function addUser(array &$users, string $name): void
{
    $users[] = $name;
}

$users = ['Ada'];
echo implode(', ', $users), "\n";
addUser($users, 'Lin');
echo implode(', ', $users), "\n";

Résultat

Ada
Ada, Lin

L’exemple utilise PHP 8.3 en ligne de commande, sans extension optionnelle. Le résultat attendu est `Ada` avant l’appel et `Ada, Lin` après. Si vous retirez uniquement `&` de la déclaration, les deux lignes doivent afficher `Ada`.

Leçons associées

  • PHP · Leçon 28 · Intermédiaire · Version : 3

Sources