【PHP】array_key_first()で配列や連想配列の最初のキーを取得する!

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

PHPで配列のキーを取得する関数として、array_key_ first()があります。

array_key_first()とは指定した配列の要素の最初のキーを取得する関数になります。

例えば、「[‘A’,’B’,’C’]」という配列にarray_key_first()を使用すると「0」が表示されるように、「最初のキー」を返り値として返すようになります。

そして、array_key_first()は連想配列の最初のキーを取得することができたり、2次元配列や3次元配列のような多次元配列最初のキーを取得することができたりします。

こちらの関数は配列のキーの一部を取得する関数になりますのでもし、配列内にある全てのキーを取得したい場合はarray_keys()を使用しましょう。

今回はPHPのarray_key_first()で配列や連想配列の最初のキーを取得する方法について紹介していきます。

この記事はこんな方におすすめ
・PHPのarray_key_first()で配列や連想配列の最初のキーを取得したい人




array_key_first()とは

array_key_first()とは配列の先頭に要素を追加する関数となります。

配列の最初のキーを取得するのため、配列やだけでなく、連想配列のキーも取得することができます。

array_key_first()の書き方

array_key_first()書き方は下記のようになります。

array_key_first()は必須パラメータである「最初のキーを取得する配列」を指定することで使用することができます。

array_key_first()のパラメータ

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

  1. 最初のキーを取得する配列(必須)
    最初のキーを取得したい配列名を指定する

パラメータである「対象の配列」は最初のキーを取得する配列を指定します。

array_key_first()で配列の最初のキーを取得するサンプルコード

array_key_first()で配列の最初のキーを取得するサンプルコードをご紹介します。

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

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

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

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

⚫︎ index.php

⚫︎ 実行結果

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

array_key_first()によって指定した配列の最初のキーを取得しています。

そのため、「サッカー」のキーである「0」が表示されています。

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

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

⚫︎ index.php

⚫︎ 実行結果

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

配列に要素が存在しない場合にarray_key_first()を使用すると、何も返されません。

array_key_first()で連想配列の最初のキーを取得するサンプルコード

array_key_first()で連想配列の最初のキーを取得するサンプルコードをご紹介します。

⚫︎ index.php

⚫︎ 実行結果

array_key_first()で連想配列の最初のキーを取得した結果

array_key_first()によって、指定した連想配列の最初のキーを取得しています。

そのため、「サッカー」のキーである「soccer」が表示されています。

array_key_first()で多次元配列の最初のキーを取得するサンプルコード

array_key_first()で多次元配列の最初のキーを取得するサンプルコードをご紹介します。

2次元配列の場合

2次元配列の先頭のキーを取得する場合に、array_key_first()を使用してみます。

⚫︎ index.php

⚫︎ 実行結果

2次元配列にarray_key_first()を使用した結果

array_key_first()によって、2次元配列の中にある最初のキーを取得することができます。

そして、配列の後ろにインデックスを1つ指定すると、2次元配列の中にある1次元配列の最初のキーを取得することができます。

3次元配列の場合

3次元配列の先頭のキーを取得する場合に、array_key_first()を使用してみます。

⚫︎ index.php

⚫︎ 実行結果

3次元配列にarray_key_first()を使用した結果

array_key_first()によって、3次元配列の中にある最初のキーを取得することができます。

そして、配列の後ろにインデックスを1つ指定すると、3次元配列の中にある2次元配列の最初のキーを、インデックスを2つ指定すると、3次元配列の中にある1次元配列の最初のキーを取得することができます。

配列の最後のキーを取得する場合

配列の最後のキーを取得する場合は、array_key_last()を使用します。

array_key_last()とは、指定した配列の最後のキーを取得することができる関数となります。

そのため、array_key_first()とは対になる関数となります。

⚫︎ index.php

⚫︎ 実行結果

array_key_last()で配列の最後のキーを取得した結果

array_key_last()によって、指定した配列の最後のキーを取得しています。

そのため、「バスケットボール」のキーである「3」が表示されています。

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

配列の全てのキーを取得する場合

配列の全てのキーを取得する場合は、array_keys()を使用します。

⚫︎ index.php

⚫︎ 実行結果

array_keys()で配列の全てのキーを取得した結果

array_keys()によって、指定した配列の全てのキーを配列で取得しています。

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

まとめ

⚫︎ array_key_first()とは指定した配列の最初のキーを取得する関数である

⚫︎ array_key_first()を使用するには1つのパラメータが必須となる
・ 最初のキーを取得する配列(必須)

⚫︎ 要素が存在する配列にarray_key_first()を使用すると、最初の要素のキーが返される

⚫︎ 要素が存在しない配列にarray_key_first()を使用すると、空が返される

⚫︎ array_key_first()は指定した連想配列の最初のキーを取得することができる

⚫︎ array_key_first()は指定した多次元配列の最初のキーを取得することができる

⚫︎ 配列の最後のキーを取得する場合は、array_key_last()を使用する

⚫︎ 配列の全てのキーを取得する場合は、array_keys()を使用する

コメントを残す

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