Changeset 49275 for branches/5.5/src/wp-admin/includes/class-wp-community-events.php

Timestamp:

10/22/2020 04:03:25 AM (5 years ago)

Author:

tellyworth

Message:

Community Events: Display dates and times in the user's time zone.

Fixes #51130
Merges [49145], [49146], [49147], [49152], and [49201] to the 5.5 branch.
Props sippis, hlashbrooke, audrasjb, Rarst, iandunn

Location:

branches/5.5

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/class-wp-community-events.php (modified) (7 diffs)

branches/5.5/src/wp-admin/includes/class-wp-community-events.php

@@ -78 +78 @@
      *
      * @since 4.8.0
+     * @since 5.5.2 Response no longer contains formatted date field. They're added
+     *              in `wp.communityEvents.populateDynamicEventFields()` now.
      *
      * @param string $location_search Optional. City name to help determine the location.
@@ -159 +161 @@
             }
 
+            /*
+             * Store the raw response, because events will expire before the cache does.
+             * The response will need to be processed every page load.
+             */
             $this->cache_events( $response_body, $expiration );
 
-            $response_body = $this->trim_events( $response_body );
-            $response_body = $this->format_event_data_time( $response_body );
+            $response_body['events'] = $this->trim_events( $response_body['events'] );
 
             return $response_body;
@@ -341 +346 @@
      *
      * @since 4.8.0
+     * @since 5.5.2 Response no longer contains formatted date field. They're added
+     *              in `wp.communityEvents.populateDynamicEventFields()` now.
      *
      * @return array|false An array containing `location` and `events` items
@@ -347 +354 @@
     public function get_cached_events() {
         $cached_response = get_site_transient( $this->get_events_transient_key( $this->user_location ) );
-        $cached_response = $this->trim_events( $cached_response );
-
-        return $this->format_event_data_time( $cached_response );
+
+        if ( isset( $cached_response['events'] ) ) {
+            $cached_response['events'] = $this->trim_events( $cached_response['events'] );
+        }
+
+        return $cached_response;
     }
 
@@ -361 +371 @@
      *
      * @since 4.8.0
+     * @deprecated 5.6.0 No longer used in core.
      *
      * @param array $response_body The response which contains the events.
@@ -366 +377 @@
      */
     protected function format_event_data_time( $response_body ) {
+        _deprecated_function(
+            __METHOD__,
+            '5.5.2',
+            'This is no longer used by core, and only kept for backward compatibility.'
+        );
+
         if ( isset( $response_body['events'] ) ) {
             foreach ( $response_body['events'] as $key => $event ) {
@@ -436 +453 @@
      * @since 4.8.0
      * @since 4.9.7 Stick a WordCamp to the final list.
-     *
-     * @param array $response_body The response body which contains the events.
+     * @since 5.5.2 Accepts and returns only the events, rather than an entire HTTP response.
+     *
+     * @param array $events The events that will be prepared.
      * @return array The response body with events trimmed.
      */
-    protected function trim_events( $response_body ) {
-        if ( isset( $response_body['events'] ) ) {
-            $wordcamps = array();
-            $today     = current_time( 'Y-m-d' );
-
-            foreach ( $response_body['events'] as $key => $event ) {
-                /*
-                 * Skip WordCamps, because they might be multi-day events.
-                 * Save a copy so they can be pinned later.
-                 */
-                if ( 'wordcamp' === $event['type'] ) {
-                    $wordcamps[] = $event;
-                    continue;
-                }
-
-                // We don't get accurate time with timezone from API, so we only take the date part (Y-m-d).
-                $event_date = substr( $event['date'], 0, 10 );
-
-                if ( $today > $event_date ) {
-                    unset( $response_body['events'][ $key ] );
-                }
-            }
-
-            $response_body['events'] = array_slice( $response_body['events'], 0, 3 );
-            $trimmed_event_types     = wp_list_pluck( $response_body['events'], 'type' );
-
-            // Make sure the soonest upcoming WordCamp is pinned in the list.
-            if ( ! in_array( 'wordcamp', $trimmed_event_types, true ) && $wordcamps ) {
-                array_pop( $response_body['events'] );
-                array_push( $response_body['events'], $wordcamps[0] );
-            }
-        }
-
-        return $response_body;
+    protected function trim_events( array $events ) {
+        $future_events = array();
+
+        foreach ( $events as $event ) {
+            /*
+             * The API's `date` and `end_date` fields are in the _event's_ local timezone, but UTC is needed so
+             * it can be converted to the _user's_ local time.
+             */
+            $end_time = (int) $event['end_unix_timestamp'];
+
+            if ( time() < $end_time ) {
+                array_push( $future_events, $event );
+            }
+        }
+
+        $future_wordcamps = array_filter(
+            $future_events,
+            function( $wordcamp ) {
+                return 'wordcamp' === $wordcamp['type'];
+            }
+        );
+
+        $future_wordcamps    = array_values( $future_wordcamps ); // Remove gaps in indices.
+        $trimmed_events      = array_slice( $future_events, 0, 3 );
+        $trimmed_event_types = wp_list_pluck( $trimmed_events, 'type' );
+
+        // Make sure the soonest upcoming WordCamp is pinned in the list.
+        if ( $future_wordcamps && ! in_array( 'wordcamp', $trimmed_event_types, true ) ) {
+            array_pop( $trimmed_events );
+            array_push( $trimmed_events, $future_wordcamps[0] );
+        }
+
+        return $trimmed_events;
     }