(PHP 4, PHP 5, PHP 7, PHP 8)
array_unshift — Empila uno o más elementos al inicio de un array
array_unshift() añade los elementos value1,
..., pasados
como argumento al inicio del array array. Se debe tener en cuenta que
los elementos se añaden como un todo, y que permanecen
en el mismo orden. Todas las claves numéricas se modificarán para comenzar desde cero, mientras que las claves literales no se verán afectadas.
Nota:
Reinicia el puntero interno del array al primer elemento.
arrayEl array de entrada.
valuesValor a empilar.
Devuelve el nuevo número de elementos del array
array.
| Versión | Descripción |
|---|---|
| 7.3.0 | Esta función puede ahora ser llamada con un solo parámetro. Anteriormente, se requerían al menos dos parámetros. |
Ejemplo #1 Ejemplo con array_unshift()
<?php
$queue = [
"orange",
"banana"
];
array_unshift($queue, "apple", "raspberry");
var_dump($queue);
?>El resultado del ejemplo sería:
array(4) {
[0] =>
string(5) "apple"
[1] =>
string(9) "raspberry"
[2] =>
string(6) "orange"
[3] =>
string(6) "banana"
}
Ejemplo #2 Uso con arrays asociativos
Si un array asociativo es añadido como prefijo a otro array asociativo, el array añadido es indexado numéricamente en el array precedente.
<?php
$foods = [
'apples' => [
'McIntosh' => 'red',
'Granny Smith' => 'green',
],
'oranges' => [
'Navel' => 'orange',
'Valencia' => 'orange',
],
];
$vegetables = [
'lettuce' => [
'Iceberg' => 'green',
'Butterhead' => 'green',
],
'carrots' => [
'Deep Purple Hybrid' => 'purple',
'Imperator' => 'orange',
],
'cucumber' => [
'Kirby' => 'green',
'Gherkin' => 'green',
],
];
array_unshift($foods, $vegetables);
var_dump($foods);El resultado del ejemplo sería:
array(3) {
[0]=>
array(3) {
["lettuce"]=>
array(2) {
["Iceberg"]=>
string(5) "green"
["Butterhead"]=>
string(5) "green"
}
["carrots"]=>
array(2) {
["Deep Purple Hybrid"]=>
string(6) "purple"
["Imperator"]=>
string(6) "orange"
}
["cucumber"]=>
array(2) {
["Kirby"]=>
string(5) "green"
["Gherkin"]=>
string(5) "green"
}
}
["apples"]=>
array(2) {
["McIntosh"]=>
string(3) "red"
["Granny Smith"]=>
string(5) "green"
}
["oranges"]=>
array(2) {
["Navel"]=>
string(6) "orange"
["Valencia"]=>
string(6) "orange"
}
}