【PHP8.x】array_diff_ukey関数の使い方

array_diff_ukey関数は、複数の配列間でキーを比較し、最初の配列にのみ存在する要素を抽出する関数です。この関数は、キーの比較にユーザーが定義したコールバック関数を使用する点が最大の特徴です。通常の配列比較関数ではキーが完全に一致するかどうかで判断しますが、array_diff_ukey関数を使用することで、キーに独自の比較ルールを適用できます。

比較に使用するコールバック関数は、二つのキーを引数として受け取ります。そして、それらのキーの大小関係に応じて負の整数（最初のキーが小さい）、ゼロ（キーが等しい）、または正の整数（最初のキーが大きい）を返さなければなりません。この柔軟な比較メカニズムにより、キーの大文字・小文字を区別しない比較や、数値キーと文字列キーの変換を伴う比較など、複雑な条件での差分検出が可能になります。

本関数は、最初の配列（$array1）に存在する要素のうち、それ以降に指定されたどの比較対象配列にもキーが存在しない要素のみを、新しい配列として返します。システムエンジニアを目指す方にとって、特定の条件でキーを区別したい場面で非常に役立つでしょう。

<?php
// キーを比較するためのカスタムコールバック関数を定義します。
function compare_keys($key1, $key2) {
    if ($key1 == $key2) {
        return 0;
    }
    return ($key1 > $key2) ? 1 : -1;
}

// 最初の配列
$array_a = ['apple' => 10, 'banana' => 20, 'cherry' => 30];
// 比較対象の配列
$array_b = ['banana' => 40, 'date' => 50];

// array_diff_ukey を使用して、カスタム関数に基づいてキーの差分を取得します。
// array_a にのみ存在するキーを、compare_keys 関数を使って array_b と比較し特定します。
$result_array = array_diff_ukey($array_a, $array_b, 'compare_keys');
?>

array $array1, array ...$arrays, callable $key_compare_func

• array $array1: 比較対象となる最初の配列
• array ...$arrays: 比較対象となる追加の配列（複数指定可能）
• callable $key_compare_func: 配列のキーを比較するために使用するコールバック関数

array

指定されたコールバック関数で比較した結果、配列 $array1 にのみ存在する要素で構成される新しい配列を返します。