CKTIS / PHP
Parametr przekazywany przez referencję (`&$list`)
Znak `&` przed parametrem `$list` pozwala funkcji zmienić zmienną przekazaną przez wywołującego. Znak ten zapisuje się w deklaracji parametru, a nie przy argumencie w wywołaniu.
Wersja: PHP 8.3
Składnia
<?php
function appendItem(array &$list, string $item): void
{
$list[] = $item;
}
$items = ['apple'];
appendItem($items, 'pear');W PHP 8.3 zapis &$list oznacza parametr przekazywany przez referencję. W wywołaniu appendItem($items, 'pear') lokalna nazwa $list staje się aliasem tej samej zawartości, do której odnosi się $items. Referencja PHP nie jest wskaźnikiem do adresu w pamięci. $list to zwykła nazwa parametru, niezwiązana z konstrukcją list() służącą do rozpakowywania tablic.
Składnia referencji, operacje na tablicach i funkcja implode() użyte w przykładzie nie wymagają żadnego opcjonalnego rozszerzenia PHP.
Znak & umieść przed nazwą parametru w deklaracji, nie przed argumentem w wywołaniu. Przekaż zmienną, np. $items; literał ['apple'] użyty jako argument referencyjny powoduje błąd. Można też przekazać wynik funkcji, która zwraca przez referencję. Przekazywanie parametru przez referencję nie oznacza zwracania przez referencję.
$list[] = $item dopisuje element do tablicy wywołującego, a przypisanie $list = [] zastąpiłoby całą tablicę. Zmiany pozostają widoczne po zakończeniu wywołania. Natomiast unset($list) wewnątrz funkcji usuwa tylko lokalne powiązanie, nie zmienną $items. Bez & argument jest domyślnie przekazywany przez wartość, więc pokazane dopisanie nie zmieniłoby $items.
W array &$list typ array jest sprawdzany przy wejściu do funkcji, a nie przy jej zakończeniu: podanie zmiennej z liczbą całkowitą powoduje TypeError. void dotyczy wyniku funkcji, a nie zmiany argumentu. Używaj referencji, gdy zmiana zmiennej wywołującego jest zamierzona, i opisz ten efekt uboczny, bo w samym wywołaniu go nie widać.
Przykłady
<?php
function appendItem(array &$list, string $item): void
{
$list[] = $item;
}
$items = ['apple'];
appendItem($items, 'pear');
echo implode(', ', $items), "\n";
Wynik
apple, pear
Po wywołaniu `appendItem()` kod wypisuje `$items`, nie wartość zwróconą przez funkcję. Oczekiwany wiersz to `apple, pear`. Usuń tylko `&` z deklaracji parametru, aby porównać: oczekiwany wiersz to wtedy `apple`.
Powiązane lekcje
- PHP · Lekcja 20 · Średniozaawansowany · Wersja: 3