array_walk

(PHP 4, PHP 5, PHP 7, PHP 8)

array_walk使用用戶自定義函數對數組中的每個元素做回調處理

說明

array_walk(array|object &$array, callable $callback, mixed $arg = null): bool

將用戶自定義函數 funcname 應用到 array 數組中的每個單元。

array_walk() 不會受到 array 內部數組指針的影響。array_walk() 會遍歷整個數組而不管指針的位置。

參數

array

輸入的數組。

callback

典型情況下 callback 接受兩個參數。array 參數的值作為第一個,鍵名作為第二個。

注意:

如果 callback 需要直接作用于數組中的值,則給 callback 的第一個參數指定為引用。這樣任何對這些單元的改變也將會改變原始數組本身。

注意:

參數數量超過預期,傳入內置函數 (例如 strtolower()), 將拋出警告,所以不適合當做 funcname。

只有 array 的值才可以被改變,用戶不應在回調函數中改變該數組本身的結構。例如增加/刪除單元,unset 單元等等。如果 array_walk() 作用的數組改變了,則此函數的的行為未經定義,且不可預期。

arg

如果提供了可選參數 arg,將被作為第三個參數傳遞給 callback。

返回值

返回 true

更新日志

版本 說明
8.0.0 如果 callback 期待通過引用傳遞第二個和第三個參數, 此函數現在將拋出 E_WARNING

錯誤/異常

從 PHP 7.1.0 起,如果 callback 函數需要的參數(數組成員的值和鍵)超過2個或者 也傳遞了 arg 參數需要的參數超過3個時,會拋出 ArgumentCountError。 在此之前,每次 array_walk() 調用 callback 的時候都會生成 E_WARNING 級別的錯誤。

范例

示例 #1 array_walk() 例子

<?php
$fruits 
= array("d" => "lemon""a" => "orange""b" => "banana""c" => "apple");

function 
test_alter(&$item1$key$prefix)
{
    
$item1 "$prefix$item1";
}

function 
test_print($item2$key)
{
    echo 
"$key$item2\n";
}

echo 
"Before ...:\n";
array_walk($fruits'test_print');

array_walk($fruits'test_alter''fruit');
echo 
"... and after:\n";

array_walk($fruits'test_print');
?>

以上例程會輸出:

Before ...:
d. lemon
a. orange
b. banana
c. apple
... and after:
d. fruit: lemon
a. fruit: orange
b. fruit: banana
c. fruit: apple

參見

  • array_walk_recursive() - 對數組中的每個成員遞歸地應用用戶函數
  • iterator_apply() - 為迭代器中每個元素調用一個用戶自定義函數
  • list() - 把數組中的值賦給一組變量
  • each() - 返回數組中當前的鍵/值對并將數組指針向前移動一步
  • call_user_func_array() - 調用回調函數,并把一個數組參數作為回調函數的參數
  • array_map() - 為數組的每個元素應用回調函數
  • foreach