array_uintersect

(PHP 5, PHP 7, PHP 8)

array_uintersect — データの比較にコールバック関数を用い、配列の共通項を計算する

説明

array_uintersect(array $array, array ...$arrays, callable $value_compare_func): array

データの比較にコールバック関数を用い、配列の共通項を計算します。

パラメータ

array: 最初の配列。
arrays: 比較対象の配列。
value_compare_func: 比較関数は、最初の引数と二番目の引数の比較結果を返します。最初の引数のほうが二番目の引数より大きい場合は正の整数を、二番目の引数と等しい場合はゼロを、そして二番目の引数より小さい場合は負の整数を返す必要があります。

callback(mixed $a, mixed $b): int

警告
float のような 非整数 を比較関数が返すと、その返り値を内部的に int にキャストして使います。つまり、0.99 や 0.1 といった値は整数値 0 にキャストされ、値が等しいとみなされます。

警告
ソートに使うコールバック関数は、任意の配列からの任意の値を、もともとの順番に関係なく、任意の順番で処理できなければいけません。なぜなら、個々の配列は、他の配列と比較する前に最初にソートされるからです。サンプルコードは、以下のようになります:

<?php $arrayA = ["string", 1]; $arrayB = [["value" => 1]]; // $item1 と $item2 は "string", 1, ["value" => 1] のいずれでも構いません $compareFunc = static function ($item1, $item2) { $value1 = is_string($item1) ? strlen($item1) : (is_array($item1) ? $item1["value"] : $item1); $value2 = is_string($item2) ? strlen($item2) : (is_array($item2) ? $item2["value"] : $item2); return $value1 <=> $value2; }; ?>

戻り値

他の全ての引数に存在する array の値を全て有する配列を返します。

例

例1 array_uintersect() の例

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

print_r(array_uintersect($array1, $array2, "strcasecmp"));
?>

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

Array
(
    [a] => green
    [b] => brown
    [0] => red
)

参考

array_intersect() - 配列の共通項を計算する
array_intersect_assoc() - 追加された添字の確認も含めて配列の共通項を確認する
array_uintersect_assoc() - データの比較にコールバック関数を用い、追加された添字の確認も含めて配列の共通項を計算する
array_uintersect_uassoc() - データと添字の比較に個別のコールバック関数を用い、追加された添字の確認も含めて配列の共通項を計算する

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 4 notes

down

Nate at RuggFamily dot com ¶

17 years ago

I want to stress that in the user function, you do need to return either a 1 or a -1 properly; you cannot simply return 0 if the results are equal and 1 if they are not.  

The following code is incorrect:

<?php
function myfunction($v1,$v2) 
{
if ($v1===$v2)
    {
    return 0;
    }
return 1;
}

$a1=array(1, 2, 4);
$a2=array(1, 3, 4);
print_r(array_uintersect($a1,$a2,"myfunction"));
?>

This code is correct:

<?php
function myfunction($v1,$v2) 
{
if ($v1===$v2)
    {
    return 0;
    }
if ($v1 > $v2) return 1;
return -1;
}
$a1=array(1, 2, 4);
$a2=array(1, 3, 4);
print_r(array_uintersect($a1,$a2,"myfunction"));
?>

down

Ryan C ¶

2 years ago

If you're rolling your own comparison function, keep in mind that the spaceship operator (i.e. <=>) can be your best friend. It's been around since PHP7. https://www.php.net/manual/en/language.operators.comparison.php

So, for instance, instead of a clunky function like:

<?php
function myFunction($v1, $v2) {
   if ($v1 === $v2) {
      return 0;
   }
   if ($v1 > $v2) return 1;
   return -1;
}
?>

You can simplify it to:

<?php
function myFunction($v1, $v2) {
   return $v1 <=> $v2;
}
?>

down

rob dot c dot ruiz at gmail dot com ¶

6 years ago

When trying to do a case insensitive comparison between arrays of words, the strcasecmp function works very nicely with this one like so: 

$arr1 = array('blue', 'green', 'red');

$arr2 = array('BLUE', 'Purple', 'Red');

$loose_matches = array_uintersect($arr1, $arr2, 'strcasecmp');

print_r($loose_matches) // array('blue', 'red');

down

Hayley Watson ¶

6 years ago

As for the other "compare function" callbacks, the return value from the callback function doesn't need to be -1, 0, or 1.

cmp($a,$b) just needs to be <0, =0, or >0 depending on whether $a<$b, $a=$b, or $a>$b.

＋add a note