groupBy
A Craft plugin (Twig filter) for grouping entries., (*1)
Note: I have no plan to update this plugin for Craft 3. See https://github.com/sjelfull/craft3-collections, which can do the same thing, but also much more., (*2)
Usage
-
param 1
: Attribute to group by, in dot notation
-
param 2
: Group un-grouped entries by a key. Defaults to false
, meaning un-grouped items are removed. These entries are always added to the end of the returned array.
{% set allEntries = craft.entries.section('blog').find() %}
{% set allEntriesByCat = allEntries|groupBy('myCategoryField.slug', 'unGrouped') %}
Examples
In it's simplest form, the groupBy
filter works like Craft's native group
filter., (*3)
{% set allEntries = craft.entries.section('blog').find() %}
{% set allEntriesByYear = allEntries|groupBy('postDate.year') %}
However, groupBy
can also group by nested objects:, (*4)
{% set allEntriesByCat = allEntries|groupBy('myCategoryField.slug') %}
{% set allEntriesBySection = allEntries|groupBy('section.title') %}
And you can even get really crazy if you want:, (*5)
{% set allEntriesByNestedCat = allEntries|groupBy('myEntriesField.myCategoryField.slug') %}
{% set allEntriesByMatrix = allEntries|groupBy('myMatrix.myEntriesField.dateField.localeDate') %}
Discussion
[Motivation for plugin on StackExchange][2], (*6)