説明

array_diff_assoc(array $array, array ...$arrays): array

array を arrays と比較し、その差を返します。array_diff() とは異なり、配列のキーも用いて比較を行います。

パラメータ

array: 比較元の配列。
arrays: 比較する対象となる配列。

戻り値

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

変更履歴

バージョン説明

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

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

例

例1 array_diff_assoc() の例

この例で、"a" => "green" の組が両方の配列に現れており、このため、この関数の出力には含まれていません。これとは異なり、0 => "red" は出力の中に現れています。これは、最初の配列の "red" のキーには自動的に 0 が割り当てられる一方で、二番目の配列では 0 には既に yellow というキーがあるため、 "red" には 1 が割り当てられるためです。

<?php
$array1 = array("a" => "green", "b" => "brown", "c" => "blue", "red");
$array2 = array("a" => "green", "yellow", "red");
$result = array_diff_assoc($array1, $array2);
print_r($result);
?>

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

Array
(
    [b] => brown
    [c] => blue
    [0] => red
)

例2 array_diff_assoc() の例

key => value の組からの二つの値は、 (string) $elem1 === (string) $elem2 が成り立つ場合のみ等しいと見なされます。言い替えると、厳密なチェックが行われるため、文字列表現が同じである必要があります。

<?php
$array1 = array(0, 1, 2);
$array2 = array("00", "01", "2");
$result = array_diff_assoc($array1, $array2);
print_r($result);
?>

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

Array
(
    [0] => 0
    [1] => 1
)

注意

注意: この関数は、N 次元配列の一次元だけを調べます。例えば array_diff_assoc($array1[0], $array2[0]); とすることにより、より深い次元でチェックを行うことも可能です。

注意: 同様の配列で、より多くのキーがあるものを比較するときには、引数を正しい順で渡すようにしましょう。新しい配列が、リストの先頭になければいけません。

参考

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