PHP 8.1.31 Released!

array_map

(PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8)

array_mapПрименяет callback-функцию к элементам массивов

Описание

array_map(?callable $callback, array $array, array ...$arrays): array

Функция array_map() возвращает массив (array), который содержит результаты обработки callback-функцией значений массива array, и значений массивов arrays, если в функцию передали больше одного массива, которые функция передаёт как аргументы в callback-функцию. При вызове функции array_map() проверяют, чтобы количество массивов, которое передают в функцию, совпадало с количеством параметров callback-функции. Функция проигнорирует лишние входные массивы. При передаче недостаточного количества аргументов функция выбросит исключение ArgumentCountError.

Список параметров

callback

Значение с типом callable, которое функция вызовет на каждом элементе в каждом массиве.

При передаче аргумента callback со значением null функция выполнит с массивами zip-операцию и вернёт массив массивов, каждый из которых содержит элементы входных массивов с одними и теми же индексами, как в примере ниже. Функция array_map() вернёт входной массив, если передали только аргумент array.

array

Массив, который функция передаст в callback-функцию.

arrays

Дополнительные массивы для обработки callback-функцией.

Возвращаемые значения

Функция возвращает массив, который содержит результаты обработки callback-функцией значений массива array, и значений массивов arrays, если в функцию передали больше одного массива, которые функция передаёт как аргументы в callback-функцию.

Массив, который вернёт функция, сохранит ключи аргумента-массива, только если в функцию передали ровно один массив. Массив, который возвращает функция, будет содержать последовательные целочисленные ключи, если передали больше одного массива.

Список изменений

Версия Описание
8.0.0 Теперь функция выдаст ошибку уровня E_WARNING, если параметр callback ожидает, что значение передадут по ссылке.

Примеры

Пример #1 Пример использования функции array_map()

<?php

function cube($n)
{
return (
$n * $n * $n);
}

$a = [1, 2, 3, 4, 5];
$b = array_map('cube', $a);
print_r($b);

?>

В результате переменная $b будет содержать:

Array
(
    [0] => 1
    [1] => 8
    [2] => 27
    [3] => 64
    [4] => 125
)

Пример #2 Пример работы функции array_map() с лямбда-функцией

<?php

$func
= function(int $value): int {
return
$value * 2;
};

print_r(array_map($func, range(1, 5)));

// Или с PHP 7.4.0:

print_r(
array_map(
fn(
$value): int => $value * 2,
range(1, 5)
)
);

?>
Array
(
    [0] => 2
    [1] => 4
    [2] => 6
    [3] => 8
    [4] => 10
)

Пример #3 Пример работы функции array_map() с набором массивов

<?php

function show_Spanish(int $n, string $m): string
{
return
"Число {$n} по-испански называется {$m}";
}

function
map_Spanish(int $n, string $m): array
{
return [
$n => $m];
}

$a = [1, 2, 3, 4, 5];
$b = ['uno', 'dos', 'tres', 'cuatro', 'cinco'];

$c = array_map('show_Spanish', $a, $b);
print_r($c);

$d = array_map('map_Spanish', $a, $b);
print_r($d);

?>

Результат выполнения приведённого примера:

// Вывод переменной $c
Array
(
    [0] => Число 1 по-испански называется uno
    [1] => Число 2 по-испански называется dos
    [2] => Число 3 по-испански называется tres
    [3] => Число 4 по-испански называется cuatro
    [4] => Число 5 по-испански называется cinco
)

// Вывод переменной $d
Array
(
    [0] => Array
        (
            [1] => uno
        )

    [1] => Array
        (
            [2] => dos
        )

    [2] => Array
        (
            [3] => tres
        )

    [3] => Array
        (
            [4] => cuatro
        )

    [4] => Array
        (
            [5] => cinco
        )

)

Обычно при обработке двух и более массивов они имеют одинаковую длину, поскольку callback-функция применяется к элементам массивов параллельно. При обработке массивов разной длины функция расширяет более короткие массивы элементами с пустыми значениями до длины самого длинного массива.

Функция создаёт массив массивов, когда вместо названия callback-функции передают значение null.

Пример #4 Выполнение zip-операции с массивами

<?php

$a
= [1, 2, 3, 4, 5];
$b = ['one', 'two', 'three', 'four', 'five'];
$c = ['uno', 'dos', 'tres', 'cuatro', 'cinco'];

$d = array_map(null, $a, $b, $c);
print_r($d);

?>

Результат выполнения приведённого примера:

Array
(
    [0] => Array
        (
            [0] => 1
            [1] => one
            [2] => uno
        )

    [1] => Array
        (
            [0] => 2
            [1] => two
            [2] => dos
        )

    [2] => Array
        (
            [0] => 3
            [1] => three
            [2] => tres
        )

    [3] => Array
        (
            [0] => 4
            [1] => four
            [2] => cuatro
        )

    [4] => Array
        (
            [0] => 5
            [1] => five
            [2] => cinco
        )

)

Пример #5 Пример работы функции со значением null вместо названия callback-функции только с аргументом array

<?php

$array
= [1, 2, 3];
var_dump(array_map(null, $array));

?>

Результат выполнения приведённого примера:

array(3) {
  [0]=>
  int(1)
  [1]=>
  int(2)
  [2]=>
  int(3)
}

Пример #6 Пример обработки функцией array_map() строковых ключей

<?php

$arr
= ['stringkey' => 'value'];

function
cb1($a)
{
return [
$a];
}

function
cb2($a, $b)
{
return [
$a, $b];
}

var_dump(array_map('cb1', $arr));
var_dump(array_map('cb2', $arr, $arr));

var_dump(array_map(null, $arr));
var_dump(array_map(null, $arr, $arr));

?>

Результат выполнения приведённого примера:

array(1) {
  ["stringkey"]=>
  array(1) {
    [0]=>
    string(5) "value"
  }
}
array(1) {
  [0]=>
  array(2) {
    [0]=>
    string(5) "value"
    [1]=>
    string(5) "value"
  }
}
array(1) {
  ["stringkey"]=>
  string(5) "value"
}
array(1) {
  [0]=>
  array(2) {
    [0]=>
    string(5) "value"
    [1]=>
    string(5) "value"
  }
}

Пример #7 Пример работы функции array_map() с ассоциативными массивами

Хотя функция array_map() напрямую не поддерживает входные данные в виде ключей массива, это можно сымитировать через функцию array_keys().

<?php

$arr
= [
'v1' => 'Первому выпуску',
'v2' => 'Второму выпуску',
'v3' => 'Третьему выпуску',
];

// Примечание: До версии 7.4.0 анонимные функции записывают длинным, а не коротким синтаксисом
$callback = fn(string $k, string $v): string => "$v присвоили версию $k";

$result = array_map($callback, array_keys($arr), array_values($arr));

var_dump($result);

?>

Результат выполнения приведённого примера:

array(3) {
  [0]=>
  string(64) "Первому выпуску присвоили версию v1"
  [1]=>
  string(64) "Второму выпуску присвоили версию v2"
  [2]=>
  string(66) "Третьему выпуску присвоили версию v3"
}

Смотрите также

  • array_filter() - Фильтрует элементы массива через callback-функцию
  • array_reduce() - Итеративно уменьшает массив к единственному значению через callback-функцию
  • array_walk() - Применяет пользовательскую функцию к каждому элементу массива

Добавить

Примечания пользователей 8 notes

up
31
lukasz dot mordawski at gmail dot com
10 years ago
Let's assume we have following situation:

<?php
class MyFilterClass {
public function
filter(array $arr) {
return
array_map(function($value) {
return
$this->privateFilterMethod($value);
});
}

private function
privateFilterMethod($value) {
if (
is_numeric($value)) $value++;
else
$value .= '.';
}
}
?>

This will work, because $this inside anonymous function (unlike for example javascript) is the instance of MyFilterClass inside which we called it.
I hope this would be useful for anyone.
up
20
radist-hack at yandex dot ru
16 years ago
To transpose rectangular two-dimension array, use the following code:

array_unshift($array, null);
$array = call_user_func_array("array_map", $array);

If you need to rotate rectangular two-dimension array on 90 degree, add the following line before or after (depending on the rotation direction you need) the code above:
$array = array_reverse($array);

Here is example:

<?php
$a
= array(
array(
1, 2, 3),
array(
4, 5, 6));
array_unshift($a, null);
$a = call_user_func_array("array_map", $a);
print_r($a);
?>

Output:

Array
(
[0] => Array
(
[0] => 1
[1] => 4
)

[1] => Array
(
[0] => 2
[1] => 5
)

[2] => Array
(
[0] => 3
[1] => 6
)

)
up
16
Mahn
9 years ago
You may be looking for a method to extract values of a multidimensional array on a conditional basis (i.e. a mixture between array_map and array_filter) other than a for/foreach loop. If so, you can take advantage of the fact that 1) the callback method on array_map returns null if no explicit return value is specified (as with everything else) and 2) array_filter with no arguments removes falsy values.

So for example, provided you have:

<?php
$data
= [
[
"name" => "John",
"smoker" => false
],
[
"name" => "Mary",
"smoker" => true
],
[
"name" => "Peter",
"smoker" => false
],
[
"name" => "Tony",
"smoker" => true
]
];
?>

You can extract the names of all the non-smokers with the following one-liner:

<?php
$names
= array_filter(array_map(function($n) { if(!$n['smoker']) return $n['name']; }, $data));
?>

It's not necessarily better than a for/foreach loop, but the occasional one-liner for trivial tasks can help keep your code cleaner.
up
3
s dot kientzler at online dot de
1 year ago
If the callback function to be called is a static method from a different namespace, the fully qualified method including namespace must be specified (a use statement is not sufficient to resolve the namespace of the callback function)

<?php
use MyTools;

$arr = [1, 2, 3];

$arr = array_map('Tools::myHelper', $arr);
?>

will cause TypeError:
array_map() expects parameter 1 to be a valid callback, class 'Tools' not found.

Use the fully qualified name for the callback instead:

<?php
$arr
= [1, 2, 3];

$arr = array_map('\MyTools\Tools::myHelper', $arr);
?>
up
8
CertaiN
11 years ago
The most memory-efficient array_map_recursive().

<?php
function array_map_recursive(callable $func, array $arr) {
array_walk_recursive($arr, function(&$v) use ($func) {
$v = $func($v);
});
return
$arr;
}
?>
up
8
stijnleenknegt at gmail dot com
16 years ago
If you want to pass an argument like ENT_QUOTES to htmlentities, you can do the follow.

<?php
$array
= array_map( 'htmlentities' , $array, array_fill(0 , count($array) , ENT_QUOTES) );
?>

The third argument creates an equal sized array of $array filled with the parameter you want to give with your callback function.
up
2
Walf
2 years ago
A general solution for the problem of wanting to know the keys in the callback, and/or retain the key association in the returned array:

<?php

/**
* Like array_map() but callback also gets passed the current key as the
* first argument like so:
* function($key, $val, ...$vals) { ... }
* ...and returned array always maintains key association, even if multiple
* array arguments are passed.
*/

function array_map_assoc(callable $callback, array $array, array ...$arrays) {
$keys = array_keys($array);
array_unshift($arrays, $keys, $array);
return
array_combine($keys, array_map($callback, ...$arrays));
}

?>

Because it uses array_map() directly, it behaves the same way in regard to ignoring the keys of subsequent array arguments. It also has the same variadic signature.
up
1
anonymous_user
2 years ago
/**
* Function which recursively applies a callback to all values and also its
* keys, and returns the resulting array copy with the updated keys and
* values.
* PHP's built-in function array_walk_recursive() only applies the passed
* callback to the array values, not the keys, so this function simply applies
* the callback to the keys too (hence the need of working with a copy,
* as also updating the keys would lead to reference loss of the original
* array). I needed something like this, hence my idea of sharing it here.
*
* @param callable $func callback which takes one parameter (value
* or key to be updated) and returns its
* updated value
*
* @param array $arr array of which keys and values shall be
* get updated
*/

function array_map_recursive(
callable $func,
array $arr
) {

// Initiate copied array which will hold all updated keys + values
$result = [];

// Iterate through the key-value pairs of the array
foreach ( $arr as $key => $value ) {

// Apply the callback to the key to create the updated key value
$updated_key = $func( $key );

// If the iterated value is not an array, that means we have reached the
// deepest array level for the iterated key, so in that case, assign
// the updated value to the updated key value in the final output array
if ( ! is_array( $value ) ) {

$result[$updated_key] = $func( $value );

} else {

// If the iterated value is an array, call the function recursively,
// By taking the currently iterated value as the $arr argument
$result[$updated_key] = array_map_recursive(
$func,
$arr[$key]
);

}

} // end of iteration through k-v pairs

// And at the very end, return the generated result set
return $result;

} // end of array_map_recursive() function definition
To Top