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

CKTIS / PHP

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

Placer `&` devant `$list` permet à une fonction PHP de modifier la variable de l’appelant. Le signe figure dans la déclaration du paramètre, pas devant l’argument lors de l’appel.

Version : PHP 8.3

Syntaxe

<?php
function appendItem(array &$list, string $item): void
{
    $list[] = $item;
}

$items = ['apple'];
appendItem($items, 'pear');

En PHP 8.3, &$list déclare un paramètre passé par référence. Lors de l’appel appendItem($items, 'pear'), le nom local $list devient un alias du même contenu que $items. Une référence PHP n’est pas un pointeur vers une adresse mémoire. $list est un simple nom de paramètre, sans rapport avec la construction list() utilisée pour la déstructuration.

La syntaxe des références, les opérations sur les tableaux et la fonction implode() utilisées dans l’exemple ne nécessitent aucune extension PHP facultative.

Écrivez & devant le nom du paramètre dans sa déclaration, pas devant l’argument lors de l’appel. Passez une variable comme $items : un littéral tel que ['apple'] provoque une erreur s’il est passé à ce paramètre. Un résultat renvoyé par référence est également accepté. Recevoir un argument par référence n’implique pas de renvoyer un résultat par référence.

$list[] = $item ajoute un élément au tableau de l’appelant, tandis que $list = [] remplacerait tout le tableau. Ces modifications restent visibles après l’appel. En revanche, unset($list) dans la fonction supprime seulement la liaison locale, pas $items. Sans &, le passage se fait par valeur par défaut : l’ajout de l’exemple ne modifierait donc pas $items.

Dans array &$list, PHP vérifie le type array à l’entrée de la fonction, pas à sa sortie. Si la variable passée contient un entier, PHP lève une TypeError. void concerne la valeur de retour, pas la modification de l’argument. Utilisez une référence si la modification de la variable de l’appelant est voulue et documentez cet effet de bord, car il n’est pas visible dans l’appel.

Exemples

<?php
function appendItem(array &$list, string $item): void
{
    $list[] = $item;
}

$items = ['apple'];
appendItem($items, 'pear');
echo implode(', ', $items), "\n";

Résultat

apple, pear

Après l’appel à `appendItem()`, le script affiche `$items`, pas une valeur de retour. La ligne attendue est `apple, pear`. Pour comparer, retirez seulement `&` de la déclaration du paramètre : la ligne attendue devient `apple`.

Leçons associées

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

Sources