キーを基準にして配列の差を計算する

# array_diff_key

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

array_diff_key — キーを基準にして配列の差を計算する

### 説明

function array_diff_key(array `$array`, array `...$arrays`): array

`array` のキーを `arrays` のキーと比較し、その差を返します。 この関数は array_diff() に似ていますが、 値ではなくキーを用いて比較するという点が異なります。

### パラメータ

`array`

  比較元の配列。

`arrays`

  比較する対象となる配列。

### 戻り値

`array` の要素のうち、 その他の配列のいずれにも含まれないキーのものだけを残した配列を返します。

### 変更履歴

バージョン | 説明
--- | ---
8.0.0 | この関数は、引数をひとつだけ渡しても呼び出せるようになりました。 これより前のバージョンでは、少なくともふたつの引数が必須でした。

### 例

例1 array_diff_key() の例

ふたつの `key => value` のペアが等しいとみなされるのは、 `(string) $key1 === (string) $key2` である場合のみです。つまり、厳密な型チェックを行うということです。 文字列表現が一致しなければなりません。

    <?php
    $array1 = array('blue'  => 1, 'red'  => 2, 'green'  => 3, 'purple' => 4);
    $array2 = array('green' => 5, 'yellow' => 7, 'cyan' => 8);

    var_dump(array_diff_key($array1, $array2));
    ?>

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

    array(3) {
      ["blue"]=>
      int(1)
      ["red"]=>
      int(2)
      ["purple"]=>
      int(4)
    }

    <?php
    $array1 = array('blue' => 1, 'red'  => 2, 'green' => 3, 'purple' => 4);
    $array2 = array('green' => 5, 'yellow' => 7, 'cyan' => 8);
    $array3 = array('blue' => 6, 'yellow' => 7, 'mauve' => 8);

    var_dump(array_diff_key($array1, $array2, $array3));
    ?>

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

    array(2) {
      ["red"]=>
      int(2)
      ["purple"]=>
      int(4)
    }

### 注意

> 注意:

> この関数は n 次元配列の一つの次元しかチェックしません。 もちろん、`array_diff_key($array1[0], $array2[0]);` のようにすることでより深い次元でのチェックもできます。

### 参考

- array_diff() - 配列の差を計算する
- array_udiff() - データの比較にコールバック関数を用い、配列の差を計算する
- array_diff_assoc() - 追加された添字の確認を含めて配列の差を計算する
- array_diff_uassoc() - ユーザーが指定したコールバック関数を利用し、 追加された添字の確認を含めて配列の差を計算する
- array_udiff_assoc() - データの比較にコールバック関数を用い、 追加された添字の確認を含めて配列の差を計算する
- array_udiff_uassoc() - データと添字の比較にコールバック関数を用い、 追加された添字の確認を含めて配列の差を計算する
- array_diff_ukey() - キーを基準にし、コールバック関数を用いて配列の差を計算する
- array_intersect() - 配列の共通項を計算する
- array_intersect_assoc() - 追加された添字の確認も含めて配列の共通項を確認する
- array_intersect_uassoc() - 追加された添字の確認も含め、コールバック関数を用いて 配列の共通項を確認する
- array_intersect_key() - キーを基準にして配列の共通項を計算する
- array_intersect_ukey() - キーを基準にし、コールバック関数を用いて 配列の共通項を計算する

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