enmi-conf.org: comparison wp/wp-admin/includes/class-wp-community-events.php

equal deleted inserted replaced

-:34716fd837a4
+:be944660c56a
 	/**
 	 * Stores location data for the user.
 	 *
 	 * @since 4.8.0
 	 *
-	 * @var bool|array
+	 * @var false|array
 	 */
 	protected $user_location = false;
 	/**
 	 * Constructor for WP_Community_Events.
 	 *
 	 * @since 4.8.0
 	 *
 	 * @param int        $user_id       WP user ID.
-	 * @param bool|array $user_location Stored location data for the user.
+	 * @param false|array $user_location {
-	 *                                  false to pass no location;
+	 *     Stored location data for the user. false to pass no location.
-	 *                                  array to pass a location {
+	 *
 	 *     @type string $description The name of the location
 	 *     @type string $latitude    The latitude in decimal degrees notation, without the degree
 	 *                               symbol. e.g.: 47.615200.
 	 *     @type string $longitude   The longitude in decimal degrees notation, without the degree
 	 *                               symbol. e.g.: -122.341100.
 	 * pass the data for caching. Having WP make the request also introduces
 	 * the opportunity to anonymize the IP before sending it to w.org, which
 	 * mitigates possible privacy concerns.
 	 *
 	 * @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.
 	 *                                e.g., "Seattle". Default empty string.
 	 * @param string $timezone        Optional. Timezone to help determine the location.
 	 *                                Default empty string.
 			 */
 			if ( $this->coordinates_match( $request_args['body'], $response_body['location'] ) && empty( $response_body['location']['description'] ) ) {
 				$response_body['location']['description'] = $this->user_location['description'];
 			}
+			/*
+			 * 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['events'] = $this->trim_events( $response_body['events'] );
-			$response_body = $this->format_event_data_time( $response_body );
 			return $response_body;
 		}
 	}
 	 * which is less prone to errors.
 	 *
 	 * @since 4.8.0
 	 *
 	 * @param array $location Should contain 'latitude' and 'longitude' indexes.
-	 * @return bool|string false on failure, or a string on success.
+	 * @return string|false Transient key on success, false on failure.
 	 */
 	protected function get_events_transient_key( $location ) {
 		$key = false;
 		if ( isset( $location['ip'] ) ) {
 	/**
 	 * Caches an array of events data from the Events API.
 	 *
 	 * @since 4.8.0
 	 *
-	 * @param array    $events     Response body from the API request.
+	 * @param array     $events     Response body from the API request.
-	 * @param int|bool $expiration Optional. Amount of time to cache the events. Defaults to false.
+	 * @param int|false $expiration Optional. Amount of time to cache the events. Defaults to false.
 	 * @return bool true if events were cached; false if not.
 	 */
 	protected function cache_events( $events, $expiration = false ) {
 		$set              = false;
 		$transient_key    = $this->get_events_transient_key( $events['location'] );
 	/**
 	 * Gets cached events.
 	 *
 	 * @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
 	 *                     on success, false on failure.
 	 */
 	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 );
+		if ( isset( $cached_response['events'] ) ) {
-		return $this->format_event_data_time( $cached_response );
+			$cached_response['events'] = $this->trim_events( $cached_response['events'] );
+		}
+		return $cached_response;
 	}
 	/**
 	 * Adds formatted date and time items for each event in an API response.
 	 *
 	 * the cached events are shared by all users. If it was called before storing
 	 * the cache, then all users would see the events in the localized data/time
 	 * of the user who triggered the cache refresh, rather than their own.
 	 *
 	 * @since 4.8.0
+	 * @deprecated 5.6.0 No longer used in core.
 	 *
 	 * @param array $response_body The response which contains the events.
 	 * @return array The response with dates and times formatted.
 	 */
 	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 ) {
 				$timestamp = strtotime( $event['date'] );
 				/*
 				 * The `date_format` option is not used because it's important
 				 * in this context to keep the day of the week in the formatted date,
 				 * so that users can tell at a glance if the event is on a day they
 				 * are available, without having to open the link.
 				 */
-				/* translators: Date format for upcoming events on the dashboard. Include the day of the week. See https://www.php.net/date */
+				/* translators: Date format for upcoming events on the dashboard. Include the day of the week. See https://www.php.net/manual/datetime.format.php */
 				$formatted_date = date_i18n( __( 'l, M j, Y' ), $timestamp );
 				$formatted_time = date_i18n( get_option( 'time_format' ), $timestamp );
 				if ( isset( $event['end_date'] ) ) {
 					$end_timestamp      = strtotime( $event['end_date'] );
 					$formatted_end_date = date_i18n( __( 'l, M j, Y' ), $end_timestamp );
 					if ( 'meetup' !== $event['type'] && $formatted_end_date !== $formatted_date ) {
-						/* translators: Upcoming events month format. See https://www.php.net/date */
+						/* translators: Upcoming events month format. See https://www.php.net/manual/datetime.format.php */
 						$start_month = date_i18n( _x( 'F', 'upcoming events month format' ), $timestamp );
 						$end_month   = date_i18n( _x( 'F', 'upcoming events month format' ), $end_timestamp );
 						if ( $start_month === $end_month ) {
 							$formatted_date = sprintf(
 								/* translators: Date string for upcoming events. 1: Month, 2: Starting day, 3: Ending day, 4: Year. */
 								__( '%1$s %2$d–%3$d, %4$d' ),
 								$start_month,
-								/* translators: Upcoming events day format. See https://www.php.net/date */
+								/* translators: Upcoming events day format. See https://www.php.net/manual/datetime.format.php */
 								date_i18n( _x( 'j', 'upcoming events day format' ), $timestamp ),
 								date_i18n( _x( 'j', 'upcoming events day format' ), $end_timestamp ),
-								/* translators: Upcoming events year format. See https://www.php.net/date */
+								/* translators: Upcoming events year format. See https://www.php.net/manual/datetime.format.php */
 								date_i18n( _x( 'Y', 'upcoming events year format' ), $timestamp )
 							);
 						} else {
 							$formatted_date = sprintf(
 								/* translators: Date string for upcoming events. 1: Starting month, 2: Starting day, 3: Ending month, 4: Ending day, 5: Year. */
 	 * the event will be at the end of the list, and will need to be moved into a
 	 * higher position, so that it doesn't get trimmed off.
 	 *
 	 * @since 4.8.0
 	 * @since 4.9.7 Stick a WordCamp to the final list.
-	 *
+	 * @since 5.5.2 Accepts and returns only the events, rather than an entire HTTP response.
-	 * @param array $response_body The response body which contains the events.
+	 *
+	 * @param array $events The events that will be prepared.
 	 * @return array The response body with events trimmed.
 	 */
-	protected function trim_events( $response_body ) {
+	protected function trim_events( array $events ) {
-		if ( isset( $response_body['events'] ) ) {
+		$future_events = array();
-			$wordcamps = array();
-			$today     = current_time( 'Y-m-d' );
+		foreach ( $events as $event ) {
+			/*
-			foreach ( $response_body['events'] as $key => $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.
-				 * Skip WordCamps, because they might be multi-day events.
+			 */
-				 * Save a copy so they can be pinned later.
+			$end_time = (int) $event['end_unix_timestamp'];
-				 */
-				if ( 'wordcamp' === $event['type'] ) {
+			if ( time() < $end_time ) {
-					$wordcamps[] = $event;
+				array_push( $future_events, $event );
-					continue;
+			}
-				}
+		}
-				// We don't get accurate time with timezone from API, so we only take the date part (Y-m-d).
+		$future_wordcamps = array_filter(
-				$event_date = substr( $event['date'], 0, 10 );
+			$future_events,
+			function( $wordcamp ) {
-				if ( $today > $event_date ) {
+				return 'wordcamp' === $wordcamp['type'];
-					unset( $response_body['events'][ $key ] );
+			}
-				}
+		);
-			}
+		$future_wordcamps    = array_values( $future_wordcamps ); // Remove gaps in indices.
-			$response_body['events'] = array_slice( $response_body['events'], 0, 3 );
+		$trimmed_events      = array_slice( $future_events, 0, 3 );
-			$trimmed_event_types     = wp_list_pluck( $response_body['events'], 'type' );
+		$trimmed_event_types = wp_list_pluck( $trimmed_events, 'type' );
-			// Make sure the soonest upcoming WordCamp is pinned in the list.
+		// Make sure the soonest upcoming WordCamp is pinned in the list.
-			if ( ! in_array( 'wordcamp', $trimmed_event_types, true ) && $wordcamps ) {
+		if ( $future_wordcamps && ! in_array( 'wordcamp', $trimmed_event_types, true ) ) {
-				array_pop( $response_body['events'] );
+			array_pop( $trimmed_events );
-				array_push( $response_body['events'], $wordcamps[0] );
+			array_push( $trimmed_events, $future_wordcamps[0] );
-			}
+		}
-		}
+		return $trimmed_events;
-		return $response_body;
 	}
 	/**
 	 * Logs responses to Events API requests.
 	 *

changeset 18	be944660c56a
parent 16	a86126ab1dd4
child 19	3d72ae0968f4