TIP

WE'RE HIRING! 💼

The Solspace team is expanding! If you love Craft CMS and you’re looking for an exciting full-time remote position working on software development for the Freeform and Calendar plugins for Craft and more, we’d love to hear from you!

Check Out Job Listing!

Occurrences object

The occurrences object allows you to display a list of recurrences for a given event. It could also be filtered down to display the next upcoming event for a particular event.

Properties

Contains many of the same properties as the Event object.

Usage in Templates

{% set event = craft.calendar.event(craft.app.request.segment(2)) %}

{% if event.repeating %}

    <h3>Upcoming Recurrences</h3>

    {% set occurrences = event.occurrences({
        rangeStart: 'today',
        rangeEnd: '+6 months',
        limit: 10,
    }) %}

    {% if occurrences %}
        <ul class="list-group">
            {% for occurrence in occurrences %}
                <li class="list-group-item">
                    {{ occurrence.startDate.format("l, F j, Y") }}
                    {% if occurrence.allDay %}
                        (all day)
                    {% else %}
                        at {{ occurrence.startDate.format("g:ia") }}
                        {% if occurrence.multiDay %}
                            <br />{{ occurrence.endDate.format("l, F j, Y \\a\\t g:ia") }}
                        {% else %}
                            {{ occurrence.endDate.format("g:ia") }}
                        {% endif %}
                    {% endif %}
                </li>
            {% endfor %}
        </ul>
    {% else %}
        <p>No occurrences found for this timeframe.</p>
    {% endif %}

{% endif %}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Last Updated: 2/3/2020, 5:06:34 PM