PHP funkce array_unshift()

   24. 07. 2020

Dostupnost ve verzích: PHP 4.0

Funkce připojí jeden nebo více prvků na začátek pole.

Pozor: Číselné indexy budou přečíslovány od nuly. Funkce resetuje vnitřní ukazatel na aktuální prvek v poli.

Použití

array_unshift(array array, mixed var [, mixed ...])

Funkce vezme předaný prvek, který umístí na začátek nového pole. Za předaný prvek poté překopíruje původní pole se zachováním klíčů a pořadí.

Funkce vrátí nový počet prvků v poli. Pole se však upravuje přes referenci, takže je potřeba přečíst z proměnné, v které bylo předáno.

Použití je například:

$queue = ['p1', 'p3'];
array_unshift($queue, 'p4', 'p5', 'p6');

Upravené pole $queue bude mít 5 prvků: "p4", "p5", "p6", "p1" a "p3".

Parametry

Parametr Datový typ Výchozí hodnota Poznámka
$array array Upravované pole.
$var mixed Hodnota, která půjde na začátek pole.
$_ mixed null Volitelně další hodnoty, které půjdou na začátek pole.

Návratové hodnoty

Vrátí int vyjadřující nový počet prvků v poli.

Další zdroje

Oficiální dokumentace

Nechte si posílat nové články do mailu:

Jan Barášek     Více o autorovi

Autor článku podniká jako fullstack senior developer v Praze. Spravuje 300 různě velkých webových projektů, fungujících dodnes. Během spolupráce nabral hluboké zkušenosti, které na tomto webu předává dál.

Rád vám pomůžu:

Kontakt Konzultace a služby Nabídka spolupráce