This document is for an older version of
Calendar
.
View latest version →
calendar.day function
The calendar.day template function assembles a Day object containing its events and allows for iteration over it to access all Hour objects contained within.
Parameters
date
#- A date string representing the date for the day that should be compiled.
"march 15 2016"
is a validdate
value"2016-03-15"
would be valid and return the Day object for the day of March 15, 2016
calendar
#- Handle of the calendar, e.g.
"holidays"
, or an array of handles:["holidays", "football"]
. - Use
"not holidays"
to select all calendars EXCEPT the Holidays calendar
- Handle of the calendar, e.g.
calendarId
#- An ID of the calendar, or array of ID's, e.g.
[1, 2, 3]
- If you want to select all calendars EXCEPT the calendar with an ID of 1, use
"not 1"
- An ID of the calendar, or array of ID's, e.g.
allDay
#- Selects only events that are set to be All Day events went set to
true
.
- Selects only events that are set to be All Day events went set to
authorId
#- Selects events from specific author ID's
limit
#- Supply an
int
to limit the amount of events returned
- Supply an
order
#- Override default sort order by for the specified day with this parameter, e.g.
order: "startDate ASC"
- Override default sort order by for the specified day with this parameter, e.g.
status
#- By default,
live
is used, showing only enabled events - Can be set to
disabled
to show disabled events - Or
null
to show all events regardless of their status
- By default,
loadOccurrences
#- Set this to
false
to not load any recurring events. Default istrue
. - When setting this to
false
, Calendar will display only the very first occurrence in the results ONLY if that same occurrence falls within the Day date range. It will NOT just show the next recurrence available, and does NOT show any events that just have recurrences within the Day date range.
- Set this to
search: "customField:myvalue*"
#- Works just like regular Craft Searching.
Usage in Templates
Iterate through the hours of the day
{% set day = craft.calendar.day({
date: "today",
calendar: ["holidays", "sports"]
}) %}
{% for hour in day %}
{% for event in hour.events %}
<div style="{{ event.calendar.color }};">
{{ event.title }}
</div>
{% endfor %}
{% endfor %}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
Iterate through all events in the day
{% set day = craft.calendar.day({
date: "today",
calendar: ["holidays", "sports"]
}) %}
{% for event in day.events %}
<div style="{{ event.calendar.color }};">
{{ event.title }}
</div>
{% endfor %}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10