渡された配列の要素を置き換える

# array_replace

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

array_replace — 渡された配列の要素を置き換える

### 説明

function array_replace(array `$array`, array `...$replacements`): array

array_replace() は、新しい配列を生成し、 指定された配列のそれぞれのキーを新しい配列の要素として割り当てます。 同じキーが複数の配列に存在した場合、 一番最後に指定された配列のものが使われます。

array_replace() は再帰的に要素を処理しませんが、 置き換えを行うときに、それぞれのキーの値全体を置き換えます。

### パラメータ

`array`

  要素を置き換えたい配列。

`replacements`

  置き換えたい要素を含む配列。 後から渡した配列の値のほうが優先されます。

### 戻り値

配列を返します。

### 例

例1 array_replace() の例

    <?php
    $base = array("orange", "banana", "apple", "raspberry");
    $replacements = array(0 => "pineapple", 4 => "cherry");
    $replacements2 = array(0 => "grape");

    $basket = array_replace($base, $replacements, $replacements2);
    var_dump($basket);
    ?>

上の例の出力は以下となります。

    array(5) {
      [0]=>
      string(5) "grape"
      [1]=>
      string(6) "banana"
      [2]=>
      string(5) "apple"
      [3]=>
      string(9) "raspberry"
      [4]=>
      string(6) "cherry"
    }

例2 ネストした配列を、どのように処理するかを示す例

    <?php
    $base = [ 'citrus' => [ 'orange', 'lemon' ], 'pome' => [ 'apple' ] ];
    $replacements = [ 'citrus' => [ 'grapefruit' ] ];
    $replacements2 = [ 'citrus' => [ 'kumquat', 'citron' ], 'pome' => [ 'loquat' ] ];
    $basket = array_replace($base, $replacements, $replacements2);
    var_dump($basket);
    ?>

上の例の出力は以下となります。

    array(2) {
      ["citrus"]=>
      array(2) {
        [0]=>
        string(7) "kumquat"
        [1]=>
        string(6) "citron"
      }
      ["pome"]=>
      array(1) {
        [0]=>
        string(6) "loquat"
      }
    }

### 参考

- array_replace_recursive() - 渡された配列の要素を再帰的に置き換える
- array_merge() - ひとつまたは複数の配列をマージする

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open