Laravel Collection Public API: search

search($value, $strict = false)

The search method is used to search the collection for a given $value. If the given $value is found, the value's corresponding key is returned. If the $value is not found in the collection, the search method will return false. The search method also defines the parameter $strict which will cause the search method to check the data types of the items in the collection with the provided $value to make sure they match.

An argument passed for $value can either be a value, such as 4 or a callback function that accepts both an $item and $key parameter. The following code examples will demonstrate both uses of the search method. The returned value of each method call will appear above the method call as a comment.

 1<?php
 2 
 3use Illuminate\Support\Collection;
 4 
 5// Create a new collection instance.
 6$collection = new Collection([
 7    'first', 'second', 'third', 4
 8]);
 9 
10// 3
11$key = $collection->search('4');
12 
13// 0
14$key = $collection->search('first');
15 
16// false
17$key = $collection->search('fourth');

The following code example will demonstrate the affect of the $strict parameter:

1<?php
2 
3// false
4$key = $collection->search('4', true);
5 
6// 3
7$key = $collection->search(4, true);

∎