CKTIS / PHP
Referenzparameter (`&$list`)
Ein `&` vor `$list` erlaubt einer PHP-Funktion, die Variable des Aufrufers zu ändern. Das Zeichen steht in der Parameterdeklaration, nicht vor dem Argument beim Aufruf.
Version: PHP 8.3
Syntax
<?php
function appendItem(array &$list, string $item): void
{
$list[] = $item;
}
$items = ['apple'];
appendItem($items, 'pear');In PHP 8.3 kennzeichnet &$list einen Parameter, der per Referenz übergeben wird. Beim Aufruf appendItem($items, 'pear') wird der lokale Name $list zu einem Alias für denselben Inhalt wie $items. Eine PHP-Referenz ist kein Zeiger auf eine Speicheradresse. $list ist ein gewöhnlicher Parametername und hat nichts mit dem Sprachkonstrukt list() zur Destrukturierung zu tun.
Die Referenzsyntax, die Array-Operationen und implode() im Beispiel benötigen keine optionalen PHP-Erweiterungen.
Schreibe & in der Deklaration vor den Parameternamen, nicht vor das Argument im Aufruf. Übergib eine Variable wie $items; ein Literal wie ['apple'] ist als Referenzargument ein Fehler. Auch ein per Referenz zurückgegebener Wert ist zulässig. Die Übergabe per Referenz bedeutet nicht, dass die Funktion per Referenz zurückgibt.
$list[] = $item hängt ein Element an das Array des Aufrufers an; $list = [] würde das ganze Array ersetzen. Diese Änderungen bleiben nach dem Aufruf sichtbar. Dagegen löst unset($list) in der Funktion nur die lokale Bindung und entfernt nicht $items. Ohne & erfolgt die Übergabe standardmäßig per Wert, sodass das gezeigte Anhängen $items nicht ändern würde.
Bei array &$list prüft PHP den Typ array beim Eintritt in die Funktion, nicht bei der Rückkehr. Enthält die übergebene Variable eine Ganzzahl, tritt ein TypeError auf. void beschreibt den Rückgabewert, nicht die Änderung des Arguments. Verwende eine Referenz für beabsichtigte Änderungen an der Variablen des Aufrufers und dokumentiere diesen Seiteneffekt, da er am Aufruf nicht erkennbar ist.
Beispiele
<?php
function appendItem(array &$list, string $item): void
{
$list[] = $item;
}
$items = ['apple'];
appendItem($items, 'pear');
echo implode(', ', $items), "\n";
Ergebnis
apple, pear
Nach `appendItem()` gibt das Skript `$items` aus, nicht den Rückgabewert der Funktion. Erwartet wird die Zeile `apple, pear`. Entferne zum Vergleich nur `&` aus der Parameterdeklaration: Dann wird die Zeile `apple` erwartet.
Zugehörige Lektionen
- PHP · Lektion 20 · Mittlere Stufe · Version: 3