Skip to content

Kirby 5.0.4

$collection->group()

Groups the elements by a given field or callback function

$collection->group(string|Closure $field, bool $caseInsensitive = true): Kirby\Toolkit\Collection

Parameters

Name Type Default
$fieldrequired stringorClosure no default value
$caseInsensitive bool true

Return type

Kirby\Toolkit\Collection

A new collection with an element for each group and a subcollection in each group

This method does not modify the existing $collection 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\Toolkit\Collection