array_shift() - 配列の先頭の要素を取り除く

公開日: 2016/12/18

array_shiftは、配列の先頭の要素を取り除く関数です。元の配列に変更を加えます。添字は0から振り直されて、内部ポインタはリセットされます。

構文

mixed array_shift ( array &$array )

パラメータ

&$array

対象の配列。

返り値

mixed

取り除いた要素の値。空の配列、または配列以外の値に実行した場合はnullが返る。

サンプルコード

先頭の要素を取り除く

配列の先頭の要素を取り除きます。取り除いた要素が返り値となり、引数で指定した配列に変更が加えられます。添字が0から振り直されている点にご注意下さい。

php

<?php
	// 配列
	$queue = [ "a", "b", "c" ] ;

	// 実行
	$result = array_shift( $queue ) ;

	// 実行結果
	var_dump( $result ) ;	// 返り値
	echo "\n" ;
	print_r( $queue ) ;	// 実行後の配列

結果 (出力内容) - PHP7.0.21

string(1) "a"

Array
(
    [0] => b
    [1] => c
)

サンドボックス

ソースコードを編集してarray_shift()の挙動を確認して下さい。

CODE
RUN

string(1) "a"

Array
(
    [0] => b
    [1] => c
)

参考リンク

PHP - 公式マニュアル。