array_find

(PHP 8 >= 8.4.0)

array_find — コールバック関数を満たす最初の要素を返す

説明

array_find(array $array, callable $callback): mixed

array_find() は、指定された callback が true を返す array の最初の要素を返します。見つからない場合 null を返します。

パラメータ

array

検索する array 。

callback

各要素を調べるコールバック関数。シグネチャは次の通りです:

callback(mixed $value, mixed $key): bool

この関数が true を返すと、その要素が array_find() から返され、以降の要素に対してはコールバックは呼び出されません。

戻り値

callback が true を返す最初の要素を返します。一致する要素が見つからない場合、 null を返します。

例

例1 array_find() の例

<?php
$array = [
 'a' => 'dog',
 'b' => 'cat',
 'c' => 'cow',
 'd' => 'duck',
 'e' => 'goose',
 'f' => 'elephant'
];

// 名前が4文字より長い最初の動物を探します。
var_dump(array_find($array, function (string $value) {
 return strlen($value) > 4;
}));

// 名前がfで始まる最初の動物を探します。
var_dump(array_find($array, function (string $value) {
 return str_starts_with($value, 'f');
}));

// キーが動物の名前の最初の文字と一致する最初の動物を探します。
var_dump(array_find($array, function (string $value, $key) {
 return $value[0] === $key;
}));

// キーが正規表現にマッチする最初の動物を探します。
var_dump(array_find($array, function ($value, $key) {
 return preg_match('/^([a-f])$/', $key);
}));
?>

上の例の出力は以下となります。

string(5) "goose"
NULL
string(3) "cow"
string(3) "dog"

参考

array_find_key() - コールバック関数を満たす最初の要素のキーを返す
array_all() - array のすべての要素がコールバック関数を満たすかどうかを調べる
array_any() - array のいずれかの要素がコールバック関数を満たすかどうかを調べる
array_filter() - コールバック関数を使用して、配列の要素をフィルタリングする
array_reduce() - コールバック関数を繰り返し配列に適用し、配列をひとつの値にまとめる

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

+add a note

User Contributed Notes 1 note

down

mail at nititech dot de ¶

5 months ago

A simple fallback For older PHP versions, that do not have array_find:



<?php



/**

 * Porting of PHP 8.4 function

 *

 * @template TValue of mixed

 * @template TKey of array-key

 *

 * @param array<TKey, TValue> $array

 * @param callable(TValue $value, TKey $key): bool $callback

 * @return ?TValue

 *

 * @see https://www.php.net/manual/en/function.array-find.php

 */

function array_find(array $array, callable $callback): mixed

{

 foreach ($array as $key => $value) {

 if ($callback($value, $key)) {

 return $value;

 }

 }



 return null;

}

?>

+add a note