CKTIS / PHP
Referenzparameter (&$users)
Mit `&` vor dem Parameter `$users` kann die Funktion die Variable des Aufrufers ändern, ohne das Array zurückzugeben. Beim Aufruf steht die Variable ohne `&`.
Version: PHP 8.3; extension availability may vary
Syntax
function addUser(array &$users, string $name): void { $users[] = $name; }
$users = ['Ada'];
addUser($users, 'Lin');In array &$users gibt array den Typ des Arguments an, und & kennzeichnet die Übergabe per Referenz. Der lokale Parameter und die Variable des Aufrufers sind zwei Namen für denselben Wert. & steht hier weder für einen Zeiger noch für bitweises UND, und die Funktion gibt keine Referenz zurück.
Rufe addUser($users, 'Lin') ohne & auf und übergib eine initialisierte Variable. Eine von einer Funktion zurückgegebene Referenz ist ebenfalls zulässig, ein Array-Literal dagegen nicht: addUser(['Ada'], 'Lin') löst einen Error aus. PHP prüft den Typ array beim Eintritt in die Funktion, nicht bei der Rückkehr. Eine Variable mit einer Zeichenkette löst einen TypeError aus.
$users[] = $name hängt ein Element an. Eine gewöhnliche Zuweisung wie $users = [] würde dagegen den gesamten Wert beim Aufrufer ersetzen. Die Änderung bleibt nach dem Aufruf sichtbar, obwohl die Funktion keinen Wert zurückgibt (void). Ohne & wird das Array standardmäßig als Wert übergeben; das Anhängen ändert im Beispiel dann nur das lokale Array.
Verwende &, wenn die Variable des Aufrufers absichtlich geändert werden soll, und dokumentiere diese Wirkung, weil sie am Aufruf nicht erkennbar ist. Soll der Aufrufer selbst entscheiden, ob er sein Array ersetzt, nimm es als Wert entgegen und gib das geänderte Array zurück.
Beispiele
<?php
function addUser(array &$users, string $name): void
{
$users[] = $name;
}
$users = ['Ada'];
echo implode(', ', $users), "\n";
addUser($users, 'Lin');
echo implode(', ', $users), "\n";
Ergebnis
Ada Ada, Lin
Das Beispiel verwendet die PHP-8.3-Kommandozeile und benötigt keine optionalen Erweiterungen. Erwartet werden `Ada` vor dem Aufruf und `Ada, Lin` danach. Entfernst du nur `&` aus der Deklaration, steht in beiden Zeilen `Ada`.
Zugehörige Lektionen
- PHP · Lektion 28 · Mittlere Stufe · Version: 3