The Events Calendar WordPress plugin
Welcome to the official git repository for the WordPress plugin The Events Calendar.
Please feel free to fork this repository and submit pull requests!
We do have some guidelines that you should keep in mind while working with this repository:
We have an internal release cycle and review pull requests once per cycle. Unfortunately we can't guarantee a regular schedule for our review process, but please know that while it may take 1-2 months (at the most) before we review your request, we WILL review it.
Please submit a detailed description with your pull request. If we can't figure out what you're submitting, then we may close your request.
We do not accept or handle support issues or bug reports here. You may notice that we have disabled the Issues tab on this GitHub project. Please submit bug reports at WordPress.org. If you have purchased any of our premium add-ons, you may create an account and submit support requests at our Premium Support Forums.
Please fork main and submit your pull requests against that branch. This is the branch with the latest code we are working on. Pull requests will be re-targeted against the branch for the next appropriate release before merged.
When developing apply define('SCRIPT_DEBUG', true) in your wp-config.php. This will load unminified versions of our js assets and give you some debugging information in your dev console.
Make yourself familiar with the dev folder, its readme and run the appropriate Grunt tasks before committing. Js minification, css minification, debug code removal, linting and more should be performed as you develop. Its all done with the grunt tasks defined in the dev folder.
Lastly: We don't recommend using the develop branch on production sites! You’re welcome to give it a shot, but it is totally unrecommended - and we cannot provide any support if things go wrong. You’re on your own if you run develop code on your site.
That's all! please have fun and code responsibly :)
Work on this repository is planned before it is written, using OpenSpec. This is enforced — every pull request is checked for a plan.
Plans do not live here. A TEC feature routinely spans several repositories, so a
spec kept in one of them is invisible from the others. They all live in one shared
store instead: the-events-calendar/plans.
npm install -g @fission-ai/openspec
git clone [email protected]:the-events-calendar/plans.git ~/repos/tec-plans
openspec store register ~/repos/tec-plans --id tec-plans
openspec config set defaultStore tec-plansThe clone path is yours to choose. The --id is not — every command refers to the
store as tec-plans.
SOFT-1234 becomes the change soft-1234:
openspec new change soft-1234 --store tec-plans --description "what this does"feat/SOFT-1234/short-desc.Commands that read or write plans take --store tec-plans: new change,
status, instructions, list, show, validate, archive, context and
doctor. The openspec store commands manage registrations instead and take
--id, which is why the setup block above uses that.
Setting the store as OpenSpec's global default is part of the setup, not an
optional extra. The stock OpenSpec skills and the /opsx:* commands know
nothing about our store and act on whatever root resolves from the current
directory, and this repository has no openspec/ root of its own — so without
the default they fail, or land the change in a stray root. The org-wide skills
repo's install.sh deliberately does not set it: it serves every StellarWP
brand. Confirm with openspec context, which should print Using OpenSpec root: tec-plans. Pass the flag anyway; it is right whether or not the default is set.
This section covers what is specific to working here. The
openspec-workflow skill covers the
workflow itself — writing a proposal worth reviewing and keeping it current — and
its TEC extension, tec-openspec, covers the shared store, the ticket-ID naming,
and archiving once (after the last repository merges, not per repo). Install it with:
The below will work only once the stellarwp/skills-se becomes public.
/plugin marketplace add stellarwp/skills-se
/plugin install nexcess-sePHP tests are Codeception + wp-browser suites run inside Docker by slic, exactly as CI does.
common is a git submodule of this plugin, but slic treats the-events-calendar/common as its own target: it gets its own composer install. Run every slic command from the parent directory that contains the-events-calendar/.
…Two suites need an extra plugin in the WordPress container:
${SLIC_BIN} wp plugin install elementor # elementor_integration
${SLIC_BIN} wp plugin install wordpress-seo # integrations_plugin_wordpress_seo${SLIC_BIN} use the-events-calendar
${SLIC_BIN} run integration
# a single file, or a single method
${SLIC_BIN} run wpunit tests/wpunit/Tribe/Events/Event_Test.php
${SLIC_BIN} run wpunit tests/wpunit/Tribe/Events/Event_Test.php:it_creates_an_event
# filter by name across the suite
${SLIC_BIN} run views_integration --filter=monthDo not run all suites in one codecept run; WordPress globals leak between them.
| Suite | Covers | CI |
|---|---|---|
aggregatorv1 |
Event Aggregator v1 REST endpoints | every PR |
blocks_editor_integration |
Block editor / Gutenberg blocks | every PR |
ct1_integration |
Custom Tables v1 schema and queries | every PR |
ct1_migration |
CT1 migration from the legacy meta storage | every PR |
ct1_multisite_integration |
CT1 under multisite | every PR |
ct1_wp_json_api |
WP REST API with CT1 enabled | every PR |
deprecated |
Deprecated functions and classes still resolve | every PR |
elementor_integration |
Elementor widgets (needs elementor) |
every PR (separate workflow) |
embed_calendar_integration |
Calendar embed shortcode/block | every PR |
event_status |
Event status (cancelled/postponed) | every PR |
features |
Feature-flag layer | no |
integration |
General plugin integration | every PR |
integration_category_colors |
Category colors feature | every PR |
integrations_plugin_wordpress_seo |
Yoast SEO compat (needs wordpress-seo, WP 6.9) |
every PR (separate workflow) |
muintegration |
Multisite integration | every PR |
rest_tec_v1_integration |
tec/v1 REST API |
every PR (+ OpenAPI lint) |
restv1 |
Legacy tribe/events/v1 REST API |
every PR |
rewrite_functional |
Permalinks and rewrite rules | every PR |
views_integration |
Views v2 rendering | every PR |
views_rest |
Views v2 REST responses | no — commented out of the matrix ("weird error with RBE changes") |
views_settings |
Views v2 settings | every PR |
views_ui |
Views v2 browser tests (needs Chrome container) | every PR |
views_v2_customizer_integration |
Views v2 Customizer styles | every PR |
views_widgets |
Views v2 widgets | every PR |
views_wpunit |
Views v2 unit-level | every PR |
wp_json_api |
Core WP REST API for TEC post types | every PR |
wpml_integration |
WPML compat | no |
wpunit |
Plugin unit tests | every PR |
All three workflows are gated on a PHP-file-change check, so a docs-only PR runs none of them.
wp core update --force --version=6.8 (6.9 for the SEO suite). Locally the container's bundled version is usually fine; add the same wp core update if you need to reproduce a version-specific failure.--ext DotReporter for compact logs; skip it locally for readable output.docker network prune -f steps are runner housekeeping with no local equivalent.rest_tec_v1_integration, CI also runs npm ci and npm run spectral -- http://localhost:8888/wp-json/tec/v1/docs/ to lint the OpenAPI doc. To reproduce: ${SLIC_BIN} wp plugin activate the-events-calendar && ${SLIC_BIN} wp rewrite structure '/%postname%/' --hard, then run those npm commands on the host from inside the-events-calendar/, which is where the package.json lives.No open issues yet, or sync has not completed.