array_diff
(PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8)
array_diff — 配列の差を計算する
説明
array
を他の配列と比較し、
array
の要素の中で他の配列には存在しないものだけを返します。
パラメータ
array
-
比較元の配列。
arrays
-
比較対象の配列。
戻り値
array
のエントリのうち、他のどの配列にも含まれない要素のみを含む配列を返します。
array
の配列のキーは維持されます。
変更履歴
バージョン | 説明 |
---|---|
8.0.0 | この関数は、引数をひとつだけ渡しても呼び出せるようになりました。 これより前のバージョンでは、少なくともふたつの引数が必須でした。 |
例
例1 array_diff() の例
<?php
$array1 = array("a" => "green", "red", "blue", "red");
$array2 = array("b" => "green", "yellow", "red");
$result = array_diff($array1, $array2);
print_r($result);
?>
$array1 に複数存在する場合でも全て同様に処理されます。 この出力は次の通りです。
Array ( [1] => blue )
例2 型が一致しない場合の array_diff() の例
(string) $elem1 === (string) $elem2
の場合のみ、
つまり、文字列表現 が同等な場合のみ、
2つの要素は等しいとみなされます。
<?php
// 以下の例は、配列が文字列にキャストできないので警告が発生します
$source = [1, 2, 3, 4];
$filter = [3, 4, [5], 6];
$result = array_diff($source, $filter);
// 一方で、以下の例は問題ありません。なぜなら、オブジェクトは文字列にキャストできるからです。
class S {
private $v;
public function __construct(string $v) {
$this->v = $v;
}
public function __toString() {
return $this->v;
}
}
$source = [new S('a'), new S('b'), new S('c')];
$filter = [new S('b'), new S('c'), new S('d')];
$result = array_diff($source, $filter);
// $result には、S('a') のインスタンスが一つ含まれます。
?>
別の比較関数を使いたい場合は、array_udiff() を参照ください。
注意
注意:
この関数は n 次元配列の一つの次元しかチェックしません。 もちろん、
array_diff($array1[0], $array2[0]);
のようにすることでより深い次元でのチェックもできます。
参考
- array_diff_assoc() - 追加された添字の確認を含めて配列の差を計算する
- array_udiff() - データの比較にコールバック関数を用い、配列の差を計算する
- array_intersect() - 配列の共通項を計算する
- array_intersect_assoc() - 追加された添字の確認も含めて配列の共通項を確認する
+add a note
User Contributed Notes 29 notes
nilsandre at gmx dot de ¶
17 years ago
Again, the function's description is misleading right now. I sought a function, which (mathematically) computes A - B, or, written differently, A \ B. Or, again in other words, suppose
A := {a1, ..., an} and B:= {a1, b1, ... , bm}
=> array_diff(A,B) = {a2, ..., an}
array_diff(A,B) returns all elements from A, which are not elements of B (= A without B).
You should include this in the documentation more precisely, I think.
Anonymous ¶
18 years ago
array_diff provides a handy way of deleting array elements by their value, without having to unset it by key, through a lengthy foreach loop and then having to rekey the array.
<?php
//pass value you wish to delete and the array to delete from
function array_delete( $value, $array)
{
$array = array_diff( $array, array($value) );
return $array;
}
?>
james dot PLZNOSPAM at bush dot cc ¶
7 years ago
If you want a simple way to show values that are in either array, but not both, you can use this:
<?php
function arrayDiff($A, $B) {
$intersect = array_intersect($A, $B);
return array_merge(array_diff($A, $intersect), array_diff($B, $intersect));
}
?>
If you want to account for keys, use array_diff_assoc() instead; and if you want to remove empty values, use array_filter().
wes dot melton at gmail dot com ¶
7 years ago
It's important to note that array_diff() is NOT a fast or memory-efficient function on larger arrays.
In my experience, when I find myself running array_diff() on larger arrays (50+ k/v/pairs) I almost always realize that I'm working the problem from the wrong angle.
Typically, when reworking the problem to not require array_diff(), especially on bigger datasets, I find significant performance improvements and optimizations.
Al Amin Chayan (mail at chayan dot me) ¶
4 years ago
<?php
/**
* Check If An Array Is A Subset Of Another Array
*
* @param array $subset
* @param array $set
* @return bool
*/
function is_subset(array $subset, array $set): bool {
return (bool)!array_diff($subset, $set);
}
$u = [1, 5, 6, 8, 10];
$a = [1, 5];
$b = [6, 7];
var_dump(is_subset($a, $u)); // true
var_dump(is_subset($b, $u)); // false
xmgr2 at protonmail dot com ¶
3 months ago
The description is kinda ambiguous at first glance, one might think that the array_diff function returns the differences across *all* given arrays (which is what I was actually looking for, and that's why I was surprised that, in the example code, the result did not include "yellow").
However, i wrote a neat oneliner to compute the differences across all given arrays:
<?php
# Returns an array with values that are unique across all of the given arrays
function array_unique_values(...$arrays) {
return array_keys(array_filter(array_count_values(array_merge(...$arrays)), fn($count) => $count === 1));
}
# Example:
$array1 = ['a', 'b', 'c', 'd'];
$array2 = ['a', 'b', 'x', 'y'];
$array3 = ['a', '1', 'y', 'z'];
print_r(array_unique_values($array1, $array2, $array3));
?>
Result:
Array
(
[0] => c
[1] => d
[2] => x
[3] => 1
[4] => z
)
Jeppe Utzon ¶
12 years ago
If you just need to know if two arrays' values are exactly the same (regardless of keys and order), then instead of using array_diff, this is a simple method:
<?php
function identical_values( $arrayA , $arrayB ) {
sort( $arrayA );
sort( $arrayB );
return $arrayA == $arrayB;
}
// Examples:
$array1 = array( "red" , "green" , "blue" );
$array2 = array( "green" , "red" , "blue" );
$array3 = array( "red" , "green" , "blue" , "yellow" );
$array4 = array( "red" , "yellow" , "blue" );
$array5 = array( "x" => "red" , "y" => "green" , "z" => "blue" );
identical_values( $array1 , $array2 ); // true
identical_values( $array1 , $array3 ); // false
identical_values( $array1 , $array4 ); // false
identical_values( $array1 , $array5 ); // true
?>
The function returns true only if the two arrays contain the same number of values and each value in one array has an exact duplicate in the other array. Everything else will return false.
my alternative method for evaluating if two arrays contain (all) identical values:
<?php
sort($a); $sort(b); return $a == $b;
?>
may be slightly faster (10-20%) than this array_diff method:
<?php
return ( count( $a ) == count( $b ) && !array_diff( $a , $b ) ? true : false );
?>
but only when the two arrays contain the same number of values and then only in some cases. Otherwise the latter method will be radically faster due to the use of a count() test before the array_diff().
Also, if the two arrays contain a different number of values, then which method is faster will depend on whether both arrays need to be sorted or not. Two times sort() is a bit slower than one time array_diff(), but if one of the arrays have already been sorted, then you only have to sort the other array and this will be almost twice as fast as array_diff().
Basically: 2 x sort() is slower than 1 x array_diff() is slower than 1 x sort().
firegun at terra dot com dot br ¶
15 years ago
Hello guys,
I´ve been looking for a array_diff that works with recursive arrays, I´ve tried the ottodenn at gmail dot com function but to my case it doesn´t worked as expected, so I made my own. I´ve haven´t tested this extensively, but I´ll explain my scenario, and this works great at that case :D
We got 2 arrays like these:
<?php
$aArray1['marcie'] = array('banana' => 1, 'orange' => 1, 'pasta' => 1);
$aArray1['kenji'] = array('apple' => 1, 'pie' => 1, 'pasta' => 1);
$aArray2['marcie'] = array('banana' => 1, 'orange' => 1);
?>
As array_diff, this function returns all the items that is in aArray1 and IS NOT at aArray2, so the result we should expect is:
<?php
$aDiff['marcie'] = array('pasta' => 1);
$aDiff['kenji'] = array('apple' => 1, 'pie' => 1, 'pasta' => 1);
?>
Ok, now some comments about this function:
- Different from the PHP array_diff, this function DON´T uses the === operator, but the ==, so 0 is equal to '0' or false, but this can be changed with no impacts.
- This function checks the keys of the arrays, array_diff only compares the values.
I realy hopes that this could help some1 as I´ve been helped a lot with some users experiences. (Just please double check if it would work for your case, as I sad I just tested to a scenario like the one I exposed)
<?php
function arrayRecursiveDiff($aArray1, $aArray2) {
$aReturn = array();
foreach ($aArray1 as $mKey => $mValue) {
if (array_key_exists($mKey, $aArray2)) {
if (is_array($mValue)) {
$aRecursiveDiff = arrayRecursiveDiff($mValue, $aArray2[$mKey]);
if (count($aRecursiveDiff)) { $aReturn[$mKey] = $aRecursiveDiff; }
} else {
if ($mValue != $aArray2[$mKey]) {
$aReturn[$mKey] = $mValue;
}
}
} else {
$aReturn[$mKey] = $mValue;
}
}
return $aReturn;
}
?>
SeanECoates at !donotspam!yahoo dot ca ¶
23 years ago
I just came upon a really good use for array_diff(). When reading a dir(opendir;readdir), I _rarely_ want "." or ".." to be in the array of files I'm creating. Here's a simple way to remove them:
<?php
$someFiles = array();
$dp = opendir("/some/dir");
while($someFiles[] = readdir($dp));
closedir($dp);
$removeDirs = array(".","..");
$someFiles = array_diff($someFiles, $removeDirs);
foreach($someFiles AS $thisFile) echo $thisFile."\n";
?>
S
Prakashgun ¶
7 years ago
If duplicate value comes in the first array, that will be also included. See in the output "blue" comes twice.
<?php
$array1 = array("a" => "green", "red", "blue", "red", "blue");
$array2 = array("b" => "green", "yellow", "red");
$result = array_diff($array1, $array2);
print_r($result);
//Output
//Array ( [1] => blue [3] => blue )
merlyn dot tgz at gmail dot com ¶
12 years ago
There is more fast implementation of array_diff, but with some limitations. If you need compare two arrays of integers or strings you can use such function:
public static function arrayDiffEmulation($arrayFrom, $arrayAgainst)
{
$arrayAgainst = array_flip($arrayAgainst);
foreach ($arrayFrom as $key => $value) {
if(isset($arrayAgainst[$value])) {
unset($arrayFrom[$key]);
}
}
return $arrayFrom;
}
It is ~10x faster than array_diff
php > $t = microtime(true);$a = range(0,25000); $b = range(15000,500000); $c = array_diff($a, $b);echo microtime(true) - $t;
4.4335179328918
php > $t = microtime(true);$a = range(0,25000); $b = range(15000,500000); $c = arrayDiffEmulation($a, $b);echo microtime(true) - $t;
0.37219095230103
Anonymous ¶
9 years ago
I always wanted something like this to avoid listing all the files and folders you want to exclude in a project directory.
function array_preg_diff($a, $p) {
foreach ($a as $i => $v)
if (preg_match($p, $v))
unset($a[$i]);
return $a;
}
$relevantFiles = array_preg_diff(scandir('somedir'), '/^\./');
instead of
$relevantFiles = array_diff(scandir('somedir'), array('.', '..', '.idea', '.project));
Tim Trefren ¶
16 years ago
Here's a little wrapper for array_diff - I found myself needing to iterate through the edited array, and I didn't need to original keys for anything.
<?php
function arrayDiff($array1, $array2){
# This wrapper for array_diff rekeys the array returned
$valid_array = array_diff($array1,$array2);
# reinstantiate $array1 variable
$array1 = array();
# loop through the validated array and move elements to $array1
# this is necessary because the array_diff function returns arrays that retain their original keys
foreach ($valid_array as $valid){
$array1[] = $valid;
}
return $array1;
}
?>
merlinyoda at dorproject dot net ¶
16 years ago
As touched on in kitchin's comment of 19-Jun-2007 03:49 and nilsandre at gmx dot de's comment of 17-Jul-2007 10:45, array_diff's behavior may be counter-intuitive if you aren't thinking in terms of set theory.
array_diff() returns a *mathematical* difference (a.k.a. subtraction) of elements in array A that are in array B and *not* what elements are different between the arrays (i.e. those that elements that are in either A or B but aren't in both A and B).
Drawing one of those Ven diagrams or Euler diagrams may help with visualization...
As far as a function for returning what you may be expecting, here's one:
<?php
function array_xor ($array_a, $array_b) {
$union_array = array_merge($array_a, $array_b);
$intersect_array = array_intersect($array_a, $array_b);
return array_diff($union_array, $intersect_array)
}
?>
Anonymous ¶
21 years ago
From the page:
Note: Please note that this function only checks one dimension of a n-dimensional array. Of course you can check deeper dimensions by using array_diff($array1[0], $array2[0]);
I've found a way to bypass that. I had 2 arrays made of arrays.
I wanted to extract from the first array all the arrays not found in the second array. So I used the serialize() function:
<?php
function my_serialize(&$arr,$pos){
$arr = serialize($arr);
}
function my_unserialize(&$arr,$pos){
$arr = unserialize($arr);
}
//make a copy
$first_array_s = $first_array;
$second_array_s = $second_array;
// serialize all sub-arrays
array_walk($first_array_s,'my_serialize');
array_walk($second_array_s,'my_serialize');
// array_diff the serialized versions
$diff = array_diff($first_array_s,$second_array_s);
// unserialize the result
array_walk($diff,'my_unserialize');
// you've got it!
print_r($diff);
?>
emeka dot echeruo at gmail dot com ¶
8 years ago
Resubmitting... the update for takes into account comparison issues
Computes the difference of all the arrays
<?php
/**
* array_diffs — Computes the difference of all the arrays
*
* @param array
*
* array1 - The array to compare from and against
* array2 - The array to compare from and against
* array(n) - More arrays to compare from and against
*
* @return array Returns all the arrays that do contains entries that cannot be matched in any of the arrays.
*/
function array_diffs() {
$count = func_num_args();
if($count < 2) {
trigger_error('Must provide at least 2 arrays for comparison.');
}
$check = array();
$out = array();
//resolve comparison issue
$func = function($a, $b) {
$dbl = function($i, $d) {
$e = 0.00001;
if(abs($i-$d) < $e) {
return true;
}
return false;
};
if((gettype($a) == 'integer' && gettype($b['value']) == 'double') || (gettype($a) == 'double' && gettype($b['value']) == 'integer')) {
if((gettype($a) == 'integer' && $dbl((double) $a, $b['value'])) || (gettype($b['value']) == 'integer' && $dbl((double) $b['value'], $a))) {
return true;
}
} elseif((gettype($a) == 'double') && (gettype($b['value']) == 'double')) {
return $dbl($a,$b['value']);
} elseif($a == $b['value']) {
return true;
}
return false;
};
for($i = 0; $i < $count; $i++) {
if(!is_array(func_get_arg($i))) {
trigger_error('Parameters must be passed as arrays.');
}
foreach(func_get_arg($i) as $key => $value) {
if(is_numeric($key) && is_string($value)) {
if(array_key_exists($value, $check) && $func($value, $check[$value])) {
$check[$value]['count'] = $check[$value]['count'] + 1;
} else {
$check[$value]['value'] = $value;
$check[$value]['count'] = 1;
}
} elseif(is_numeric($key) && (is_bool($value) || is_null($value) || is_numeric($value) || is_object($value) || is_resource($value))) {
$update = false;
foreach($check as $check_key => $check_value) {
if(is_numeric($key) && (is_bool($check_value['value']) || is_null($check_value['value']) || is_numeric($check_value['value']) || is_object($check_value['value']) || is_resource($check_value['value'])) && $func($value, $check_value)) {
$update = true;
$check[$check_key]['count'] = $check[$check_key]['count'] + 1;
}
}
if(!$update) {
$check[] = array('value' => $value, 'count' => 1);
}
} else {
if(array_key_exists($key, $check) && $func($value, $check[$key])) {
$check[$key]['count'] = $check[$key]['count'] + 1;
} else {
$check[$key]['value'] = $value;
$check[$key]['count'] = 1;
}
}
}
}
foreach($check as $check_key => $check_value) {
if($check_value['count'] == 1) {
for ($i = 0; $i < $count; $i++) {
foreach(func_get_arg($i) as $key => $value) {
if(is_numeric($key) && is_string($value) && ($value == (string) $check_key)) {
$out[$i][$key] = $value;
} elseif(is_numeric($key) && ($check_value['value'] == $value)) {
$out[$i][$key] = $value;
} elseif(is_string($key) && ($check_value['value'] == $value)) {
$out[$i][$key] = $value;
}
}
}
}
}
return $out;
}
?>