Skip to content
CalendarWP DocumentationSearch documentation ⌘K / Ctrl K

CalendarWP core

Create events once, organize them into calendars, and display them in a calendar, event list, archive or event-details page. Upcoming Events and the bundled templates are included in core; they do not require another add-on.

Before you start

You need WordPress 6.7 or later, PHP 8.2 or later, and a block or classic theme. Use a modern browser with JavaScript for interactive calendar features. Use HTTPS for payments, OAuth and customer self-service links. Back up the WordPress database and plugin files before installation on an existing site or before an update.

Install and activate

  1. Open Plugins > Add Plugin > Upload Plugin.
  2. Upload the installable calendar-wp-{version}.zip, then activate CalendarWP. Do not upload an outer collection ZIP or an editable-source ZIP.
  3. Open CalendarWP > Options. Review date/time display, templates and the features you intend to use.
  4. To obtain licensed add-ons, open Options > Purchase Code, review the licensing-service disclosure and connect your valid purchase code. Core remains usable without connecting a purchase code.
  5. Open CalendarWP > Add-ons and install only the features you need. Configure opens the relevant settings. Shared provider credentials belong under Options > Integrations.

Create your first calendar

  1. Create a calendar under CalendarWP > Calendars. A calendar groups related events, such as classes or public holidays.
  2. Create an event with a title, description, start/end and timezone. Assign its calendar and, where relevant, venue and organizer.
  3. Publish the event.
  4. Edit a WordPress page, insert the CalendarWP block, select the desired views and filters, and publish.
  5. Open the page signed out. Confirm that the expected event appears and its details open correctly.

Use a named event timezone when appropriate so recurring local times follow daylight-saving changes. An all-day event does not need an invented start time. For recurring events, review the recurrence rule, exclusions and added dates; check an occurrence-specific link as well as the series page.

Display an event list

Insert CalendarWP – Upcoming Events. Choose List, Compact List, Card Grid or Agenda. Set the count, date window, calendar/venue/organizer filters and whether to show the next or all matching occurrences. Choose whether an event disappears when it starts or when it ends.

The list can inherit a taxonomy archive's current term. Private, password-protected and Personal Calendar events do not belong in this public list, even when an administrator views it. Use the dedicated personal display for owner-assigned events.

Customize templates and patterns

With a block theme, open Appearance > Editor > Templates, or use the shortcuts under CalendarWP > Options > Templates. Edit the event, archive, venue, organizer or calendar template and save. Site Editor saves an override in WordPress; it does not edit the plugin's original file. Plugin updates preserve that override, so a new default layout may not appear in a customized template.

Back up customizations before using Options > Tools > Reset Template Overrides: resetting removes the saved overrides and restores plugin defaults. Classic themes use bundled fallback templates. Do not edit plugin files directly because updates replace them. See Template defaults and overrides for template-specific controls.

Choose archive navigation

Under Options > Templates > Event archive navigation, choose Pagination or Endless scroll (auto-load) and save. Pagination is the default.

Auto-load adds the next page near the bottom of event archives and Calendar, Venue and Organizer event lists. Load more events remains available for manual loading. Automatic loading keeps keyboard focus in place; manual loading moves it to the first new event. If a request fails, ordinary page links and Try again remain available.

Custom templates must retain CalendarWP's inherited event list and native pagination. This setting does not alter directories or Compass results. Without JavaScript, visitors can still use ordinary pagination.

Update, troubleshoot and remove

Use the matching core/add-on versions supplied for the release. Back up files and database together; retain both for rollback. Never install the private licensing-service plugin on a customer site.

If an event is missing, check publication status, date window, timezone and taxonomy filters first. Review diagnostics under Options > Tools. For legacy Calendarize it! content, use Options > Setup > Calendarize it! Migration Readiness before adoption; keep a database backup.

Deactivation does not delete customer content or bookings. Review the separate removal settings before uninstalling. Preserve data unless you deliberately intend to remove it, and read Privacy and data first.

Applies to core 1.0.58-rc27. A feature description is not certification of every theme or hosting combination.

Search documentation

Browse all guides