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

<?php

/**
 * array_merge_recursive() の挙動を示すサンプルコード。
 * キーが同じ場合、値を再帰的にマージします。
 * 数値キーの場合は、値が重複して追加されます。
 */

$array1 = [
    'color' => ['favorite' => 'red'],
    5,
];

$array2 = [
    10,
    'color' => ['favorite' => 'green', 'blue'],
];

$result = array_merge_recursive($array1, $array2);

print_r($result);
/*
出力結果:
Array
(
    [color] => Array
        (
            [favorite] => Array
                (
                    [0] => red
                    [1] => green
                )

            [0] => blue
        )

    [0] => 5
    [1] => 10
)
*/

/**
 * キーを保持してマージしたい場合は、ループ処理で実装する必要がある。
 */
function array_merge_keep_keys(array ...$arrays): array
{
    $result = [];
    foreach ($arrays as $array) {
        foreach ($array as $key => $value) {
            if (is_int($key)) {
                $result[] = $value;
            } elseif (is_array($value) && isset($result[$key]) && is_array($result[$key])) {
                $result[$key] = array_merge_keep_keys($result[$key], $value);
            } else {
                $result[$key] = $value;
            }
        }
    }
    return $result;
}

$array3 = [
    'color' => ['favorite' => 'red'],
    5,
];

$array4 = [
    10,
    'color' => ['favorite' => 'green', 'blue'],
];

$result2 = array_merge_keep_keys($array3, $array4);

print_r($result2);

/*
出力結果
Array
(
    [color] => Array
        (
            [favorite] => green
            [0] => blue
        )

    [0] => 5
    [1] => 10
)
*/

array_merge_recursive()関数は、複数の配列を再帰的にマージするPHPの組み込み関数です。引数には、マージしたい配列を可変長引数として渡します。戻り値は、マージされた新しい配列です。

この関数は、キーが同じ要素が存在する場合に、その値を再帰的にマージします。もし、同じキーの値が配列同士だった場合は、さらにそれらの配列をマージします。キーが数値の場合は、array_merge()関数と同様に、値が単純に追加され、キーは連番で振り直されます。

サンプルコードでは、$array1と$array2という2つの配列をarray_merge_recursive()でマージしています。$array1の'color'キーと$array2の'color'キーは両方とも配列であるため、それらの配列が再帰的にマージされます。数値キーの 5 と 10 は、新しい配列の [0] と [1] にそれぞれ追加されています。

一方、キーを保持してマージしたい場合は、array_merge_recursive()関数では実現できません。サンプルコードでは、array_merge_keep_keys()というユーザー定義関数で、キーを保持したまま配列を再帰的にマージする例を示しています。この関数では、is_int()関数でキーが数値かどうかを判定し、数値キーの場合は単純に値を追加します。キーが文字列で、かつ値が配列の場合は、再帰的にarray_merge_keep_keys()を呼び出してマージを行います。$array3と$array4をarray_merge_keep_keys()でマージした結果は、キーが保持され、'color'キーの値が上書きされていることがわかります。

<?php

/**
 * array_merge_recursive 関数の動作を示すサンプルコードです。
 *
 * この関数は複数の配列を再帰的に結合します。
 * 'overwrite' というキーワードに対する重要な点は、
 * 同じ文字列キーを持つ要素があった場合、新しい値で既存の値を上書きするのではなく、
 * 両方の値を新しい配列として結合する点です。
 * 数値キーを持つ要素は、単純に追加されます。
 */
function demonstrateArrayMergeRecursive(): void
{
    // 最初の配列を定義します。
    $array1 = [
        'fruit' => 'apple',
        'colors' => ['red', 'green'],
        'details' => [
            'origin' => 'Japan',
            'taste' => 'sweet',
        ],
        0 => 'item_from_array1_index0',
    ];

    // 2番目の配列を定義します。
    // $array1 と同じキーを持つ要素が含まれています。
    $array2 = [
        'fruit' => 'orange', // 'fruit' キーは $array1 にも存在
        'colors' => ['blue'], // 'colors' キーは $array1 にも存在
        'details' => [
            'taste' => 'sour', // 'details' の中の 'taste' キーは $array1 にも存在
            'season' => 'summer', // 新しいキー
        ],
        0 => 'item_from_array2_index0', // 数値キー0は $array1 にも存在
    ];

    echo "--- 元の配列 ---" . PHP_EOL;
    echo "配列 1:" . PHP_EOL;
    print_r($array1);
    echo "配列 2:" . PHP_EOL;
    print_r($array2);
    echo PHP_EOL;

    // array_merge_recursive を使用して配列を結合します。
    // 同じ文字列キーを持つ要素がどのように扱われるかに注目してください。
    $mergedArray = array_merge_recursive($array1, $array2);

    echo "--- array_merge_recursive の結果 ---" . PHP_EOL;
    print_r($mergedArray);
    echo PHP_EOL;

    echo "--- 'overwrite' に関する補足 ---" . PHP_EOL;
    echo "結果を確認すると、'fruit' キーの値は 'orange' で上書きされず、" . PHP_EOL;
    echo "['apple', 'orange'] という新しい配列として結合されていることがわかります。" . PHP_EOL;
    echo "同様に、ネストされた配列の 'details' -> 'taste' も上書きされず、" . PHP_EOL;
    echo "['sweet', 'sour'] として結合されています。" . PHP_EOL;
    echo "数値キー (例: 0) の要素は単純に追加され、新しいインデックスが割り当てられます。" . PHP_EOL;
}

// 関数を実行します。
demonstrateArrayMergeRecursive();

PHPのarray_merge_recursive関数は、複数の配列を再帰的に結合するために利用される拡張機能です。この関数は引数として結合したい複数の配列を受け取り、それらを結合した新しい配列を返します。

この関数の大きな特徴は、同じ文字列キーを持つ要素があった場合の挙動です。通常、配列の結合では後から来た値が前の値を上書き（overwrite）することがありますが、array_merge_recursiveでは値を上書きせず、同じキーの値を新しい配列として結合します。例えば、'fruit' => 'apple' と 'fruit' => 'orange' がある場合、結合結果は'fruit' => ['apple', 'orange'] のようになります。この再帰的な結合は、ネストされた配列に対しても適用されます。一方で、数値キーを持つ要素は、同じキーがあったとしても単純に結合後の配列に追加されます。

このため、既存の値を上書きすることなく、共通のキーに関連するすべての値を新しい配列として保持したい場合に特に有用です。