array_reduce
(PHP 4 >= 4.0.5, PHP 5, PHP 7)
array_reduce — Iteratively reduce the array to a single value using a callback function
Description
array_reduce() applies iteratively the
callback
function to the elements of the
array
, so as to reduce the array to
a single value.
Parameters
-
array
-
The input array.
-
callback
-
-
carry
-
Holds the return value of the previous iteration; in the case of the first iteration it instead holds the value of
initial
. -
item
-
Holds the value of the current iteration.
-
-
initial
-
If the optional
initial
is available, it will be used at the beginning of the process, or as a final result in case the array is empty.
Return Values
Returns the resulting value.
If the array is empty and initial
is not passed,
array_reduce() returns NULL
.
Examples
Example #1 array_reduce() example
<?php
function sum($carry, $item)
{
$carry += $item;
return $carry;
}
function product($carry, $item)
{
$carry *= $item;
return $carry;
}
$a = array(1, 2, 3, 4, 5);
$x = array();
var_dump(array_reduce($a, "sum")); // int(15)
var_dump(array_reduce($a, "product", 10)); // int(1200), because: 10*1*2*3*4*5
var_dump(array_reduce($x, "sum", "No data to reduce")); // string(17) "No data to reduce"
?>
See Also
- array_filter() - Filters elements of an array using a callback function
- array_map() - Applies the callback to the elements of the given arrays
- array_unique() - Removes duplicate values from an array
- array_count_values() - Counts all the values of an array
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-function.array-reduce.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.