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

<?php

/**
 * array_replace 関数を使った配列の置換サンプル.
 */
function arrayReplaceExample(): array
{
    $baseArray = ['a' => 'apple', 'b' => 'banana', 'c' => 'cherry'];
    $replacements1 = ['a' => 'apricot', 'd' => 'date'];
    $replacements2 = ['b' => 'blueberry', 'e' => 'elderberry'];

    // array_replace を使って配列を置換
    $replacedArray = array_replace($baseArray, $replacements1, $replacements2);

    return $replacedArray;
}

// サンプル関数の実行と結果の表示
$result = arrayReplaceExample();
print_r($result);

?>

array_replace関数は、PHPの配列を置換するための関数です。この関数を使うことで、複数の配列に基づいて、最初の配列の要素を置き換えることができます。

引数には、最初に置換対象となる配列 $array を指定します。その後、可変長引数 $replacements として、置換に使用する複数の配列を指定します。$replacements に指定された配列は、順番に $array を上書きするように適用されます。

具体的には、$replacements 内の配列のキーが $array に存在する場合、そのキーに対応する $array の値は $replacements の値で置き換えられます。$replacements に $array に存在しないキーが含まれている場合、そのキーと値のペアは $array に追加されます。複数の $replacements 配列が指定された場合、後の配列が前の配列を上書きします。

サンプルコードでは、$baseArray を基本となる配列として、$replacements1 と $replacements2 を使って置換を行っています。$replacements1 によって 'a' の値が 'apricot' に、'd' のキーと値が追加されます。さらに $replacements2 によって 'b' の値が 'blueberry' に、'e' のキーと値が追加されます。

array_replace関数は、置換後の新しい配列を返します。元の配列 $array は変更されません。この関数は、設定の上書きやデフォルト値の適用など、さまざまな場面で役立ちます。

<?php

/**
 * array_replace_recursive のサンプルコード
 *
 * 複数の配列を再帰的に結合し、後の配列の値で前の配列の値を上書きします。
 */

$base = [
    'citrus' => ["orange"],
    'berries' => ["a" => "raspberry", "b" => "blueberry"],
];

$replacements1 = [
    'citrus' => ["pineapple"],
    'berries' => ["blackberry"],
];

$replacements2 = [
    'citrus' => ["grapefruit"],
    'berries' => ["c" => "cranberry"],
];

$result = array_replace_recursive($base, $replacements1, $replacements2);

print_r($result);

/*
出力結果:
Array
(
    [citrus] => Array
        (
            [0] => grapefruit
        )

    [berries] => Array
        (
            [a] => raspberry
            [b] => blueberry
            [0] => blackberry
            [c] => cranberry
        )

)
*/

array_replace_recursive() 関数は、PHP 8 で利用可能な配列操作関数の一つで、複数の配列を再帰的に結合し、後の配列の値で前の配列の値を上書きする際に使用します。この関数は、特に多次元配列の値をマージする際に便利です。

引数 $array は、ベースとなる配列です。引数 $replacements は、上書きに使用する一つまたは複数の配列です。複数の $replacements 配列を指定した場合、後の配列が前の配列を上書きする形で処理されます。

この関数は、配列 $array をベースに、$replacements 配列の内容を再帰的にマージした新しい配列を返します。キーが同じ要素については、$replacements の値で $array の値が上書きされます。キーが数値の場合、$replacements の要素は $array の末尾に追加されます。再帰的な処理により、多次元配列の内部要素も同様にマージされます。

サンプルコードでは、$base 配列をベースに、$replacements1 と $replacements2 の内容を array_replace_recursive() 関数でマージしています。citrus キーの値は、$replacements1 の pineapple で一度上書きされ、さらに $replacements2 の grapefruit で上書きされています。berries キーの値は、連想配列のキー 'a' と 'b' の値は保持され、$replacements1 の blackberry が数値キー 0 で追加され、$replacements2 の cranberry が数値キー 'c' で追加されています。最終的な結果は、print_r() 関数で出力されます。このように、array_replace_recursive() 関数は、配列の構造を保ちつつ、特定の要素を効率的に上書きまたは追加するために役立ちます。