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

エンジニアに特化した転職エージェント！

・IT/Web系エンジニアの経験者の方
・どこの転職エージェントを利用しようか迷っている方

それなら、キッカケエージェントにご相談！

キッカケエージェントでは、少数精鋭のエージェントが、エンジニアの経験やスキル、志向性などをカウンセリングし、的確なアドバイスを提供します！

また、徹底した企業へのヒアリングにより、最適なマッチングを実現し、今では内定率が一般的なエージェントの2倍以上となっています！

転職エージェントに迷っている方、まずは無料でキャリア相談から！

エンジニア特化の転職支援【キッカケエージェント】

(この記事は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()で配列や連想配列の最初のキーを取得する方法について紹介していきます。

この記事はこんな方におすすめ

array_key_first()とは

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

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

array_key_first()の書き方

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

<?php array_key_first('最初のキーを取得する配列'); ?>

1	<?php array_key_first('最初のキーを取得する配列'); ?>

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

array_key_first()のパラメータ

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

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

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

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

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

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

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

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

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

⚫︎ index.php

<?php
echo '⚫︎ 対象の配列';
$sports = ['サッカー', '野球', 'テニス', 'バスケットボール'];
print_r($sports);

echo '⚫︎ array_key_first()使用後';
$sport_key = array_key_first($sports);
echo $sport_key;
?>

<?php

echo '⚫︎ 対象の配列';

$sports = ['サッカー', '野球', 'テニス', 'バスケットボール'];

print_r($sports);

echo '⚫︎ array_key_first()使用後';

$sport_key = array_key_first($sports);

echo $sport_key;

実行結果

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

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

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

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

⚫︎ index.php

<?php
echo '⚫︎ 対象の配列';
$sports = [];
print_r($sports);

echo '⚫︎ array_key_first()使用後';
$sport_key = array_key_first($sports);
echo $sport_key;
?>

<?php

echo '⚫︎ 対象の配列';

$sports = [];

print_r($sports);

echo '⚫︎ array_key_first()使用後';

$sport_key = array_key_first($sports);

echo $sport_key;

実行結果

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

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

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

⚫︎ index.php

<?php
echo '⚫︎ 対象の配列';
$sports = [
    'soccer' => 'サッカー',
    'baseball' => '野球',
    'tennis' => 'テニス',
    'basketball' => 'バスケットボール'
    ];
print_r($sports);

echo '⚫︎ array_key_first()使用後';
$sport_key = array_key_first($sports);
echo $sport_key;
?>

<?php

echo '⚫︎ 対象の配列';

$sports = [

'soccer' => 'サッカー',

'baseball' => '野球',

'tennis' => 'テニス',

'basketball' => 'バスケットボール'

];

print_r($sports);

echo '⚫︎ array_key_first()使用後';

$sport_key = array_key_first($sports);

echo $sport_key;

実行結果

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

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

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

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

2次元配列の場合

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

⚫︎ index.php

<?php
echo '⚫︎ 対象の配列';
$sports = [
    ['サッカー', '野球', 'テニス'],
    ['バスケットボール', 'ハンドボール', 'ラクロス'],
    ['剣道', '柔道', 'ボクシング']
    ];
print_r($sports);

echo '⚫︎ array_key_first()使用後-1';
$sport_key = array_key_first($sports);
echo $sport_key;

echo '⚫︎ array_key_first()使用後-2';
$sport_key = array_key_first($sports[1]);
echo $sport_key;
?>

<?php

echo '⚫︎ 対象の配列';

$sports = [

['サッカー', '野球', 'テニス'],

['バスケットボール', 'ハンドボール', 'ラクロス'],

['剣道', '柔道', 'ボクシング']

];

print_r($sports);

echo '⚫︎ array_key_first()使用後-1';

$sport_key = array_key_first($sports);

echo $sport_key;

echo '⚫︎ array_key_first()使用後-2';

$sport_key = array_key_first($sports[1]);

echo $sport_key;

実行結果

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

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

3次元配列の場合

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

⚫︎ index.php

<?php
echo '⚫︎ 対象の配列';
$sports = [
    [['サッカー', '野球', 'テニス'],['バスケットボール', 'ハンドボール', 'ラクロス']],
    [['剣道', '柔道', 'ボクシング'],['陸上', 'セパタクロ', 'モルック']]
    ];
print_r($sports);

echo '⚫︎ array_key_first()使用後-1';

$sports_key = array_key_first($sports);
echo $sports_key;

echo '⚫︎ array_key_first()使用後-2';
$sports_key = array_key_first($sports[1]);
echo $sports_key;

echo '⚫︎ array_key_first()使用後-3';
$sports_key = array_key_first($sports[0][1]);
echo $sports_key;
?>

<?php

echo '⚫︎ 対象の配列';

$sports = [

[['サッカー', '野球', 'テニス'],['バスケットボール', 'ハンドボール', 'ラクロス']],

[['剣道', '柔道', 'ボクシング'],['陸上', 'セパタクロ', 'モルック']]

];

print_r($sports);

echo '⚫︎ array_key_first()使用後-1';

$sports_key = array_key_first($sports);

echo $sports_key;

echo '⚫︎ array_key_first()使用後-2';

$sports_key = array_key_first($sports[1]);

echo $sports_key;

echo '⚫︎ array_key_first()使用後-3';

$sports_key = array_key_first($sports[0][1]);

echo $sports_key;

実行結果

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

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

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

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

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

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

⚫︎ index.php

<?php
echo '⚫︎ 対象の配列';
$sports = ['サッカー', '野球', 'テニス', 'バスケットボール'];
print_r($sports);

echo '⚫︎ array_key_last()使用後';
$sports_key = array_key_last($sports);
echo $sports_key;
?>

<?php

echo '⚫︎ 対象の配列';

$sports = ['サッカー', '野球', 'テニス', 'バスケットボール'];

print_r($sports);

echo '⚫︎ array_key_last()使用後';

$sports_key = array_key_last($sports);

echo $sports_key;

実行結果

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

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

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

Sossyの助太刀ブログ

8月 07, 2022

【PHP】array_key_last()で配列や連想配列の最後のキーを取得する！

https://sossy-blog.com/useful/5196/

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

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

⚫︎ index.php

<?php
echo '⚫︎ 対象の配列';
$sports = ['サッカー', '野球', 'テニス', 'バスケットボール'];
print_r($sports);

echo '⚫︎ array_keys()使用後';
$sports_key = array_keys($sports);
print_r($sports_key);
?>

<?php

echo '⚫︎ 対象の配列';

$sports = ['サッカー', '野球', 'テニス', 'バスケットボール'];

print_r($sports);

echo '⚫︎ array_keys()使用後';

$sports_key = array_keys($sports);

print_r($sports_key);

実行結果