【PHP】配列から先頭の要素を取得するarray_shift関数を解説します

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在5社経験している、12年目エンジニアです。

この記事では、 PHPで配列から先頭の要素を取得するarray_shift関数について

array_shift関数とは
array_shift関数を使ったサンプルプログラム

と、丁寧に解説していきます。

前提条件：実行環境について
array_shift関数とは
array_shift関数を解説するプログラムの概要
PHPサンプルプログラム
実行結果
まとめ：array_shift関数を使ってみよう！

前提条件：実行環境について

実行環境は以下の通りです。

OS	Windows11
PHPのバージョン	8.2.4
XAMPPのバージョン	8.2.4

PHPを動かすためにXAMPPを使っています。
XAMPPのインストールは、下の記事をご参考ください。

【XAMPP】インストールするやり方を解説します（Windows11向け）

array_shift関数とは

array_shift関数とは、引数に指定された配列の先頭要素を取得して、先頭要素の値を返す関数です。
引数に指定した配列は先頭要素がなくなり、すべての要素が1つずつ前にずれます。

使い方サンプルは以下になります。

$sample = [1, 2, 3, 4];
$result = array_shift($sample);

1 2	$sample = [1, 2, 3, 4]; $result = array_shift($sample);

上記の例だとresultには1が返され、配列sampleは先頭の1がなくなった

Array
(
    [0] => 2
    [1] => 3
    [2] => 4
)

Array

(

[0] => 2

[1] => 3

[2] => 4

)

になります。
array_shift関数は、連想配列でも空配列に対しても使うことができます。
空配列を引数に指定した場合は、NULLが返されます。

array_shift関数を解説するプログラムの概要

array_shift関数を解説するプログラムでは、引数に

配列
連想配列
空配列

3パターンを与えて、結果を表示させて確認します。

phpプログラムは

C:\xampp\htdocs

配下に、【sample.php】というファイル名で格納しています。
PHPのarray_shift関数を解説

PHPサンプルプログラム

<?php
	print('■array_shift関数確認<br >');

	print('①配列の場合<br >');
	$fruits = array('apple', 'orange', 'banana');
	print('・取り出す前の配列');
	print_r('<pre>');
	print_r($fruits);
	print_r('</pre>');

	$head_fruit = array_shift($fruits);
	print('・取り出した後の配列');
	print_r('<pre>');
	print_r($fruits);
	print_r('</pre>');
	print('先頭要素：'.$head_fruit.'<br >');
	print('型：'.gettype($head_fruit).'<br >');

	print('②連想配列の場合<br >');
	$animals = array('dog' => 'イヌ', 'cat' => 'ネコ', 'parakeet' => 'インコ');
	print('・取り出す前の配列');
	print_r('<pre>');
	print_r($animals);
	print_r('</pre>');

	$head_animal = array_shift($animals);
	print('・取り出した後の配列');
	print_r('<pre>');
	print_r($animals);
	print_r('</pre>');
	print('先頭要素：'.$head_animal.'<br >');
	print('型：'.gettype($head_animal).'<br >');

	print('③空の配列の場合<br >');
	$emp = array();
	print('・取り出す前の配列');
	print_r('<pre>');
	print_r($emp);
	print_r('</pre>');

	$head_emp = array_shift($emp);
	print('・取り出した後の配列');
	print_r('<pre>');
	print_r($emp);
	print_r('</pre>');
	print('先頭要素：'.$head_emp.'<br >');
	print('型：'.gettype($head_emp).'<br >');
?>

<?php

print('■array_shift関数確認 ');

print('①配列の場合 ');

$fruits = array('apple', 'orange', 'banana');

print('・取り出す前の配列');

print_r('<pre>');

print_r($fruits);

print_r('</pre>');

$head_fruit = array_shift($fruits);

print('・取り出した後の配列');

print_r('<pre>');

print_r($fruits);

print_r('</pre>');

print('先頭要素：'.$head_fruit.' ');

print('型：'.gettype($head_fruit).' ');

print('②連想配列の場合 ');

$animals = array('dog' => 'イヌ', 'cat' => 'ネコ', 'parakeet' => 'インコ');

print('・取り出す前の配列');

print_r('<pre>');

print_r($animals);

print_r('</pre>');

$head_animal = array_shift($animals);

print('・取り出した後の配列');

print_r('<pre>');

print_r($animals);

print_r('</pre>');

print('先頭要素：'.$head_animal.' ');

print('型：'.gettype($head_animal).' ');

print('③空の配列の場合 ');

$emp = array();

print('・取り出す前の配列');

print_r('<pre>');

print_r($emp);

print_r('</pre>');

$head_emp = array_shift($emp);

print('・取り出した後の配列');

print_r('<pre>');

print_r($emp);

print_r('</pre>');

print('先頭要素：'.$head_emp.' ');

print('型：'.gettype($head_emp).' ');

array関数は配列を初期化、gettype関数は引数に与えた変数の型を取得し、その型を文字列で返す関数です。
詳しくはこちらの記事をご参考ください。

array関数
【PHP】配列を初期化できるarray関数を解説します

gettype関数
【PHP】変数の型を取得できるgettype関数を解説します

実行結果

XAMPPを起動して、【http://localhost/sample.php】のURLにアクセスします。

XAMPPでPHPの動かし方については、こちらの記事をご参考ください。

XAMPPでApacheの動かし方を解説します（Windows11向け）

PHPのarray_shift関数を解説

array_shift関数によって、先頭の要素を配列から取得できているとが確認できました！

まとめ：array_shift関数を使ってみよう！

以上がarray_shift関数についての解説でした！

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ