array_shift

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

array_shift — Извлекает первый элемент массива

Описание

array_shift(array &$array): mixed

Функция array_shift() извлекает и возвращает первое значение массива array, сокращает массив array на один элемент и сдвигает остальные элементы в начало. Числовые ключи массива изменятся так, чтобы нумерация начиналась с нуля, тогда как литеральные ключи не изменятся.

Замечание: При вызове функция сбрасывает указатель массива, переданного параметром.

Список параметров

array

Входной массив.

Возвращаемые значения

Функция возвращает извлечённое значение или null, если массив array оказался пустым или аргумент не принадлежит типу array.

Примеры

Пример #1 Пример извлечения первого элемента массива функцией array_shift()

<?php

$stack = array("orange", "banana", "apple", "raspberry");

$fruit = array_shift($stack);

print_r($stack);

?>

Результат выполнения приведённого примера: 

Array
(
    [0] => banana
    [1] => apple
    [2] => raspberry
)

Значение orange присвоится переменной $fruit.

Смотрите также

  • array_unshift() - Добавляет один или несколько элементов в начало массива
  • array_push() - Добавляет один или несколько элементов в конец массива
  • array_pop() - Извлекает последний элемент массива