PHPのarray_uintersect_assoc()関数とは？使い方とサンプルコード解説

array_uintersect_assoc()関数は、複数の配列の「キー」と「値」を比較し、共通する要素のみを抽出して新しい配列として返す関数です。キーの比較は通常の方法で行われますが、値の比較にはユーザーが定義したコールバック関数が使用される点が特徴です。

構文

array_uintersect_assoc(arr1, arr2, arr3, …, compare_func)

パラメータ

• arr1 − 比較の基準となる最初の配列。

• arr2 − 最初の配列と比較する2番目の配列。

• arr3 − さらに比較したい場合に指定する追加の配列（複数指定可能）。

• compare_func − 値の比較に使用されるユーザー定義のコールバック関数。最初の引数が2番目の引数より小さいとみなされる場合は負の整数、等しい場合は0、大きいとみなされる場合は正の整数を返す必要があります。

戻り値

array_uintersect_assoc()関数は、1番目の配列の要素のうち、キーが一致し、かつコールバック関数による値の比較でも等しいと判断された要素だけを集めた配列を返します。

例

以下は、array_uintersect_assoc()関数を使用したサンプルコードです。

<?php
function compare_func($a, $b) {
    if ($a === $b) {
        return 0;
    }
    return ($a > $b) ? 1 : -1;
}
$arr1 = array("p"=>"one", "q"=>"two", "r"=>"three");
$arr2 = array("p"=>"five", "q"=>"four", "r"=>"three");
$res = array_uintersect_assoc($arr1, $arr2, "compare_func");
print_r($res);
?>

この例では、$arr1と$arr2の両方にキー「r」と値「three」を持つ要素が存在するため、その要素だけが結果として返されます。キーが同じでも値が異なる「p」「q」の要素は除外されている点に注目してください。

出力

Array (
    [r] => three
)