CKTIS / PHP
Paramètre passé par référence `&$res`
Le signe `&` devant `$res` permet à une fonction de modifier la variable fournie par le code appelant au lieu de renvoyer une nouvelle valeur.
Version : PHP 8.3; extension availability may vary
Syntaxe
function writeSum(int $left, int $right, int &$res): void { /* ... */ }
$total = 0;
writeSum(2, 3, $total);Dans une signature de fonction, &$res indique un paramètre passé par référence. Pendant l’appel, le nom local $res est un alias de la variable du code appelant. Contrairement au passage par valeur habituel, une affectation à $res modifie cette variable. res est un nom ordinaire, pas un mot-clé ; ici, & n’indique ni un pointeur ni un retour par référence.
Écrivez & dans la déclaration, pas dans l’appel : writeSum(2, 3, $total). Pour l’argument passé par référence, utilisez une variable, et non un littéral comme 0 ou une expression calculée comme 2 + 3. Il est aussi possible de passer une référence renvoyée par une fonction déclarée pour renvoyer par référence.
En PHP 8.3, le type dans int &$res est vérifié à l’entrée de la fonction, mais pas à sa sortie. La déclaration seule ne garantit donc pas que la variable contiendra encore un int après l’appel. Dans la fonction, unset($res) supprime seulement la liaison locale, pas la variable du code appelant.
Documentez les arguments que la fonction peut écraser. S’il suffit de produire un seul résultat sans modifier la variable du code appelant, un return ordinaire est généralement plus clair. Cette syntaxe fait partie du langage PHP et ne nécessite aucune extension supplémentaire.
Exemples
<?php
declare(strict_types=1);
function writeSum(int $left, int $right, int &$res): void
{
$res = $left + $right;
}
$total = 0;
echo "before: ", $total, "\n";
writeSum(2, 3, $total);
echo "after: ", $total, "\n";
Résultat
before: 0 after: 5
Au départ, `$total` vaut `0`. L’affectation via `$res` le fait passer à `5`, même si `writeSum()` a le type de retour `void` et ne renvoie aucun résultat.
Leçons associées
- PHP · Leçon 70 · Avancé · Version : 2