什麼是PHP 中的array_diff_key() 函數？

M66 2025-05-17

在PHP 中， array_diff_key()函數是用來比較兩個數組的鍵名（key）差異的。它的作用是返回第一個數組中與第二個數組的鍵值（key）不同的元素。如果某個鍵在第二個數組中存在，則該鍵對應的元素會被排除。

這個函數的主要應用場景是，在處理多個關聯數組時，需要找出哪些鍵在一個數組中存在但在另一個數組中缺失。特別是在進行數據過濾或者合併時， array_diff_key()是一個非常有用的工具。

函數語法

array_diff_key(array $array1, array $array2, array ...$arrays): array

參數說明：

$array1 ：第一個數組，用於比較。
$array2 ：第二個數組，用於比較。
$arrays ：可以選擇傳入多個數組進行比較。

返回值：

返回一個新數組，包含所有在$array1中存在但在$array2中缺失的鍵值對。

示例：如何使用array_diff_key()

假設我們有兩個數組$array1和$array2 ，並希望找出哪些鍵在$array1中存在但在$array2中沒有：

 <?php
$array1 = [
    "a" => 1,
    "b" => 2,
    "c" => 3,
    "d" => 4
];

$array2 = [
    "b" => 2,
    "c" => 3
];

$result = array_diff_key($array1, $array2);
print_r($result);
?>

輸出：

 Array
(
    [a] => 1
    [d] => 4
)

在這個例子中， array_diff_key()函數返回了$array1中的鍵a和d ，因為它們在$array2中沒有出現。

多數組比較

如果你想同時比較多個數組，可以傳入多個數組作為參數：

 <?php
$array1 = [
    "a" => 1,
    "b" => 2,
    "c" => 3,
    "d" => 4
];

$array2 = [
    "b" => 2,
    "c" => 3
];

$array3 = [
    "a" => 1,
    "d" => 4
];

$result = array_diff_key($array1, $array2, $array3);
print_r($result);
?>

輸出：

 Array
(
    [a] => 1
)

在這個例子中， array_diff_key()比較了三個數組，最終返回只有a鍵值對，因為它在其他兩個數組中都不存在。

典型應用場景

array_diff_key()常用於以下幾種場景：

數據過濾：例如，在處理用戶數據時，如果你想要找到哪些字段在某個預設的配置中不存在，可以使用此函數進行篩選。
比較配置文件：可以通過此函數比較不同版本的配置數組，找出哪個配置項已經被移除或修改。
處理多維數組的鍵差異：如果你的數組是多維數組，可以結合array_map()等函數進行更複雜的操作，找出不同的鍵值對。

注意事項

array_diff_key()比較的是數組的鍵名，而不是鍵值。如果需要比較數組中的值差異，可以使用array_diff() 。
該函數會保留$array1中的鍵名和鍵值，如果你希望保留的是數組的值而非鍵值對，可以考慮使用其他方法（例如array_values() ）來獲取最終結果。

小結

array_diff_key()是一個非常有用的函數，特別適合用於比較數組的鍵差異。通過這個函數，我們可以輕鬆地找出一個數組中有哪些鍵是其他數組沒有的，從而幫助我們進行數據篩选和處理。在實際開發中，它廣泛應用於數據驗證、配置文件比較和數組的差異化操作。