Changeset 9617

Timestamp:

03/11/2015 08:01:21 PM (10 years ago)

Author:

johnjamesjacoby

Message:

Core: Update bp_format_time:

• Use bp_get_option() over get_blog_option() and (incorrect) get_option() calls.
• Rename variables for clarity, as generic date/time/offset variables were easy to accidentally stomp.
• Port logic from wp_timezone_override_offset() and calculate timezone offset if timezone_string is set in the root blog's options.
• Pass $localize_time parameter into date_i18n() function call, to ensure the most accurate results possible are returned back from WordPress.

See #2693.

File:

• trunk/src/bp-core/bp-core-template.php (modified) (1 diff)

trunk/src/bp-core/bp-core-template.php

@@ -284 +284 @@
  *         'date_format' and 'time_format' settings are). False on failure.
  */
-function bp_format_time( $time, $just_date = false, $localize_time = true ) {
-
-    if ( ! isset( $time ) || ! is_numeric( $time ) ) {
+function bp_format_time( $time = '', $just_date = false, $localize_time = true ) {
+
+    // Bail if time is empty or not numeric
+    // @todo We should output something smarter here
+    if ( empty( $time ) || ! is_numeric( $time ) ) {
         return false;
     }
 
     // Get GMT offset from root blog
-    $root_blog_offset = false;
-    if ( ! empty( $localize_time ) ) {
-        $root_blog_offset = get_blog_option( bp_get_root_blog_id(), 'gmt_offset' );
-    }
-
-    // Calculate offset time
-    $time_offset = $time + ( $root_blog_offset * 3600 );
+    if ( true === $localize_time ) {
+
+        // Use Timezone string if set
+        $timezone_string = bp_get_option( 'timezone_string' );
+        if ( ! empty( $timezone_string ) ) {
+            $timezone_object = timezone_open( $timezone_string );
+            $datetime_object = date_create( "@{$time}" );
+            $timezone_offset = timezone_offset_get( $timezone_object, $datetime_object ) / HOUR_IN_SECONDS;
+
+        // Fall back on less reliable gmt_offset
+        } else {
+            $timezone_offset = bp_get_option( 'gmt_offset' );
+        }
+
+        // Calculate time based on the offset
+        $calculated_time = $time + ( $timezone_offset * HOUR_IN_SECONDS );
+
+    // No localizing, so just use the time that was submitted
+    } else {
+        $calculated_time = $time;
+    }
 
     // Current date (January 1, 2010)
-    $date = date_i18n( get_option( 'date_format' ), $time_offset );
+    $formatted_date = date_i18n( bp_get_option( 'date_format' ), $calculated_time, $localize_time );
 
     // Should we show the time also?
-    if ( empty( $just_date ) ) {
+    if ( false === $just_date ) {
+
         // Current time (9:50pm)
-        $time = date_i18n( get_option( 'time_format' ), $time_offset );
+        $formatted_time = date_i18n( bp_get_option( 'time_format' ), $calculated_time, $localize_time );
 
         // Return string formatted with date and time
-        $date = sprintf( __( '%1$s at %2$s', 'buddypress' ), $date, $time );
-    }
-
-    return apply_filters( 'bp_format_time', $date );
+        $formatted_date = sprintf( esc_html__( '%1$s at %2$s', 'buddypress' ), $formatted_date, $formatted_time );
+    }
+
+    return apply_filters( 'bp_format_time', $formatted_date );
 }