$segments->group()
Groups the elements by a given field or callback function
$segments->group(string|Closure $field, bool $caseInsensitive = true): Kirby\Query\Segments
Parameters
| Name | Type | Default |
|---|---|---|
| $fieldrequired | stringorClosure |
no default value |
| $caseInsensitive | bool |
true
|
Return type
A new collection with an element for each group and a subcollection in each group
This method does not modify the existing $segments object but returns a new object with the changes applied. Learn more →
Exceptions
| Type | Description |
|---|---|
Exception |
if $field is not a string nor a callback function |
Parent class
Kirby\Query\Segments
inherited from Kirby\Toolkit\Collection