w3resource

PHP: array_shift() function

PHP: Shift an element off the beginning of array

The array_shift() function is used to remove the first element from an array, and returns the value of the removed element.

All numerical array keys will be modified to start counting from zero while literal keys won't be touched.

Version:

(PHP 4 and above)

Syntax:

array_shift(array_name)

Parameter:

Name Description Required /
Optional		 Type
array_name The specified array. Required Array

Return value:

The removed value from array_name or NULL if array_name is empty.

Value Type: Mixed*

*Mixed : Mixed indicates multiple (but not necessarily all) types.

Example:

<?php
$fruits_list = array(0 => 'Orange', 1=> 'Apple', 2 => 'Banana',3 => 'Cherry');
$result= array_shift($fruits_list);
print_r($fruits_list);
echo '</br>'.$result;
?>

Output:

Array ([0] => Apple [1] => Banana [2] => Cherry ) 

Orange

Pictorial Presentation:

php function reference: array_shift() function

View the example in the browser

Practice here online :

See also

PHP Function Reference

Previous: array_search
Next: array_slice



Follow us on Facebook and Twitter for latest update.

PHP: Tips of the Day

Filters the collection using the given callback

Example:

<?php
function tips_reject($items, $func)
{
  return array_values(array_diff($items, array_filter($items, $func)));
}

print_r(tips_reject(['Apple', 'Pear', 'Kiwi', 'Banana'], function ($item) {
  return strlen($item) > 4;
}));
?>

Output:

Array
(
    [0] => Pear
    [1] => Kiwi
)