Ticket #48207: 48207.diff

src/wp-includes/comment-template.php

@@ -549 +549 @@
  */
 function get_comment_date( $d = '', $comment_ID = 0 ) {
         $comment = get_comment( $comment_ID );
+
         if ( '' == $d ) {
-                $date = mysql2date( get_option( 'date_format' ), $comment->comment_date );
+                $date = get_comment_time( get_option( 'date_format' ), false, true, $comment );
         } else {
-                $date = mysql2date( $d, $comment->comment_date );
+                $date = get_comment_time( $d, false, true, $comment );
         }
+
         /**
          * Filters the returned comment date.
          *
@@ -1004 +1006 @@
 }
 
 /**
- * Retrieve the comment time of the current comment.
+ * Retrieve comment published time as a `DateTimeImmutable` object instance.
+ *
+ * The object will be set to the timezone from WordPress settings.
+ *
+ * For legacy reasons, this function allows to choose to instantiate from local or UTC time in database.
+ * Normally this should make no difference to the result. However, the values might get out of sync in database,
+ * typically because of timezone setting changes. The parameter ensures the ability to reproduce backwards
+ * compatible behaviors in such cases.
+ *
+ * @since 5.4.0
+ *
+ * @param int|WP_Comment $comment   Optional. WP_Comment object or ID. Default is global `$comment` object.
+ * @param string         $source Optional. Local or UTC time to use from database. Accepts 'local' or 'gmt'.
+ *                            Default 'local'.
+ * @return DateTimeImmutable|false Time object on success, false on failure.
+ */
+function get_comment_datetime( $comment = null, $source = 'local' ) {
+        $comment = get_comment( $comment );
+
+        if ( ! $comment ) {
+                return false;
+        }
+
+        $wp_timezone = wp_timezone();
+
+        if ( 'gmt' === $source ) {
+                $time     = $comment->comment_date_gmt;
+                $timezone = new DateTimeZone( 'UTC' );
+        } else {
+                $time     = $comment->comment_date;
+                $timezone = $wp_timezone;
+        }
+
+        if ( empty( $time ) || '0000-00-00 00:00:00' === $time ) {
+                return false;
+        }
+
+        $datetime = date_create_immutable_from_format( 'Y-m-d H:i:s', $time, $timezone );
+
+        if ( false === $datetime ) {
+                return false;
+        }
+
+        return $datetime->setTimezone( $wp_timezone );
+}
+
+/**
+ * Retrieve comment published or modified time as a Unix timestamp.
+ *
+ * Note that this function returns a true Unix timestamp, not summed with timezone offset
+ * like older WP functions.
+ *
+ * @since 5.4.0
+ *
+ * @param int|WP_Comment $comment  Optional. WP_Comment object or ID. Default is global `$comment` object.
+* @return int|false Unix timestamp on success, false on failure.
+ */
+function get_comment_timestamp( $comment = null ) {
+        $datetime = get_comment_datetime( $comment, $field );
+
+        if ( false === $datetime ) {
+                return false;
+        }
+
+        return $datetime->getTimestamp();
+}
+
+
+/**
+
+
+/**
+ * Retrieve the comment time for a comment.
  *
  * @since 1.5.0
  *
@@ -1012 +1086 @@
  * @param bool   $gmt       Optional. Whether to use the GMT date. Default false.
  * @param bool   $translate Optional. Whether to translate the time (for use in feeds).
  *                          Default true.
+ * @param int|WP_Comment $comment Optional. WP_Comment object or ID. Default is global `$comment` object.
  * @return string The formatted time.
  */
-function get_comment_time( $d = '', $gmt = false, $translate = true ) {
+function get_comment_time( $d = '', $gmt = false, $translate = true, $comment = null ) {
         $comment = get_comment();
 
-        $comment_date = $gmt ? $comment->comment_date_gmt : $comment->comment_date;
-        if ( '' == $d ) {
-                $date = mysql2date( get_option( 'time_format' ), $comment_date, $translate );
+        $source   = ( $gmt ) ? 'gmt' : 'local';
+        $datetime = get_comment_datetime( $comment, $source );
+
+        if ( false === $datetime ) {
+                return false;
+        }
+
+        if ( '' === $d ) {
+                $d = get_option( 'time_format' );
+        }
+
+        if ( 'U' === $d || 'G' === $d ) {
+                $time = $datetime->getTimestamp();
+
+                // Returns a sum of timestamp with timezone offset. Ideally should never be used.
+                if ( ! $gmt ) {
+                        $time += $datetime->getOffset();
+                }
+        } elseif ( $translate ) {
+                $time = wp_date( $d, $datetime->getTimestamp(), $gmt ? new DateTimeZone( 'UTC' ) : null );
         } else {
-                $date = mysql2date( $d, $comment_date, $translate );
+                if ( $gmt ) {
+                        $datetime = $datetime->setTimezone( new DateTimeZone( 'UTC' ) );
+                }
+
+                $time = $datetime->format( $d );
         }
 
         /**
@@ -1029 +1125 @@
          *
          * @since 1.5.0
          *
-         * @param string|int $date      The comment time, formatted as a date string or Unix timestamp.
+         * @param string|int $time      The comment time, formatted as a date string or Unix timestamp.
          * @param string     $d         Date format.
          * @param bool       $gmt       Whether the GMT date is in use.
          * @param bool       $translate Whether the time is translated.
          * @param WP_Comment $comment   The comment object.
          */
-        return apply_filters( 'get_comment_time', $date, $d, $gmt, $translate, $comment );
+        return apply_filters( 'get_comment_time', $time, $d, $gmt, $translate, $comment );
 }
 
 /**