Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Map: Allow customizing event caching #510

Merged
merged 1 commit into from
Nov 17, 2023
+20 −2
Merged

Map: Allow customizing event caching #510

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions mu-plugins/blocks/google-map-event-filters/google-map-event-filters.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,12 @@ function render( array $attributes, string $content, WP_Block $block ): string {
// This has to be called in `render()` to know which slug/dates to use.
$cron_args = array( $attributes['filterSlug'], $attributes['startDate'], $attributes['endDate'], true );

if ( ! wp_next_scheduled( 'prime_event_filters', $cron_args ) ) {
// Some custom filter slugs using `google_map_event_filters_{$filter_slug}` to pass data may need to run their
// own cron to prime the cache.
// See WordCamp's `themes/wporg-events-2023/inc/city-landing-pages.php` for an example.
$register_cron = apply_filters( 'google-map-event-filters-register-cron', true, $attributes['filterSlug'] );

if ( $register_cron && ! wp_next_scheduled( 'prime_event_filters', $cron_args ) ) {
wp_schedule_event(
time() + HOUR_IN_SECONDS,
'hourly',
Expand All @@ -65,7 +70,7 @@ function render( array $attributes, string $content, WP_Block $block ): string {
*/
function get_events( string $filter_slug, int $start_timestamp, int $end_timestamp, bool $force_refresh = false ) : array {
$events = array();
$cache_key = 'google-map-event-filters-' . md5( wp_json_encode( $filter_slug . $start_timestamp . $end_timestamp ) );
$cache_key = get_cache_key( compact( 'filter_slug', 'start_timestamp', 'end_timestamp' ) );
$cached_events = get_transient( $cache_key );

if ( $cached_events && ! $force_refresh ) {
Expand Down Expand Up @@ -94,6 +99,19 @@ function get_events( string $filter_slug, int $start_timestamp, int $end_timesta
return $events;
}

/**
* Get the cache key for a given set of events.
*
* Customizing the key is sometimes needed when using the `google_map_event_filters_{$filter_slug}` filter.
* See WordCamp's `themes/wporg-events-2023/inc/city-landing-pages.php` for an example.
*/
function get_cache_key( array $parts ): string {
$items = apply_filters( 'google_map_event_filters_cache_key_parts', $parts );
$key = 'google-map-event-filters-' . md5( wp_json_encode( implode( '|', $items ) ) );

return $key;
}

/**
* Get a list of all upcoming events across all sites.
*/
Expand Down
Loading