【PHP8.x】array_shift関数の使い方

<?php

/**
 * array_shift関数の基本的な使い方を示すサンプルコードです。
 * 連想配列に対してarray_shiftを適用した場合の挙動を特に示します。
 */

// サンプルとして連想配列を定義します。
$associativeArray = [
    'id' => 101,
    'name' => '田中',
    'role' => '管理者',
    'status' => '有効',
];

echo "--- 元の連想配列 ---\n";
print_r($associativeArray);

// array_shift関数を適用し、配列の先頭要素を取り出します。
// 連想配列の場合、先頭要素の値が返され、元の配列からはそのキーと値のペアが削除されます。
// 残りの要素は数値キーにリセットされ、連番になります。
$shiftedValue = array_shift($associativeArray);

echo "\n--- array_shiftで取り出された値 ---\n";
// 取り出された値は'id'キーに対応する'101'です。
var_dump($shiftedValue);

echo "\n--- array_shift後の連想配列 ---\n";
// 'id' => 101 が削除され、残りの要素のキーが数値にリセットされている点に注目してください。
print_r($associativeArray);

?>

PHP 8.4のarray_shift関数は、配列の先頭にある要素を取り除くために使用されます。この関数は、引数として渡された配列そのものを変更する点が特徴です。引数array &$arrayは、操作対象となる配列を「参照渡し」で受け取ります。これにより、関数内で配列が変更されると、その変更が元の配列にも直接反映されます。関数が正常に実行されると、削除された先頭要素の値が戻り値mixedとして返されます。

提供されたサンプルコードでは、連想配列$associativeArrayに対してarray_shiftを適用する例を示しています。array_shift($associativeArray)を実行すると、連想配列の先頭に位置する'id' => 101というキーと値のペアが配列から削除され、その値である101が$shiftedValue変数に代入されます。

特に注目すべきは、array_shift適用後の配列の挙動です。元の配列から先頭要素が削除された後、残りの要素（この場合は'name' => '田中'、'role' => '管理者'、'status' => '有効'）は、元の連想キーを失います。そして、自動的に0、1、2といった数値の連番キーを持つ配列として再インデックスされます。このように、array_shiftは連想配列の構造を数値キーの配列に変換する可能性があるため、使用する際は注意が必要です。この関数は、配列の先頭から要素を効率的に取得し、同時に配列からその要素を削除したい場合に非常に役立ちます。

<?php

/**
 * array_shift() 関数の基本的な使い方を示すサンプルコードです。
 * 連想配列の最初の要素を取り出し、配列がどのように変更されるかを示します。
 *
 * array_shift() は、配列の先頭から要素を1つ取り除き、その値（取り除かれた要素の値）を返します。
 * 取り除かれた要素は元の配列から削除されます。
 * 連想配列の場合、挿入順序における最初のキーと値のペアが対象となります。
 * 残りの要素のキーは保持され、数値キーのような再インデックスは発生しません。
 */
function demonstrateArrayShiftWithAssociativeArray(): void
{
    // システムエンジニアの情報を表す連想配列を初期化します。
    // 各要素は「キー => 値」の形式です。
    $engineerProfile = [
        'id'       => 1001,
        'name'     => '田中 太郎',
        'position' => 'シニアエンジニア',
        'team'     => '開発チームA',
    ];

    echo "--- 1. array_shift() 実行前の連想配列 ---\n";
    print_r($engineerProfile);

    // array_shift() を使用して、配列の最初の要素を取り出します。
    // この場合、'id' キーとその値 '1001' が対象となります。
    // 戻り値は取り出された要素の「値」です。
    $shiftedValue = array_shift($engineerProfile);

    echo "\n--- 2. array_shift() で取り出された要素 ---\n";
    echo "取り出された値: " . $shiftedValue . "\n"; // '1001' が表示されます。

    echo "\n--- 3. array_shift() 実行後の連想配列 ---\n";
    // 'id' 要素が削除され、残りの要素のキーと値はそのまま保持されます。
    print_r($engineerProfile);
}

// 関数を実行して、array_shift() の動作を確認します。
demonstrateArrayShiftWithAssociativeArray();

PHPのarray_shift()関数は、配列の先頭にある要素を一つ取り除き、その値を取り出すための関数です。引数には、変更したい配列そのものを参照渡しで指定します。そのため、関数が実行されると元の配列から先頭の要素が削除され、配列自体が変更されます。戻り値としては、取り除かれた要素の値が返されます。もし配列が空だった場合や、配列ではない変数を渡した場合はnullが返されます。

連想配列に対してarray_shift()を使用した場合、挿入順序における最初のキーと値のペアが対象となります。サンプルコードでは、$engineerProfile配列の最初の要素である'id' => 1001が取り除かれます。取り除かれた値1001は$shiftedValueに格納されますが、元の$engineerProfile配列からは'id'要素が完全に削除されます。その際、残りの要素（'name', 'position', 'team'）のキーと値はそのまま保持され、数値キーのように再インデックスされることはありません。このように、array_shift()は配列の先頭要素を効率的に操作する際に役立ちます。