Collections fieldset example in Statamic V2

C

One of the fieldsets available in Statamic V2 is the Collections fieldset.

Statamic V2: Screenshot of Fieldsets, Type: Collection
Statamic V2: Screenshot of Fieldsets, Type: Collection

The Collections fieldset lets you allow editors to see and choose items from one or more Collections. Below is the Extras setting tab for the Collection field type. You can see that I’ve selected Staff as the Collection available to editors.

This is the Extras setting tab for the Collection fieldtype. You can see that I've selected Staff as the collection available to editors.
Statamic V2: Extras setting tab for the Collection field type

For editors, they can add items, in this case, staff members, to the Staff collection from within the Statamic Control Panel. Then, the editor can choose which staff members to display on various Our Staff pages.

Top: Example of Collection Bottom: Editor selecting items from Collection for display on a specific page.

Antlers Syntax

To display the content of this selected Collection on your page’s template, I’ve found two antler syntaxes that work. In this scenario, the Collection’s name is “staff,” The page’s Collections field type is named “choose_staff.”

Option 1: Use Collection

Option 1 lists the individuals chosen in the “choose_staff” field by the editor. The sort order is based on the order shown in the Collections area, not the order shown in the “choose_staff” field type. This unexpected functionality may be confusing and frustrating to editors, as editors can rearrange the order of chosen Staff, but this arrangement will not be reflected on the live webpage.

{{ collection:staff from="{choose_staff|piped|sort:number}" }} 	
<!-- add your code here -->
{{ /collection:staff }}

Option 2: Use Relate

Option 2’s syntax is the best, most concise option and, by default, uses the sort order that the editor makes in the collections field type, not the list order of the parent collection.

{{ relate:choose_staff }}
<!-- add your code here -->
{{ /relate:choose_staff }}

I hope this helps you sort out creative ways to use the Collections Fieldtype in your Statamic websites. Want to learn more about Collections? This Statamic V2 help doc and video are really great, and so is this Collections documentation page. For Relate, here’s the V2 help doc and video. And, here is another excellent resource specific to Antlers syntax.

Happy coding!

About the author

Kelly Barkhurst

Designer to Fullstack is my place to geek out and to share tech solutions from my day-to-day as a designer, programmer, and business owner (portfolio). I also write on Arts and Bricks, a parenting blog and decal shop that embraces my family’s love of Art and LEGO bricks!

Add comment

Recent Posts

Archives

Categories