【PHP】array_shift()で配列の先頭の要素を抜き出す!

(この記事は2022年7月07日に投稿されました。)

PHPで配列の先頭の要素を抜き出す関数として、array_shift()があります。

array_shift()とは指定した配列の先頭要素を抜き出す関数になります。

例えば、[‘A’,’B’,’C’]という配列にarray_shift()を使用すると、「A」のように一番左にある要素を返り値として返されるようになります。

そのため、抜き出された後の配列の要素は前にずれるようになります。

そして、for文と組み合わせて使用することで、配列の先頭要素を繰り返して抜き出すことができます。

また、array_shift()は、連想配列の先頭要素としてキーや値の先頭を抜き出すこともできます。

今回はPHPのarray_shift()で配列の先頭の要素を抜き出す方法について紹介していきます。

この記事はこんな方におすすめ
・PHPで配列の先頭の要素を抜き出したい人




array_shift()とは

冒頭でも言いましたが、array_shift()とは、配列の先頭の要素を抜き出す関数となります。

例えば[‘aaa’, ‘bbb’]の配列に対して、array_shift()を使用すると「aaa」が取り出されるように、先頭の要素を返り値として返すようになります。

そのため、array_shift()を使用した配列は要素が1つ分だけ短くなり、全ての要素は前にずれるようになります。

array_shift()の書き方

array_shift()は下記のように記述します。

array_shift()は1つのパラメータを指定することで、使用することができます。

array_shift()のパラメータ

array_shift()のパラメータは下記のようになります。

  1. 要素を抜き出したい配列(必須):
    先頭の要素を抜き出したい配列を指定する

array_shift()は必須なパラメータとして、「要素を抜き出したい配列」を指定します。

array_shift()で配列の先頭から要素を抜き出すサンプルコード

array_shift()で配列の先頭から要素を抜き出すサンプルコードをご紹介します。

ここでは下記の2つの場合でarray_shift()を使用してみます。

  1. 配列に要素が存在する場合
  2. 配列に要素が存在しない場合

配列に要素が存在する場合

配列に要素が存在する場合にarray_shift()を使用してみます。

⚫︎ index.php

⚫︎ 実行結果

配列に要素が存在する場合にarray_shift()を使用した結果

配列に要素が存在する場合にarray_shift()を使用すると、配列の先頭要素が取り出されるようになります。

配列に要素が存在しない場合

配列に要素が存在しない場合にarray_shift()を使用してみます。

⚫︎ index.php

⚫︎ 実行結果

配列に要素が存在しない場合にarray_shift()を使用した結果

配列に要素が存在しない場合にarray_shift()を使用すると、NULLが返されるようになります。

多次元配列の先頭から要素を抜き出すサンプルコード

array_shift()で多次元配列の先頭から要素を抜き出すサンプルコードをご紹介します。

ここでは下記の2つの場合でarray_shift()を使用してみます。

  1. 2次元配列の要素を先頭から抜き出す場合
  2. 3次元配列の要素を先頭から抜き出す場合

2次元配列の要素を先頭から抜き出す場合

2次元配列の要素を先頭から抜き出す場合にarray_shift()を使用してみます。

⚫︎ index.php

⚫︎ 実行結果

array_shift()で2次元配列の要素を先頭から要素を抜き出した結果

array_shift()によって、2次元配列の先頭要素をが取り出されています。

また、配列の変数名の後ろにインデックスを1つ指定することで2次元配列内にある1次元配列の先頭要素を取り出すことができます。

3次元配列の要素を先頭から抜き出す場合

3次元配列の要素を先頭から抜き出す場合にarray_shift()を使用してみます。

⚫︎ index.php

⚫︎ 実行結果

array_shift()で3次元配列の要素を先頭から要素を抜き出した結果

array_shift()によって、3次元配列の先頭要素が取り出されています。

また、配列の変数名の後ろにインデックスを2つ指定することで3次元配列内にある1次元配列の先頭要素を、インデックスを1つ指定することで3次元配列内にある2次元配列の先頭要素を取り出すことができます。

配列の先頭要素を繰り返して抜き出す場合

配列の先頭要素を繰り返して抜き出す場合は、for文の中でarray_shift()を使用します。

⚫︎ index.php

⚫︎ 実行結果

array_shift()で配列の先頭要素を繰り返して抜き出した結果

for文の中にarray_shift()を使用することで、配列の先頭要素を繰り返して取り出すことができます。

また、for文の中にfor文を使用することで、多次元配列の先頭要素を繰り返して取り出すことができます。

連想配列の先頭から要素を抜き出すサンプルコード

array_shift()で連想配列の先頭から要素を抜き出すサンプルコードをご紹介します。

ここでは下記の2つの場合で、array_shift()を使用してみます。

  1. 連想配列の先頭の値から要素を抜き出す場合
  2. 連想配列の先頭のキーから要素を抜き出す場合

連想配列の先頭の値から要素を抜き出す場合

連想配列の先頭の値から要素を抜き出す場合にarray_shift()を使用してみます。

⚫︎ index.php

⚫︎ 実行結果

array_shift()で連想配列の先頭の値から要素を抜き出した結果

array_shift()によって連想配列の先頭要素の値を取り出すことができます。

また、for文を使用することで、連想配列の先頭要素の値を繰り返して取り出すこともできます。

連想配列の先頭のキーから要素を抜き出す場合

連想配列の先頭のキーから要素を抜き出す場合にarray_shift()を使用してみます。

⚫︎ index.php

⚫︎ 実行結果

array_shift()で連想配列の先頭のキーから要素を抜き出した結果

array_keys()によって連想配列のキーを取り出しています。

そして、array_shift()によって連想配列の先頭要素のキーである「オンレジ」を取り出しています。

また、for文を使用することで、連想配列の先頭要素のキーを繰り返して取り出すこともできます。

もし、array_keys()について詳しく知りたい場合は下記の記事をご参考ください。

配列の末尾から要素を抜き出す場合

配列の末尾から要素を抜き出す場合は、array_pop()を使用します。

array_pop()とは、指定した配列の末尾を抜き出す関数となります。

そのため、今回紹介しているarray_shift()とは対になる関数になります。

⚫︎ index.php

⚫︎ 実行結果

array_pop()で配列の末尾から要素を抜き出した結果

array_pop()によって指定した配列の末尾から要素を取り出すことができます。

そのため、配列の中にある「いちご」が取り出されています。

もし、array_pop()について詳しく知りたい場合は下記の記事をご参考ください。

配列の先頭に要素を追加する場合

配列の先頭に要素を追加する場合は、array_unshift()を使用します。

array_unshift()とは、指定した配列の先頭に要素を追加する関数となります。

⚫︎ index.php

⚫︎ 実行結果

array_unshift()で配列の先頭の要素を追加した結果

array_unshift()によって指定した配列の先頭に要素を追加することができます。

そのため、「キウイ」が先頭に追加されています。

まとめ

⚫︎ array_shift()とは、配列の先頭要素を抜き出す関数である

⚫︎ array_shift()を使用するには1つのパラメータを指定する
・ 要素を抜き出したい配列(必須)

⚫︎ 配列に要素が存在する場合にarray_shift()を使用すると、配列の先頭要素が取り出される

⚫︎ 配列に要素が存在しない場合にarray_shift()を使用すると、何も取り出されずにNULLが返される

⚫︎ array_shift()は、多次元配列の先頭要素を取り出すことができる

⚫︎ array_shift()とfor文を組み合わせて使用することで、配列の先頭要素を繰り返して抜き出すことができる

⚫︎ array_shift()は、連想配列の先頭から要素を抜き出すことができる
(値やキーから先頭要素を抜き出すことが可能)

⚫︎ 配列の末尾から要素を抜き出す場合は、array_pop()を使用する

⚫︎ 配列の先頭に要素を追加する場合は、array_unshift()を使用する

コメントを残す

メールアドレスが公開されることはありません。