CKTIS / PHP
Referenzparameter (`&$projects`)
Mit `&$projects` kann eine Funktion die übergebene Variable ändern. Das `&` steht in der Parameterdeklaration, nicht im Funktionsaufruf.
Version: PHP 8.3; extension availability may vary
Syntax
function addProject(array &$projects, string $name): void { $projects[] = $name; }
addProject($activeProjects, 'Beacon');In PHP 8.3 deklariert array &$projects einen Referenzparameter. Während des Aufrufs sind $projects in der Funktion und $activeProjects im aufrufenden Code zwei Namen für denselben Inhalt. Sowohl das Anhängen mit $projects[] = $name als auch die Zuweisung eines neuen Arrays an $projects ändert die Variable im aufrufenden Code. Die Änderung bleibt nach dem Aufruf sichtbar; void bedeutet, dass die Funktion keinen Ergebniswert zurückgibt.
Das & steht nur in der Parameterdeklaration. Rufe addProject($activeProjects, 'Beacon') ohne & auf. Übergib eine initialisierte Variable statt eines Array-Literals wie [], das an dieser Stelle einen Fehler verursacht. Eine von einer Funktion zurückgegebene Referenz ist ebenfalls zulässig; ein gewöhnlicher Rückgabewert ist kein Ersatz für eine Variable.
PHP prüft den Typ array beim Eintritt in die Funktion, nicht beim Verlassen. Enthält die initialisierte Variable kein Array, löst der Aufruf einen TypeError aus. Die Parameterdeklaration garantiert aber nicht, dass die Funktion ein Array in der Variablen hinterlässt.
Ohne & wird das Argument standardmäßig als Wert übergeben. Das Anhängen in diesem Beispiel würde dann nur das lokale Array ändern. Nutze eine Referenz, wenn die Änderung der übergebenen Variablen beabsichtigt ist, und dokumentiere diesen Effekt. Soll die Variable unverändert bleiben, übergib das Array als Wert und gib ein aktualisiertes Array zurück.
Beispiele
<?php
function addProject(array &$projects, string $name): void
{
$projects[] = $name;
}
$activeProjects = ['Atlas'];
echo implode(', ', $activeProjects), "\n";
addProject($activeProjects, 'Beacon');
echo implode(', ', $activeProjects), "\n";
Ergebnis
Atlas Atlas, Beacon
Die erste Zeile zeigt den Zustand vor dem Aufruf. Die zweite zeigt, dass `Beacon` an `$activeProjects` angehängt wurde, obwohl `addProject()` keinen Ergebniswert zurückgibt.
Zugehörige Lektionen
- PHP · Lektion 12 · Mittlere Stufe · Version: 3
- PHP · Lektion 13 · Mittlere Stufe · Version: 3