関数 array_reduce

関数 array_reduce は、コールバックを使用して配列を単一の値に縮約（還元）します。

最初のパラメータとして配列を受け取り、 2番目のパラメータとして、配列の各要素に順番に適用されるコールバックを受け取ります。

3番目のオプションパラメータは、配列の縮約を開始する初期値です。デフォルトではこのパラメータの値は null です。

コールバック関数は2つの値をパラメータとして受け取ります。最初の値には、前回のイテレーションの結果値が含まれます。一方、最初のイテレーションでは、 3番目のパラメータの値が含まれます。

そして、コールバックの2番目の値には配列の現在の要素が含まれます。

コールバックは配列の各要素に順番に適用されます。現在のイテレーションでコールバックが返す値は、次のイテレーションでのコールバックの最初のパラメータに入ります。

このようにして、コールバックは順番に配列の各要素に適用され、最終的にある値が得られます。この値が関数 array_reduce の結果となります。

構文

array_reduce(array $array, callable $callback, mixed $initial = null): mixed

配列の要素の合計を求めてみましょう：

<?php
	$arr = [1, 2, 3, 4, 5];
	
	function func($prev, $elem)
	{
		return $prev + $elem;
	}
	
	$res = array_reduce($arr, 'func', 0);
	echo $res;
?>

コードの実行結果：

15