Calendar

https://docs.solspace.com/craft/calendar/v5
Admin
Calendar is a powerful event management and calendaring plugin that simplifies the creation of...
Tokens:39,003
Snippets:353
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Plugin via CLI

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

Run the Craft console command to finalize the plugin installation.

```bash
php craft plugin/install calendar  
```

--------------------------------

### Usage Example: Subscribing to Events

Source: https://docs.solspace.com/craft/calendar/v5/developer/events

Example of how to subscribe to Calendar events within a plugin's init() method.

```APIDOC
## Usage Examples

In your plugin's `::init()` method, subscribe to any of these events by using the `Event::on()` static method:

```php
<?php  
  
namespace Your\Plugin\Namespace;  
  
use Solspace\Calendar\Events\SaveElementEvent;  
use Solspace\Calendar\Services\EventsService; // Assuming this is the correct service for the event
use craft\base\Plugin as BasePlugin; // Assuming BasePlugin is craft\base\Plugin
use yii\base\Event; // Assuming Event is yii\base\Event
  
class YourPlugin extends BasePlugin  
{
    public function init()
    {
        parent::init();

        // Example: Subscribe to the EVENT_BEFORE_SAVE event for calendar events
        Event::on(
            EventsService::class,  // The service class that dispatches the event
            EventsService::EVENT_BEFORE_SAVE, // The specific event constant
            function (SaveElementEvent $event) {  
                $isNew = $event->isNew();  
                $element = $event->getElement();  
                // Do something with this data, e.g., log it, modify it, etc.
                // For example:
                // if ($isNew) {
                //     
                // }
            }
        );
    }
}
```
```

--------------------------------

### Usage Example: Add Author Filtering to Month/Week/Day View

Source: https://docs.solspace.com/craft/calendar/v5/developer/hooks

Example demonstrating how to add author filtering to calendar views using the `cp.solspace.calendar.filters` hook.

```APIDOC
## Usage Example: Add Author Filtering to Month/Week/Day View

### Description
This example shows how to implement author filtering in calendar views by registering a callback for the `cp.solspace.calendar.filters` hook. It queries events, extracts author information, and generates HTML for filter checkboxes.

### Method
Not applicable (Hook registration)

### Endpoint
Not applicable (Hook registration)

### Parameters
#### Path Parameters
- **calendarId** (integer) - Required - The ID of the calendar to query events from.

#### Request Body
Not applicable

### Request Example
```php
<?php  
  
namespace Your\Plugin\Namespace;  
  
use Solspace\Calendar\Events\SaveElementEvent;  
use craft\base\Plugin as BasePlugin;
use craft\web\twig\variables\CraftVariable;
use craft\events\RegisterUrlRulesEvent;
use craft\web\UrlManager;
use Solspace\Calendar\Calendar;

class YourPlugin extends BasePlugin  
{
  public function init()
  {
    parent::init();

    Craft::$app->view->hook('cp.solspace.calendar.filters', function () {
      $calendarId = 5; // Example calendar ID

      $events = Calendar::getInstance()->events
        ->getEventQuery([
          'calendarId' => [$calendarId],
        ])
        ->all();

      $authors = [];
      $authorsList = '<nav>
           <ul class="calendar-list">
               <li class="heading">
                   <a href="#" class="sel" style="display: none;">Authors</a>
                   <span>Authors</span>
               </li>';

      foreach ($events as $event) {
        $author = $event->getAuthor();
        if ($author) {
            $authors[] = $author;
        }
      }
      $authors = array_unique($authors);

      foreach ($authors as $author) {
        $authorsList .= '       <li class="item">
           <input type="checkbox" name="criteria[authorId][]" id="calendar-author-'.$author->id.'" value="'.$author->id.'" />
           <label for="calendar-author-'.$author->id.'">
               <span style="background: red; color: white; border-color: black;"></span>
               '.$author->firstName.' '.$author->lastName.'
           </label>
       </li>';
      }

      $authorsList .= '   </ul>
</nav>';

      return $authorsList;
    });

    // Example of registering CP URL rules (not directly related to the filter hook but shown in original context)
    Event::on(
      UrlManager::class,
      UrlManager::EVENT_REGISTER_CP_URL_RULES,
      function (RegisterUrlRulesEvent $event) {
        $event->rules['cpActionTrigger1'] = 'events/create';
        $event->rules['cpActionTrigger2'] = 'submissions/create';
        $event->rules['cpActionTrigger3'] = 'spam/create';
      }
    );
  }
}
```
```

--------------------------------

### Require Calendar via Composer

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

Install the Calendar plugin using Composer.

```bash
composer require solspace/craft-calendar -w  
```

```bash
composer require solspace/craft-calendar:5.0.15 -w  
```

--------------------------------

### Configure Routes for Demo Templates

Source: https://docs.solspace.com/craft/calendar/v5/configuration/demo-templates

Add these routes to your Craft CMS config/routes.php file to enable the demo templates. Ensure the paths match your installation.

```php
'demo/month/(?P<year>\d{4})/(?P<month>\d{2})'                                          => 'demo/month',
'demo/month/calendar/(?P<slug>[^\/]+)'                                                 => 'demo/month',
'demo/month/calendar/(?P<slug>[^\/]+)/(?P<year>\d{4})/(?P<month>\d{2})'                => 'demo/month',
'demo/week/(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})'                            => 'demo/week',
'demo/week/calendar/(?P<slug>[^\/]+)'                                                  => 'demo/week',
'demo/week/calendar/(?P<slug>[^\/]+)/(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})'  => 'demo/week',
'demo/day/(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})'                             => 'demo/day',
'demo/day/calendar/(?P<slug>[^\/]+)'                                                   => 'demo/day',
'demo/day/calendar/(?P<slug>[^\/]+)/(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})'   => 'demo/day',
'demo/calendars/(?P<slug>[^\/]+)'                                                      => 'demo/calendars',
'demo/event/(?P<id>\d+)'                                                               => 'demo/event',
'demo/event/(?P<id>\d+)/(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})'               => 'demo/event',
'demo/events/(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})'                          => 'demo/events',
'demo/export/event/(?P<id>\d+)'                                                        => 'demo/export',
'demo/export/calendar/(?P<id>\d+)'                                                     => 'demo/export',
'demo/fullcalendar/(?P<slug>[^\/]+)/(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d{2})'   => 'demo/fullcalendar',
'demo/resources/event_data/(?P<id>\d+)'                                                => 'demo/resources/event_data'
```

--------------------------------

### Event Template Usage

Source: https://docs.solspace.com/craft/calendar/v5/templates/objects/event

Examples of how to access event properties and custom fields in templates.

```APIDOC
## Template Usage

### Accessing Custom Fields
Access custom fields by their handle:
{{ event.handle }}

### Checking Event Occurrence
{% if event.isHappeningOn('2023-03-07 4:30pm') %} Yes! {% endif %}

### Duration Example
{{ event.duration.humanReadable }}

{% if event.duration.days >= 1 %}
  Event spans for {{ event.duration.days }} days
{% endif %}
```

--------------------------------

### Compare event start date

Source: https://docs.solspace.com/craft/calendar/v5/templates/objects/event

Use Date methods like lt() to compare the event start date against other date objects.

```twig
{# Print out the Y-m-d of start date if start date is before the Day date #}  
  
{% if event.startDate.lt(day.date) %}  
  {{ event.startDate.dateString }}
{% endif %}
```

--------------------------------

### Show only events which start in weekends

Source: https://docs.solspace.com/craft/calendar/v5/templates/queries/month

This example demonstrates how to filter events to show only those that start on a weekend.

```APIDOC
## Usage in Templates: Filter events starting on weekends

This example shows how to display only events that begin on a weekend day.

### Request Example

```twig
{% set month = craft.calendar.month({"date": "today", "calendar": ["holidays", "sports"]}) %}

{% for event in month.events if event.startDate.weekend %}
  <div style="{{ event.calendar.color }};">
    {{ event.title }}
  </div>
{% endfor %}
```

### Response Example

This code snippet does not directly return a JSON response but rather renders HTML based on the event data.
```

--------------------------------

### Usage in Templates - Filter events starting on weekends

Source: https://docs.solspace.com/craft/calendar/v5/templates/objects/month

Example of filtering events to show only those starting on weekends.

```APIDOC
## Usage in Templates - Filter events starting on weekends

### Description
Show only events which start in weekends.

### Code Example
```twig
{% set month = craft.calendar.month({
  date: "today",
  calendar: ["holidays", "sports"]
}) %}

{% for event in month.events if event.startDate.weekend %}
  <div style="{{ event.calendar.color }};
">
    {{ event.title }}
  </div>
{% endfor %}
```
```

--------------------------------

### Example JSON Import File

Source: https://docs.solspace.com/craft/calendar/v5/events/importing

A sample JSON structure demonstrating various event types, including regular, recurring with RRULE, and all-day events.

```json
{
  "events": {  
    "event": [  
      {  
        "title": "Feed Me Test Regular Event",  
        "startDate": "2021-02-11 07:00:00",  
        "endDate": "2021-02-11 13:00:00",  
        "allDay": 0  
      },  
      {  
        "title": "Feed Me Test Recurring Event with RRULE",  
        "startDate": "2021-02-14 07:00:00",  
        "endDate": "2021-02-14 13:00:00",  
        "allDay": 0,  
        "repeatRule": "RRULE:FREQ=MONTHLY;UNTIL=20211016T235959Z;BYMONTHDAY=14"  
      },  
      {  
        "title": "Feed Me Test Recurring Event with RRULE and INTERVAL",  
        "startDate": "2021-02-14 07:00:00",  
        "endDate": "2021-02-14 13:00:00",  
        "allDay": 0,  
        "repeatRule": "RRULE:FREQ=MONTHLY;UNTIL=20211016T235959Z;BYMONTHDAY=14;INTERVAL=2"  
      },  
      {  
        "title": "Feed Me Test Recurring Event without RRULE",  
        "startDate": "2021-02-14 07:00:00",  
        "endDate": "2021-02-14 13:00:00",  
        "allDay": 0,  
        "repeatInterval": 1,  
        "repeatFrequency": "MONTHLY",  
        "repeatCount": null,  
        "repeatUntil": "2021-10-16 23:59:59",  
        "repeatByMonth": null,  
        "repeatByYearDay": null,  
        "repeatByMonthDay": 14,  
        "repeatByDay": null  
      },  
      {  
        "title": "Feed Me Test All Day Event",  
        "startDate": "2021-02-17 00:00:00",  
        "endDate": "2021-02-17 23:59:59",  
        "allDay": 1  
      }  
    ]  
  }  
}
```

--------------------------------

### Iterate through weeks and days of the month

Source: https://docs.solspace.com/craft/calendar/v5/templates/queries/month

This example demonstrates how to iterate through the weeks and days of a month to access individual events.

```APIDOC
## Usage in Templates: Iterate through weeks and days

This example shows how to loop through each week and day within a month to display event titles.

### Request Example

```twig
{% set month = craft.calendar.month({"date": "today", "calendar": ["holidays", "sports"]}) %}

{% for week in month %}
  {% for day in week %}
    {% for event in day.events %}
      <div style="{{ event.calendar.color }};">
        {{ event.title }}
      </div>
    {% endfor %}
  {% endfor %}
{% endfor %}
```

### Response Example

This code snippet does not directly return a JSON response but rather renders HTML based on the event data.
```

--------------------------------

### Iterate through all events in the month

Source: https://docs.solspace.com/craft/calendar/v5/templates/queries/month

This example shows how to retrieve and iterate through all events within a specified month.

```APIDOC
## Usage in Templates: Iterate through all events

This example demonstrates how to get all events for a given month and display their titles.

### Request Example

```twig
{% set month = craft.calendar.month({"date": "today", "calendar": ["holidays", "sports"]}) %}

{% for event in month.events %}
  <div style="{{ event.calendar.color }};">
    {{ event.title }}
  </div>
{% endfor %}
```

### Response Example

This code snippet does not directly return a JSON response but rather renders HTML based on the event data.
```

--------------------------------

### Filter Events Starting on Weekdays

Source: https://docs.solspace.com/craft/calendar/v5/templates/queries/week

This example demonstrates how to filter events to show only those that start on weekdays within the compiled week. It uses a conditional within the `for` loop. Requires the `date` and `calendar` parameters.

```twig
{% set week = craft.calendar.week({
  date: "today",
  calendar: ["holidays", "sports"]
}) %}

{% for event in week.events if event.startDate.weekday %}
  <div style="{{ event.calendar.color }};">
    {{ event.title }}
  </div>
{% endfor %}

```

--------------------------------

### Usage in Templates - Iterate through all events

Source: https://docs.solspace.com/craft/calendar/v5/templates/objects/month

Example of iterating directly through all events within a month.

```APIDOC
## Usage in Templates - Iterate through all events

### Description
Iterate through all events in the month directly.

### Code Example
```twig
{% set month = craft.calendar.month({
  date: "today",
  calendar: ["holidays", "sports"]
}) %}

{% for event in month.events %}
  <div style="{{ event.calendar.color }};
">
    {{ event.title }}
  </div>
{% endfor %}
```
```

--------------------------------

### Show Events Starting on Weekdays

Source: https://docs.solspace.com/craft/calendar/v5/templates/objects/week

Filter and display events that start on a weekday within the week object. This example uses a conditional within the loop to check the 'event.startDate.weekday' property. The week object must be initialized.

```twig
{% set week = craft.calendar.week({
  date: "today",
  calendar: ["holidays", "sports"]
}) %}

{% for event in week.events if event.startDate.weekday %}
  <div style="{{ event.calendar.color }};">
    {{ event.title }}
  </div>
{% endfor %}
```

--------------------------------

### Usage in Templates - Iterate through weeks and days

Source: https://docs.solspace.com/craft/calendar/v5/templates/objects/month

Example of iterating through weeks and days of a month to display events.

```APIDOC
## Usage in Templates - Iterate through weeks and days

### Description
Iterate through weeks and days of the month to display events.

### Code Example
```twig
{% set month = craft.calendar.month({
  date: "today",
  calendar: ["holidays", "sports"]
}) %}

{% for week in month %}
  {% for day in week %}
    {% for event in day.events %}
      <div style="{{ event.calendar.color }};
">
        {{ event.title }}
      </div>
    {% endfor %}
  {% endfor %}
{% endfor %}
```
```

--------------------------------

### Usage in Templates - Iterate through all events

Source: https://docs.solspace.com/craft/calendar/v5/templates/objects/day

Example of how to iterate directly through all events associated with a Day object.

```APIDOC
### Iterate through all events in the day

```twig
{% set day = craft.calendar.day({
  date: "today",
  calendar: ["holidays", "sports"]
}) %}

{% for event in day.events %}
  <div style="{{ event.calendar.color }};">
    {{ event.title }}
  </div>
{% endfor %}
```
```

--------------------------------

### Usage in Templates - Iterate through hours

Source: https://docs.solspace.com/craft/calendar/v5/templates/objects/day

Example of how to iterate through the hours of a Day object and display events within each hour.

```APIDOC
## Usage in Templates

### Iterate through the hours of the day

```twig
{% 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 %}
```
```

--------------------------------

### Querying Multiple Calendars and Events

Source: https://docs.solspace.com/craft/calendar/v5/headless/graphql

This section describes how to query all or a selection of calendars and their events. It includes the GraphQL query structure and an example response.

```APIDOC
## Querying Multiple Calendars and Events

### Description
This endpoint allows you to retrieve a list of calendars and their associated events. You can specify which fields to load for both calendars and events.

### Method
POST

### Endpoint
/graphql

### Parameters
#### Request Body
- **query** (string) - Required - The GraphQL query string.

### Request Example
```json
{
  "query": "query {\n  solspace_calendar {\n    calendars {\n      id\n      uid\n      name\n      handle\n      description\n      color\n      lighterColor\n      darkerColor\n      icsHash\n      allowRepeatingEvents\n\n      events(loadOccurrences: false) {\n        id\n        uid\n        postDate\n        calendarId\n        title\n        authorId\n        startDate\n        startDateLocalized\n        initialStartDate\n        endDate\n        endDateLocalized\n        initialEndDate\n        allDay\n        rrule\n        freq\n        interval\n        count\n        until\n        untilLocalized\n        byMonth\n        byYearDay\n        byMonthDay\n        byDay\n      }\n    }\n  }\n}"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains the result of the query.
  - **solspace_calendar** (object)
    - **calendars** (array) - A list of calendar objects.
      - **id** (integer) - The unique identifier for the calendar.
      - **uid** (string) - The universally unique identifier for the calendar.
      - **name** (string) - The name of the calendar.
      - **handle** (string) - The handle of the calendar.
      - **description** (string) - The description of the calendar.
      - **color** (string) - The primary color of the calendar.
      - **lighterColor** (string) - A lighter shade of the calendar's color.
      - **darkerColor** (string) - A darker shade of the calendar's color.
      - **icsHash** (string|null) - The ICS hash for the calendar.
      - **allowRepeatingEvents** (boolean) - Indicates if repeating events are allowed.
      - **events** (array) - A list of event objects associated with the calendar.
        - **id** (integer) - The unique identifier for the event.
        - **uid** (string) - The universally unique identifier for the event.
        - **postDate** (string) - The date the event was posted.
        - **calendarId** (integer) - The ID of the calendar the event belongs to.
        - **title** (string) - The title of the event.
        - **authorId** (integer) - The ID of the event's author.
        - **startDate** (string) - The start date and time of the event.
        - **startDateLocalized** (string) - The localized start date and time of the event.
        - **initialStartDate** (string) - The initial start date and time of the event.
        - **endDate** (string) - The end date and time of the event.
        - **endDateLocalized** (string) - The localized end date and time of the event.
        - **initialEndDate** (string) - The initial end date and time of the event.
        - **allDay** (boolean) - Indicates if the event is an all-day event.
        - **rrule** (string|null) - The recurrence rule for the event.
        - **freq** (string|null) - The frequency of the recurrence.
        - **interval** (integer|null) - The interval of the recurrence.
        - **count** (integer|null) - The count of recurrences.
        - **until** (string|null) - The until date for the recurrence.
        - **untilLocalized** (string|null) - The localized until date for the recurrence.
        - **byMonth** (array|null) - The months for recurrence.
        - **byYearDay** (array|null) - The year days for recurrence.
        - **byMonthDay** (array|null) - The month days for recurrence.
        - **byDay** (array|null) - The days of the week for recurrence.

#### Response Example
```json
{
  "data": {
    "solspace_calendar": {
      "calendars": [
        {
          "id": 1,
          "uid": "d076d1b1-77fa-44be-9776-8b6413c0a624",
          "name": "Default",
          "handle": "default",
          "description": "The default calendar",
          "color": "#3054F7",
          "lighterColor": "#7F86FF",
          "darkerColor": "#0027BD",
          "icsHash": null,
          "allowRepeatingEvents": true,
          "events": []
        },
        {
          "id": 2,
          "uid": "c3834c11-3f8b-4c53-b175-ac2a82db1dd2",
          "name": "Second",
          "handle": "second",
          "description": "",
          "color": "#865b5b",
          "lighterColor": "#BC8E8D",
          "darkerColor": "#532D2D",
          "icsHash": null,
          "allowRepeatingEvents": true,
          "events": []
        }
      ]
    }
  }
}
```
```

--------------------------------

### Compare Event Dates

Source: https://docs.solspace.com/craft/calendar/v5/templates/queries/events

Uses Date methods to filter and display events starting before a specific day's date.

```twig
{# Print out the Y-m-d of start date if start date is before the Day date #}  
  
{% set events = craft.calendar.events %}  
  
{% for event in events %}  
  {% if event.startDate.lt(day.date) %}  
    {{ event.startDate.dateString }}  
  {% endif %}  
{% endfor %}
```

--------------------------------

### Navigate to Project Directory

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

Change the current working directory to the root of the Craft project.

```bash
cd /path/to/project  
```

--------------------------------

### Navigate to Craft Project Directory

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

Change your current directory to the root of your Craft project in the CLI.

```bash
cd /path/to/project
```

--------------------------------

### Filter events by weekend start date

Source: https://docs.solspace.com/craft/calendar/v5/templates/objects/month

Uses a conditional filter within a loop to display only events that start on a weekend.

```twig
{% set month = craft.calendar.month({  
  date: "today",  
  calendar: ["holidays", "sports"]  
}) %}  
  
{% for event in month.events if event.startDate.weekend %}  
  <div style="{{ event.calendar.color }};">  
    {{ event.title }}  
  </div>  
{% endfor %}
```

--------------------------------

### Check for Migrations

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

Run migration commands to apply any necessary database schema changes for Craft and its plugins.

```bash
php craft migrate/all
```

```bash
php craft migrate --plugin=calendar
```

--------------------------------

### Check for Updates via CLI

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

List available updates for the project.

```bash
php craft update  
```

--------------------------------

### Switch Edition in Project Config

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

Update the project.yaml file to change the plugin edition from lite to pro.

```yaml
calendar:  
-   edition: lite  
+   edition: pro  
    enabled: true  
```

--------------------------------

### Run Composer Update

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

Execute Composer to update project dependencies, including the Calendar plugin.

```bash
composer update
```

--------------------------------

### Migrate Event Titles (Craft 4.x to 5.x)

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

Run this command if upgrading from Craft 4.x to Craft 5.x to migrate event titles.

```bash
php craft calendar/events/fix-titles
```

--------------------------------

### GET craft.calendar.calendars

Source: https://docs.solspace.com/craft/calendar/v5/templates/queries/calendars

Fetches a list of calendars based on specified criteria such as ID, name, handle, or color.

```APIDOC
## GET craft.calendar.calendars

### Description
Fetches a list of calendars based on provided filtering criteria.

### Parameters
#### Query Parameters
- **id** (mixed) - Optional - The unique calendar ID. Supports arrays, 'not' syntax, and '!=' syntax.
- **name** (string) - Optional - Filter by calendar name. Supports arrays, 'not' syntax, and '!=' syntax.
- **handle** (string) - Optional - Filter by calendar handle. Supports arrays, 'not' syntax, and '!=' syntax.
- **color** (string) - Optional - Filter by hex color value (e.g., #FFFFFF).
- **orderBy** (string) - Optional - Attribute to order by: id, name, handle, or color.
- **sort** (string) - Optional - Sort direction: ASC or DESC.
- **limit** (int) - Optional - Limit the number of results returned.

### Request Example
{% set calendars = craft.calendar.calendars({  
  orderBy: "name",  
  sort: "asc"  
}) %}

### Response
#### Success Response (200)
- **calendar** (object) - Returns a collection of calendar objects containing properties like name, color, id, and handle.
```

--------------------------------

### Export events with parameters

Source: https://docs.solspace.com/craft/calendar/v5/templates/queries/export

Basic syntax for exporting events while specifying a site handle and a localized timezone.

```twig
{{ craft.calendar.export(events, {site: "mySiteHandle", timezone: "America/New_York"}) }}
```

--------------------------------

### Query calendars with arguments

Source: https://docs.solspace.com/craft/calendar/v5/headless/graphql

Demonstrates filtering, limiting, and sorting calendars using various arguments.

```graphql
query {  
  solspace_calendar {  
    # This is just an example  
    # For `id`, `uid` and `handle` - you can either pass a single value  
    # or an array of values for each argument  
    calendar(  
      id: 1  
      handle: "test"  
      limit: 1  
      offset: 2  
      orderBy: "name"  
      sort: "desc"  
    ) {  
      id  
    }  
  }  
}  
```

--------------------------------

### Show only events which start in weekends

Source: https://docs.solspace.com/craft/calendar/v5/templates/queries/month

Filter events within a month to display only those occurring on weekends using the startDate.weekend property.

```twig
{% set month = craft.calendar.month({  
  date: "today",  
  calendar: ["holidays", "sports"]  
}) %}  
  
{% for event in month.events if event.startDate.weekend %}  
  <div style="{{ event.calendar.color }};">  
    {{ event.title }}  
  </div>  
{% endfor %}  
```

--------------------------------

### Migrate Event Data

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

Run these commands when upgrading from Craft 4.x to 5.x to ensure event data integrity.

```bash
php craft calendar/events/fix-titles  
```

```bash
php craft calendar/events/fix-contents  
```

--------------------------------

### Configure composer.json for v5.x-dev

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

Use this configuration to pull the latest unreleased changes from the main v5 branch.

```json
"require": {  
    "craftcms/cms": "^5.0.0",  
    "vlucas/phpdotenv": "^5.4.0",  
    "solspace/craft-calendar": "v5.x-dev",  
    "solspace/craft-freeform": "^5.0.0",  
},  
```

--------------------------------

### Check if Date is Between Two Dates

Source: https://docs.solspace.com/craft/calendar/v5/templates/objects/date

Use the between method to check if a date falls within a specified range (inclusive). Requires a start date and an end date for the range.

```javascript
event.startDate.between(month.startDate, month.endDate)
```

--------------------------------

### Add Author Filtering to Calendar Filters

Source: https://docs.solspace.com/craft/calendar/v5/developer/hooks

Use the `cp.solspace.calendar.filters` hook to customize calendar filters in the control panel. This example demonstrates how to query events and generate HTML for author filtering.

```php
<?php  
  
namespace Your\Plugin\Namespace;  
  
use Solspace\Calendar\Events\SaveElementEvent;  
  
class YourPlugin extends BasePlugin  
{
  public function init()
  {
    parent::init();

    Craft::$app->view->hook('cp.solspace.calendar.filters', function () {
      $calendarId = 5;

      $events = Calendar::getInstance()->events
        ->getEventQuery([
          'calendarId' => [$calendarId],
        ])
        ->all();

      $authors = [];

      foreach ($events as $event) {
        $authorsList = '';
        $authorsList .= '<nav>';
        $authorsList .= '   <ul class="calendar-list">';
        $authorsList .= '       <li class="heading">';
        $authorsList .= '           <a href="#" class="sel" style="display: none;">Authors</a>';
        $authorsList .= '           <span>Authors</span>';
        $authorsList .= '       </li>';

        $authors[] = $event->getAuthor();
        $authors = array_unique($authors);

        foreach ($authors as $author) {
          $authorsList .= '       <li class="item">';
          $authorsList .= '           <input type="checkbox" name="criteria[authorId][]" id="calendar-author-'.$author->id.'" value="'.$author->id.'" />';
          $authorsList .= '           <label for="calendar-author-'.$author->id.'">';
          $authorsList .= '               <span style="background: red; color: white; border-color: black;"></span>';
          $authorsList .= '               '.$author->firstName.' '.$author->lastName;
          $authorsList .= '           </label>';
          $authorsList .= '       </li>';
        }
      }

      $authorsList .= '   </ul>';
      $authorsList .= '</nav>';

      return $authorsList;
    });

    Event::on(
      UrlManager::class,
      UrlManager::EVENT_REGISTER_CP_URL_RULES,
      function (RegisterUrlRulesEvent $event) {
        $event->rules['cpActionTrigger1'] = 'events/create';
        $event->rules['cpActionTrigger2'] = 'submissions/create';
        $event->rules['cpActionTrigger3'] = 'spam/create';
      }
    );
  }
}

```

--------------------------------

### Migrate Craft 4 Event Content CLI Command

Source: https://docs.solspace.com/craft/calendar/v5/developer/console-commands

Run this command if you were using Calendar 5.x on Craft 4.x before upgrading to Craft 5.x to ensure event data is correctly migrated, as it's stored differently in Craft 5.

```bash
php craft calendar/events/fix-contents  
```

--------------------------------

### Fetch Event by ID/Slug with Target Date

Source: https://docs.solspace.com/craft/calendar/v5/templates/queries/event

Use this snippet to fetch a specific event using its ID or slug. The `targetDate` parameter allows you to specify a particular recurrence date, which is constructed from URL segments in this example.

```twig
{% set occurrenceDate = null %}
{% if craft.app.request.segment(3) and craft.app.request.segment(4) and craft.app.request.segment(5) %}
    {% set occurrenceDate = craft.app.request.segment(3)~"-"~craft.app.request.segment(4)~"-"~craft.app.request.segment(5) %}
{% endif %}

{% set event = craft.calendar.event(segment2, {targetDate: occurrenceDate}) %}

<ul>
{% if event %}
    <li>
        {{ event.title }} - {{ event.startDate.format("l d, Y") }}<br />
        {{ event.eventDescription }}
    </li>
{% endif %}
</ul>

```

--------------------------------

### Composer Version Constraints

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

Understand how Composer version constraints like '~' and '^' affect package updates.

```text
1.0.0 - means exactly & only this version
~1.0.0 - means this version & any _patch_ release (up to 1.0.99̅)
^1.0.0 - means this version & any _minor_ release (up to 1.99̅.99̅)
  * Specifying "solspace/craft-calendar": "^5.0.0", for example, would always get you the latest version of Calendar **5.x** (e.g. 5.1.9), but never the next _major_ version of Calendar like **6.x**.
```

--------------------------------

### Subscribe to Calendar Event Save

Source: https://docs.solspace.com/craft/calendar/v5/developer/events

Subscribe to the `EVENT_BEFORE_SAVE` event for calendar events to execute custom logic before an event is saved. This example shows how to access event details like whether it's a new event and the event element itself.

```php
<?php  
  
namespace Your\Plugin\Namespace;  
  
use Solspace\Calendar\Events\SaveElementEvent;  
use Solspace\Calendar\Services\EventsService;  
use craft\base\Plugin as BasePlugin;  
use yii\base\Event;  

class YourPlugin extends BasePlugin  
{
  public function init()
  {
    parent::init();

    // Forms  
    Event::on(  
      EventsService::class,  
      EventsService::EVENT_BEFORE_SAVE,  
      function (SaveElementEvent $event) {
		$isNew = $event->isNew();  
        $event = $event->getElement();  
        // Do something with this data  
      }
    );
  }
}
```

--------------------------------

### Configure composer.json for specific feature branches

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

Use this format to pull from a specific branch by prefixing with dev- and aliasing to a dummy version number.

```json
"require": {  
    "craftcms/cms": "^5.0.0",  
    "vlucas/phpdotenv": "^5.4.0",  
    "solspace/craft-calendar": "dev-feat/SFT-123 as 5.1.5-beta.1",  
    "solspace/craft-freeform": "^5.0.0",  
},  
```

--------------------------------

### Fetch and Display Calendar in Templates

Source: https://docs.solspace.com/craft/calendar/v5/templates/objects/calendar

Retrieves a calendar by its handle and renders its name with the associated color.

```twig
{% set calendar = craft.calendar.calendar({  
  handle: "holidays"  
}) %}  
  
{% if calendar %}  
  <div style="color: {{ calendar.color }};">  
    {{ calendar.name }}  
  </div>  
{% endif %}
```

--------------------------------

### Initialize Date and Time Pickers

Source: https://docs.solspace.com/craft/calendar/v5/guides/templating/events-front-end

Configures jQuery datepicker and timepicker plugins with settings derived from Craft Calendar variables.

```javascript
        $(".date-picker").datepicker({  
          dateFormat: dateFormat,  
          firstDay: {{ craft.calendar.settings.firstDayOfWeek }},  
        });  
        $(".time-picker").timepicker({  
          timeFormat: timeFormat,  
        });
```

--------------------------------

### Fetch and display calendars in templates

Source: https://docs.solspace.com/craft/calendar/v5/templates/queries/calendars

Use this query to retrieve a list of calendars ordered by name and iterate through them to display their properties.

```twig
{% set calendars = craft.calendar.calendars({  
  orderBy: "name",  
  sort: "asc"  
}) %}  
  
{% for calendar in calendars %}  
  <div style="color: {{ calendar.color }};">  
    {{ calendar.name }}  
  </div>  
{% endfor %}
```

--------------------------------

### Individual Calendar Configuration

Source: https://docs.solspace.com/craft/calendar/v5/configuration/project-config

Configure settings and field layouts for specific calendars in their respective YAML files. This includes name, handle, color, and site-specific URI formats.

```yaml
name: 'Blue Thunder'  
handle: blueThunder  
description: ''  
color: '#20A8B9'  
allowRepeatingEvents: true  
icsHash: ac3478d69a3c81fa62e60f5c3696165a4e5e6ac45aaa947450b782.65239311  
icsTimezone: floating  
descriptionFieldHandle: '0'  
locationFieldHandle: '0'  
hasTitleField: true  
titleFormat: ''  
titleLabel: Title  
siteSettings:  
  2394f11a-d45d-40d2-a5ee-5bd9f176417d:  
    enabledByDefault: true  
    hasUrls: true  
    siteId: 5f1d37f9-004d-414a-8e9c-48d763fba635  
    template: blue-thunder/_entry  
    uriFormat: 'blue-thunder/de/{slug}'  
  5968dff9-9263-456b-8f8e-5bb02b73f377:  
    enabledByDefault: true  
    hasUrls: true  
    siteId: 24990881-e55d-42d1-b228-92652cf50dfb  
    template: blue-thunder/_entry  
    uriFormat: 'blue-thunder/fr/{slug}'  
  a8560321-d302-4716-8045-13345fb36adf:  
    enabledByDefault: true  
    hasUrls: true  
    siteId: bfdeaad5-5273-4cf1-a390-05c8929e7795  
    template: blue-thunder/_entry  
    uriFormat: 'blue-thunder/{slug}'  
  c07e3df4-aa17-46a3-8ffa-077719d56011:  
    enabledByDefault: false  
    hasUrls: false  
    siteId: 8f0a08fa-5b1c-4c7b-84dd-bd93d571d031  
    template: null  
    uriFormat: null  
fieldLayout:  
  tabs:  
    - elements:  
        - fieldUid: ad144815-0d08-4ec6-948a-0b0c00190e2d  
          instructions: null  
          label: null  
          required: '0'  
          tip: null  
          type: craft\fieldlayoutelements\CustomField  
          warning: null  
          width: 100  
        - fieldUid: 252c0982-bae0-4040-b669-e2fd9149eff6  
          instructions: null  
          label: null  
          required: '0'  
          tip: null  
          type: craft\fieldlayoutelements\CustomField  
          warning: null  
          width: 100  
        - fieldUid: 390f343e-55c9-4362-996f-60e17d649e62  
          instructions: null  
          label: null  
          required: '0'  
          tip: null  
          type: craft\fieldlayoutelements\CustomField  
          warning: null  
          width: 100  
        - fieldUid: fcdc1067-21d1-4a91-8094-b38a27c60ebb  
          instructions: null  
          label: null  
          required: '0'  
          tip: null  
          type: craft\fieldlayoutelements\CustomField  
          warning: null  
          width: 100  
      name: 'Tab 1'  
      sortOrder: 1  
  uid: 079608e5-4374-408a-b6de-ad776486ba33  

```

--------------------------------

### Update Calendar via CLI

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

Update the Calendar plugin to the latest or a specific version.

```bash
php craft update calendar  
```

```bash
php craft update calendar:5.0.0  
```

--------------------------------

### Fix Missing Event Content (Calendar 5.x on Craft 4.x)

Source: https://docs.solspace.com/craft/calendar/v5/setup/installing-updating

Execute this command if Calendar 5.x was running on Craft 4.x before upgrading to Craft 5.x to resolve missing event content.

```bash
php craft calendar/events/fix-contents
```

--------------------------------

### Query events with arguments

Source: https://docs.solspace.com/craft/calendar/v5/headless/graphql

Demonstrates filtering events by ID and date ranges using GraphQL arguments.

```graphql
query {  
  solspace_calendar {  
    # This is just an example  
    # You can either pass a single value or an array of values for each argument  
    events(  
      id: [1, 2, 3]  
      startsBefore: "2021-01-31"  
      endsAfterOrAt: "2021-02-30"  
    ) {  
      id  
    }  
  }  
}  
```

--------------------------------

### General Calendar Configuration

Source: https://docs.solspace.com/craft/calendar/v5/configuration/project-config

Modify global Calendar settings in `/config/project.yaml`. This includes edition, license, and various display and behavior options.

```yaml
calendar:  
  edition: pro # You'll get license errors if you don't have a valid Pro license.  
  enabled: true  
  licenseKey: EXAMPLETEST12EXAMPLETEST  
  schemaVersion: 4.0.0  
  settings:  
    pluginName: '' # Custom name for plugin (Pro).  
    firstDayOfWeek: '-1' # The starting day of the week when viewing front end and control panel Month and Week views as well as datepickers. '-1' is default, which the current user's locale. '0' is Sunday, '1' is Monday, etc.  
    timeFormat: auto # Time format for dates and date pickers. 'auto' is current user's locale, Use '12-hour' or '24-hour' to set the same for all users.  
    showMiniCal: '1' # Displays a side menu with mini calendar and list of calendars, allowing you to filter your event results.  
    showDisabledEvents: '1' # Events that are disabled will be displayed in the views with faded styles.  
    quickCreateEnabled: '1' # Allows all users with event creation privileges to use the Quick Create event feature.  
    authoredEventEditOnly: '1' # Users (excluding Admins) with event creation privileges will only be able to edit or delete their own events.  
    defaultView: month # The default page to go to when clicking the Calendar nav item.  
    demoBannerDisabled: '1' # Hides the alert message suggesting to install demo templates when this setting is enabled.  
    eventDuration: '60' # The default event time duration for fieldtype, in minutes.  
    timeInterval: '30' # The time picker interval for fieldtype, in minutes.  
    allDay: '' # Have the 'All Day' option selected by default for new events.  
    overlapThreshold: '5' # The amount of hours in the next day which are still considered as those of the previous day.  
    guestAccess: # The calendar ID's guests should have access to create events for on the front end.  
      - '5'  
      - '1'  
      - '3'  
      - '6'  

```

--------------------------------

### Date Object Methods

Source: https://docs.solspace.com/craft/calendar/v5/templates/objects/date

Methods available for formatting and comparing Date objects.

```APIDOC
## Date Object Methods

### Methods
- **format(formatString)** - Format the date using PHP date formatting guidelines.
- **eq(date)** - Check if date is equal to another date.
- **ne(date)** - Check if dates are not equal.
- **gt(date)** - Check if date is greater than another date.
- **gte(date)** - Check if date is greater than or equal to another date.
- **lt(date)** - Check if date is less than another date.
- **lte(date)** - Check if date is less than or equal to another date.
- **between(start, end)** - Check if a date is between two other dates.
```

--------------------------------

### Iterate through events in an hour

Source: https://docs.solspace.com/craft/calendar/v5/templates/objects/hour

Demonstrates how to fetch an hour object and loop through its associated events within a Twig template.

```twig
{% set hour = craft.calendar.day({  
  date: "now",  
  calendar: ["holidays", "sports"]  
}) %}  
  
{% for event in hour.events %}  
  <div style="{{ event.calendar.color }};">  
    {{ event.title }}  
  </div>  
{% endfor %}
```

--------------------------------

### Fetch Calendar by Handle

Source: https://docs.solspace.com/craft/calendar/v5/templates/queries/calendar

Use this snippet to retrieve a specific calendar by its handle. Ensure the calendar exists before attempting to access its properties.

```twig
{% set calendar = craft.calendar.calendar({"handle": "holidays"}) %}

{% if calendar %}
  <div style="color: {{ calendar.color }};">
    {{ calendar.name }}
  </div>
{% endif %}

```

--------------------------------

### Export events with localized timezone simulation

Source: https://docs.solspace.com/craft/calendar/v5/templates/queries/export

Template implementation for exporting events with a specific timezone, useful as a workaround for Google Calendar's lack of floating timezone support.

```twig
{%- set events = craft.calendar.events({  
  calendarId: [1, 3, 5],  
  rangeStart: "1 year ago",  
  rangeEnd: "5 years",  
  loadOccurrences: false  
}) -%}  
  
{%- header "Content-Type: application/octet-stream" -%}  
{%- header "Content-Transfer-Encoding: binary" -%}  
  
{{- craft.calendar.export(events, {timezone: "America/New_York"}) -}}
```

--------------------------------

### Render Monthly Weekday Selection

Source: https://docs.solspace.com/craft/calendar/v5/guides/templating/events-front-end

Displays checkboxes for selecting specific weekdays for monthly recurrence rules.

```twig
{% for day, dayName in craft.calendar.weekDaysShort %}
    <input type="checkbox"
           id="repeats-by-month-week-day-{{ day }}"
           value="{{ day }}"
            {{ day in event.byDay ? "checked" }}
           name="calendarEvent[monthly][repeatsByWeekDay][]" />
    <label for="repeats-by-month-week-day-{{ day }}">{{ dayName }}</label>
{% endfor %}
```
Tokens:
Raw