array_unshift

(PHP 4, PHP 5, PHP 7, PHP 8)

array_unshift — Adiciona um ou mais elementos no início de um array

Descrição

array_unshift(array &$array, mixed ...$values): int

array_unshift() adiciona os elementos passados como argumentos no início de array. Note que a lista de elementos é adicionada como um todo, de forma que eles ficam na mesma ordem. Todas as chaves numéricas serão modificadas para começar a contar de zero enquanto chaves literais permanecerão inalteradas.

Nota:
Redefine o ponteiro interno do array para o primeiro elemento.

Parâmetros

array: O array de entrada.
values: Os valores a serem adicionados.

Valor Retornado

Retorna o novo número de elementos em array.

Registro de Alterações

Versão	Descrição
7.3.0	Essa função agora pode ser chamada com apenas um parâmetro. Anteriomente, pelo menos dois parâmetros eram necessários.

Exemplos

Exemplo #1 Exemplo de array_unshift()

<?php
$cesta = [
    "laranja",
    "banana"
];

array_unshift($cesta, "melancia", "morango");
var_dump($cesta);
?>

O exemplo acima produzirá:

array(4) {
  [0] =>
  string(8) "melancia"
  [1] =>
  string(7) "morango"
  [2] =>
  string(7) "laranja"
  [3] =>
  string(6) "banana"
}

Exemplo #2 Uso de arrays associativos

Se um array associativo é pre anexado a outro array associativo, o array anexado é numeralmente indexado no array anterior.

<?php
$frutas = [
    'maca' => [
        'McIntosh' => 'vermelho',
        'Granny Smith' => 'verde',
    ],
    'laranja' => [
        'Navel' => 'laranja',
        'Valencia' => 'laranja',
    ],
];
$vegetais = [
    'alface' => [
        'Iceberg' => 'verde',
        'Butterhead' => 'verde',
    ],
    'cenoura' => [
        'Deep Purple Hybrid' => 'roxo',
        'Imperator' => 'laranja',
    ],
    'pepino' => [
        'Kirby' => 'verde',
        'Gherkin' => 'verde',
    ],
];

array_unshift($frutas, $vegetais);
var_dump($frutas);

O exemplo acima produzirá:

array(3) {
  [0] =>
  array(3) {
    'alface' =>
    array(2) {
      'Iceberg' =>
      string(5) "verde"
      'Butterhead' =>
      string(5) "verde"
    }
    'cenoura' =>
    array(2) {
      'Deep Purple Hybrid' =>
      string(4) "roxo"
      'Imperator' =>
      string(7) "laranja"
    }
    'pepino' =>
    array(2) {
      'Kirby' =>
      string(5) "verde"
      'Gherkin' =>
      string(5) "verde"
    }
  }
  'maca' =>
  array(2) {
    'McIntosh' =>
    string(8) "vermelho"
    'Granny Smith' =>
    string(5) "verde"
  }
  'laranja' =>
  array(2) {
    'Navel' =>
    string(7) "laranja"
    'Valencia' =>
    string(7) "laranja"
  }
}

Veja Também

array_merge() - Combina um ou mais arrays
array_shift() - Retira o primeiro elemento de um array
array_push() - Adiciona um ou mais elementos no final de um array
array_pop() - Extrai um elemento do final do array

add a note

User Contributed Notes 13 notes

down

206

sergei at gmx dot net ¶

17 years ago


You can preserve keys and unshift an array with numerical indexes in a really simple way if you'll do the following:



<?php

$someArray=array(224=>'someword1', 228=>'someword2', 102=>'someword3', 544=>'someword3',95=>'someword4');



$someArray=array(100=>'Test Element 1 ',255=>'Test Element 2')+$someArray;

?>



now the array looks as follows:



array(

100=>'Test Element 1 ',

255=>'Test Element 2'

224=>'someword1',

228=>'someword2',

102=>'someword3',

544=>'someword3',

95=>'someword4'

);

down

rsmith_NOSPAM_ at _NOSPAM_unitec dot ac dot nz ¶

22 years ago


array_merge() will also reindex (see array_merge() manual entry), but the '+' operator won't, so...



<?php

$arrayone=array("newkey"=>"newvalue") + $arrayone;

?>



does the job.

down

Anonymous ¶

13 years ago


Sahn's example almost works but has a small error. Try it like this if you need to prepend something to the array without the keys being reindexed and/or need to prepend a key value pair, you can use this short function: 

<?php 
function array_unshift_assoc(&$arr, $key, $val) 
{ 
    $arr = array_reverse($arr, true); 
    $arr[$key] = $val; 
    return = array_reverse($arr, true); 
} 
?>

down

daniel at smallboxcms dot com ¶

9 years ago


Anonymous' associative version wasn't working for me, but it did with this small tweak:

function array_unshift_assoc(&$arr, $key, $val) 
{ 
    $arr = array_reverse($arr, true); 
    $arr[$key] = $val; 
    $arr = array_reverse($arr, true); 
    return $arr;
}

down

amschroeder at gmail dot com ¶

17 years ago


This becomes a nice little problem if you index your arrays out of order (while manually sorting).  For example:



<?php

$recordMonths[3] = '8/%/2006';

$recordMonths[4] = '7/%/2004';

$recordMonths[0] = '3/%/2007';

$recordMonths[1] = '2/%/2007';

$recordMonths[5] = '12/%/2000';

$recordMonths[6] = '11/%/2000';

$recordMonths[7] = '10/%/2000';

$recordMonths[2] = '1/%/2007';



for($i = 0; $i < count($recordMonths); $i++)

{

    $singleMonth = $recordMonths[$i];

    echo "singleMonth: $singleMonth <br />";

}

array_unshift($recordMonths,'%');

for($i = 0; $i < count($recordMonths); $i++)

{

    $singleMonth = $recordMonths[$i];

    echo "singleMonth: $singleMonth <br />";

}

?>



Produces:



singleMonth: 3/%/2007

singleMonth: 2/%/2007

singleMonth: 1/%/2007

singleMonth: 8/%/2006

singleMonth: 7/%/2004

singleMonth: 12/%/2000

singleMonth: 11/%/2000

singleMonth: 10/%/2000

singleMonth: %

singleMonth: 8/%/2006

singleMonth: 7/%/2004

singleMonth: 3/%/2007

singleMonth: 2/%/2007

singleMonth: 12/%/2000

singleMonth: 11/%/2000

singleMonth: 10/%/2000

singleMonth: 1/%/2007 



It reindexes them based on the order they were created.  It seems like if an array has all numeric indexes, then it should reindex them based on the order of their index.  Just my opinion...

down

php at electricsurfer dot com ¶

20 years ago


even simpler unshifting of a reference !
<?php
/**
 * @return int
 * @param $array array
 * @param $value mixed
 * @desc Prepend a reference to an element to the beginning of an array. Renumbers numeric keys, so $value is always inserted to $array[0]
 */
function array_unshift_ref(&$array, &$value)
{
   $return = array_unshift($array,'');
   $array[0] =& $value;
   return $return;
}
?>

down

robert dot wills at fuzzbrain dot uklinux dot net ¶

22 years ago


Actually this problem with the keys getting reindexed only happens when the keys are numerical:

<?php

$a = array("f"=>"five", "s" =>"six", "t" =>
        "twenty");

print_r($a);
echo "\n";
foreach($a as $key=>$val)
{
    echo "k: $key v: $val \n";
}

array_unshift($a, "zero");
print_r($a);
echo "\n";
foreach($a as $key=>$val)
{
    echo "k: $key v: $val \n";
}
?>

Array
(
    [f] => five
    [s] => six
    [t] => twenty
)

k: f v: five
k: s v: six
k: t v: twenty
Array
(
    [0] => zero
    [f] => five
    [s] => six
    [t] => twenty
)

k: 0 v: zero
k: f v: five
k: s v: six
k: t v: twenty

down

eliasritter168667 at gmail dot com ¶

1 year ago


This function helps if you want to prepend a key and value pair to the beginning of an array:

function array_kunshift(array $array, string|int $key, mixed $value): array {
        return array_merge([$key => $value], $array);
    }

down

Richard Akindele ¶

8 years ago


Another way to tack something to the beginning of an array is with array_merge().

$plans = array('AARP'=>'Senior', 'AAA'=>'Automobile Club');

$plans = array_merge(array("BAR"=>"Best Available Rate"),  $plans);

down

sahn at hmc dot edu ¶

23 years ago


If you need to prepend something to the array without the keys being reindexed and/or need to prepend a key value pair, you can use this short function:



<?php

function array_unshift_assoc(&$arr, $key, $val)

{

    $arr = array_reverse($arr, true);

    $arr[$key] = $val;

    $arr = array_reverse($arr, true);

    return count($arr);

}

?>

down

-1

chris dot NoThxSpam dot given at hp dot com ¶

21 years ago


If you need to change the name of a key without changing its position in the array this function may be useful.



<?php

function array_key_change($Old, $New, $In, $NewVal=NULL) {

        $Temp = array();

        while(isset($Temp[$Old]) == false) {

                list($k, $v) = each($In);

                $Temp[$k] = $v;

                unset($In[$k]);

        }

        if($NewVal == NULL) {

                $NewVal = $Temp[$Old];

        }

        unset($Temp[$Old]);

        $Temp = array_reverse($Temp);

        $In = array_merge(array($New=>$NewVal), $In);

        while(list($k,$v) = each($Temp)) {

                $In = array_merge(array($k=>$v), $In);

        }

        return($In);

}

?>

down

-4

John Brooking ¶

18 years ago


I had a need tonight to convert a numeric array from 1-based to 0-based, and found that the following worked just fine due to the "side effect" of renumbering:



<?php

   array_unshift( $myArray, array_shift( $myArray ));

?>

down

-12

lagroue ¶

21 years ago


Last version of PHP deprecated unshifting of a reference.

You can use this function instead :



<?php

function array_unshift1 (& $ioArray, $iValueWrappedInAnArray) {

    $lNewArray = false;

    foreach (array_keys ($ioArray) as $lKey)

        $lNewArray[$lKey+1] = & $ioArray[$lKey];

    $ioArray = array (& $iValueWrappedInAnArray[0]);

    if ($lNewArray)

        foreach (array_keys ($lNewArray) as $lKey)

             $ioArray[] = & $lNewArray[$lKey];

    return count($ioArray);

}



// before last PHP (now generates a deprecation warning)

array_unshift ($a, &$v);

// since last PHP (caution, there is a wrapping array !!)

array_unshift1 ($a, array (&$v));

?>

add a note