Hook Reference

Would you like to extend or customize Sugar Calendar Events with your own code? Sugar Calendar Events includes action and filter hooks that let you add content, change data, and run code when things happen, such as when someone saves an event or completes a ticket order.

In this tutorial, we’ll show you how to use the hooks in Sugar Calendar Events and where to find the right one for your project.

Before getting started, make sure Sugar Calendar Events is installed and activated on your WordPress site.

How to Use Hooks

Sugar Calendar Events has two kinds of hooks:

• Action hooks run your code at a specific point, for example, to output extra content on the event page. Attach code to them with add_action().
• Filter hooks pass a value through your code so you can change it, for example, to change the From name on emails. Attach code to them with add_filter(), and always return a value.

Add your code to a code snippets plugin or to your child theme’s functions.php file, so theme updates don’t remove it. For example, this snippet adds a line of text after the description on every single event page:

add_action( 'sc_after_event_content', function () {
	echo '<p>Doors open 30 minutes before the start time.</p>';
} );

To learn more about how hooks work, see the WordPress guides to action hooks and filter hooks.

Single Event Pages

Use these hooks to change what visitors see on a single event page. The event details rows run on sugar_calendar_frontend_event_details at these priorities: date (20), time (30), location (40), link (45), and calendars (50). Choose a priority to place your own row between them.

Events Archive

When your theme has no archive-sc_event.php file, Sugar Calendar Events displays the events archive as a built-in Events page. To learn more, see our guide to customizing template files.

Calendar and Event List Blocks

These hooks change the Calendar and Event List blocks and their shortcodes.

Event Data and Queries

Use these hooks to change how events are queried, or to run code when events are saved.

Post Types and Taxonomies

These filters change how Sugar Calendar Events registers its post types and taxonomies. To change the Calendars taxonomy, use the WordPress register_taxonomy_args filter for sc_event_category.

Venues, Speakers, and Maps

Use these hooks to change single venue and speaker pages, and the address and coordinates sent to Google Maps.

Emails

These hooks apply to the emails Sugar Calendar Events sends, such as ticket receipts and registration emails.

Event Ticketing

Use these hooks to customize ticket checkout, orders, and the ticket form. To learn more about tickets, see our Event Ticketing guide.

Registration Forms

These filters change how event registration forms work. To learn more, see our guide to creating a registration form.

Calendar Feeds, Import, and Export

Use these hooks to change calendar feeds and Add to Calendar links, and to run code during imports and exports.

Admin Area

Use these hooks to add your own fields to the event editor, change admin permissions, and customize the admin events list.

Integrations and AI

Use these hooks to respond to integration connections, change Zoom and Google Meet meetings, control Google Calendar syncing, and control the AI features.

Legacy Hooks

These hooks belong to Sugar Calendar’s older calendar and event list shortcodes and widgets. They still work, but they don’t run for the Calendar and Event List blocks. For new projects, use the hooks in the sections above.

Examples

Here are a few common customizations to get you started.

Add a Row to the Event Details

This snippet adds a Dress code row after the location on single event pages. Priority 42 places it between the location (40) and link (45) rows.

add_action( 'sugar_calendar_frontend_event_details', function ( $event ) {
	echo '<div class="sc-frontend-single-event__details-row">';
	echo '<div class="sc-frontend-single-event__details__label">Dress code:</div>';
	echo '<div class="sc-frontend-single-event__details__val">Smart casual</div>';
	echo '</div>';
}, 42 );

Change the Email From Name

This snippet changes the From name on emails Sugar Calendar Events sends.

add_filter( 'sc_email_from_name', function ( $name ) {
	return 'Sullie\'s Flowers Events';
} );

Run Code When a Ticket Order Completes

This snippet runs after Sugar Calendar Events saves a ticket order, for example, to send the order to another system.

add_action( 'sc_et_checkout_complete', function ( $payload, $order_id ) {
	error_log( 'Sugar Calendar order completed: ' . $order_id );
}, 10, 2 );

That’s it! You now know how to use the hooks in Sugar Calendar Events to customize your events.

Next, would you like to change how your event archive and single event pages look? Be sure to check out our tutorial on customizing template files to learn how.