PHPのarray_diff_ukey()関数の使い方を徹底解説

PHPのarray_diff_ukey()関数は、複数の配列のキー（添字）を比較し、その差分を返す関数です。通常の配列比較と異なる点は、キーの比較にユーザー定義のコールバック関数を使用できることです。これにより、大文字小文字の扱いや独自の比較ルールなど、柔軟なキー比較が可能になります。

基本構文

array_diff_ukey(arr1, arr2, arr3, arr4, …, compare_func)

パラメータの詳細

• arr1 − 比較元となる配列。必須のパラメータです。

• arr2 − 比較対象となる配列。必須のパラメータです。

• arr3 − さらに追加で比較したい配列。省略可能です。

• arr4 − さらに追加で比較したい配列。省略可能です。必要に応じて複数指定できます。

• compare_func − キーを比較するためのコールバック関数。この関数は、最初の引数が2番目の引数より「小さい」「等しい」「大きい」と判断される場合に、それぞれ0より「小さい」「等しい」「大きい」整数値を返す必要があります。

戻り値

array_diff_ukey()関数は、最初の配列には存在するが、他のどの配列にも存在しないキーを持つ要素を含む配列を返します。値ではなくキーを基準に差分が計算される点に注意してください。

使用例

以下は、2つの配列のキーをコールバック関数を使って比較するサンプルコードです。

<?php
function compare_func($a, $b) {
   if ($a === $b) {
      return 0;
   }
   return ($a > $b)? 1:-1;
}
$arr1 = array("a" => "laptop", "b" => "keyboard", "c" => "mouse");
$arr2 = array("a" => "laptop", "d" => "mouse");
$res = array_diff_ukey($arr1, $arr2, "compare_func");
print_r($res);
?>

実行結果

Array ( [b] => keyboard [c] => mouse )

解説

この例では、$arr1 のキー「a」「b」「c」と $arr2 のキー「a」「d」を比較しています。キー「a」は両方の配列に存在するため除外され、$arr1 にのみ存在するキー「b」と「c」に対応する要素が結果として返されます。

なお、類似の関数としてarray_diff_key()がありますが、こちらは内部で標準的な比較を行うのに対し、array_diff_ukey()はユーザー定義関数による比較が可能という違いがあります。キーの比較条件を細かく制御したい場合に、array_diff_ukey()が役立ちます。