New Array Find Functions in PHP 8.4

Last updated on by

New Array Find Functions in PHP 8.4 image

Four new array functions are coming to PHP 8.4 which are helper functions for checking an array for the existence of elements matching a specific condition. The new functions are:

  • array_find()
  • array_find_key()
  • array_any()
  • array_all()

The array_find() Function

The array_find($array, $callback) function returns the first element for which the $callback returns true:

$array = [
'a' => 'dog',
'b' => 'cat',
'c' => 'cow',
'd' => 'duck',
'e' => 'goose',
'f' => 'elephant'
];
 
array_find($array, function (string $value) {
return strlen($value) > 4;
}); // string(5) "goose"
 
array_find($array, function (string $value) {
return str_starts_with($value, 'f');
}); // null
 
// Find the first animal where the array key is the first symbol of the animal.
array_find($array, function (string $value, $key) {
return $value[0] === $key;
});

Using Laravel's Arr or Collection you can get equivalent functionality with the first() method in combination with a closure:

use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
 
$array = [
'a' => 'dog',
'b' => 'cat',
'c' => 'cow',
'd' => 'duck',
'e' => 'goose',
'f' => 'elephant'
];
 
new Collection($array)
->first(fn ($value) => strlen($value) > 4); // goose
 
Arr::first(
$array,
fn ($value) => str_starts_with($value, 'f')
); // null
 
new Collection($array)
->first(fn ($value, $key) => $value[0] === $key); // cow

Note that we are demonstrating class instantiation without extra parenthesis, which should also be in PHP 8.4.

The array_find_key() Function

The array_find_key($array, $callback) function returns the key of the first element for which the $callback returns true. Like array_find(), it returns null if no matching element is found:

$array = [
'a' => 'dog',
'b' => 'cat',
'c' => 'cow',
'd' => 'duck',
'e' => 'goose',
'f' => 'elephant'
];
 
array_find_key($array, function (string $value) {
return strlen($value) > 4;
}); // string(1) "e"
 
array_find_key($array, function (string $value) {
return str_starts_with($value, 'f');
}); // null
 
array_find_key($array, function (string $value, $key) {
return $value[0] === $key;
}); // string(1) "c"

The RFC implementation for this function looks like the following:

function array_find_key(array $array, callable $callback): mixed {
foreach ($array as $key => $value) {
if ($callback($value, $key)) {
return $key;
}
}
 
return null;
}

Using Laravel's Collection, you can get functionality similar to the search() method in combination with a closure. However, search() returns false if the item is not found, not null:

use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
 
new Collection($array)->search(function (string $value) {
return strlen($value) > 4;
}); // string(1) "e"
 
new Collection($array)->search(function (string $value) {
return str_starts_with($value, 'f');
}); // false
 
new Collection($array)->search(function (string $value, $key) {
return $value[0] === $key;
}); // string(1) "c"

The array_any() and array_all() Functions

The second part of the RFC (and a separate 2/3 vote) includes the array_any() and array_all() functions. You can use these functions if any of the items in array return true for array_any() and if all of the items in an array return true for array_all(), respectively.

$array = [
'a' => 'dog',
'b' => 'cat',
'c' => 'cow',
'd' => 'duck',
'e' => 'goose',
'f' => 'elephant'
];
 
// Check, if any animal name is longer than 5 letters.
array_any($array, function (string $value) {
return strlen($value) > 5;
}); // bool(true)
 
// Check, if any animal name is shorter than 3 letters.
array_any($array, function (string $value) {
return strlen($value) < 3;
}); // bool(false)
 
// Check, if all animal names are shorter than 12 letters.
array_all($array, function (string $value) {
return strlen($value) < 12;
}); // bool(true)
 
// Check, if all animal names are longer than 5 letters.
array_all($array, function (string $value) {
return strlen($value) > 5;
}); // bool(false)

Learn More

You can read all the details about this change in the RFC. This feature drops in PHP 8.4. The implementation for these functions can be found on GitHub.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Filed in:
Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Paragraph

Manage your Laravel app as if it was a CMS – edit any text on any page or in any email without touching Blade or language files.

Visit Paragraph
Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Bespoke software solutions built for your business. We ♥ Laravel

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
Larafast: Laravel SaaS Starter Kit logo

Larafast: Laravel SaaS Starter Kit

Larafast is a Laravel SaaS Starter Kit with ready-to-go features for Payments, Auth, Admin, Blog, SEO, and beautiful themes. Available with Vue and Livewire stacks.

Larafast: Laravel SaaS Starter Kit
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector

The latest

View all →
Asserting a JSON Response Structure in Laravel image

Asserting a JSON Response Structure in Laravel

Read article
Backpack turns 8 years old, celebrates with 40% discount image

Backpack turns 8 years old, celebrates with 40% discount

Read article
Create a DateTime from a Timestamp With this New Method Coming to PHP 8.4 image

Create a DateTime from a Timestamp With this New Method Coming to PHP 8.4

Read article
Neovim Plugin to for Navigating Laravel and Livewire Components image

Neovim Plugin to for Navigating Laravel and Livewire Components

Read article
Laravel Herd v1.7 is out with updates to the dump UI image

Laravel Herd v1.7 is out with updates to the dump UI

Read article
Share Error Package for Laravel's New Exception Page image

Share Error Package for Laravel's New Exception Page

Read article