(PHP 5 >= 5.1.0, PHP 7)
array_diff_ukey — キーを基準にし、コールバック関数を用いて配列の差を計算する
$array1
, array $array2
[, array $...
], callable $key_compare_func
) : array
array1 のキーを
array2 のキーと比較し、その差を返します。
この関数は array_diff() に似ていますが、
値ではなくキーを用いて比較するという点が異なります。
array_diff_key() とは異なり、 内部関数ではなくユーザーが指定したコールバック関数を用いて添字を比較します。
array1比較元の配列。
array2比較する対象となる配列。
...さらに比較する対象となる配列。
key_compare_func比較関数は、最初の引数と二番目の引数の比較結果を返します。最初の引数のほうが二番目の引数より大きい場合は正の数を、二番目の引数と等しい場合はゼロを、そして二番目の引数より小さい場合は負の数を返す必要があります。PHP 7.0.0 より前のバージョンでは、この整数が -2147483648 から 2147483647 までの範囲におさまる必要がありました。
array1 の要素のうち、
その他の配列のいずれにも含まれないものだけを残した配列を返します。
例1 array_diff_ukey() の例
<?php
function key_compare_func($key1, $key2)
{
if ($key1 == $key2)
return 0;
else if ($key1 > $key2)
return 1;
else
return -1;
}
$array1 = array('blue' => 1, 'red' => 2, 'green' => 3, 'purple' => 4);
$array2 = array('green' => 5, 'blue' => 6, 'yellow' => 7, 'cyan' => 8);
var_dump(array_diff_ukey($array1, $array2, 'key_compare_func'));
?>
上の例の出力は以下となります。
array(2) {
["red"]=>
int(2)
["purple"]=>
int(4)
}
注意:
この関数は n 次元配列の一つの次元しかチェックしません。 もちろん、array_diff_ukey($array1[0], $array2[0], 'callback_func'); のようにすることでより深い次元でのチェックもできます。