Changeset 48912 for trunk

Timestamp:

08/31/2020 03:56:41 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Date/Time: Make sure get_the_date() and related functions return correct time if the format was specified as false.

Technically, the $format argument should always be a string, but passing false used to work before [47808], so this restores backward compatibility.

The list of affected functions:

• get_the_date()
• get_the_time()
• get_comment_date()
• get_comment_time()

Props wittich, Rarst, akabarikalpesh, SergeyBiryukov.
Fixes #51184.

Location:

trunk

Files:

• src/wp-includes/comment-template.php (modified) (2 diffs)
• src/wp-includes/general-template.php (modified) (2 diffs)
• tests/phpunit/tests/date/getCommentDate.php (added)
• tests/phpunit/tests/date/getPostTime.php (modified) (2 diffs)
• tests/phpunit/tests/date/getTheDate.php (modified) (3 diffs)

trunk/src/wp-includes/comment-template.php

@@ -553 +553 @@
         $comment = get_comment( $comment_ID );
 
-        if ( '' === $format ) {
-                $date = mysql2date( get_option( 'date_format' ), $comment->comment_date );
-        } else {
-                $date = mysql2date( $format, $comment->comment_date );
-        }
+        if ( ! is_string( $format ) || '' === $format ) {
+                $format = get_option( 'date_format' );
+        }
+
+        $date = mysql2date( $format, $comment->comment_date );
 
         /**
@@ -1047 +1047 @@
         $comment_date = $gmt ? $comment->comment_date_gmt : $comment->comment_date;
 
-        if ( '' === $format ) {
-                $date = mysql2date( get_option( 'time_format' ), $comment_date, $translate );
-        } else {
-                $date = mysql2date( $format, $comment_date, $translate );
-        }
+        if ( ! is_string( $format ) || '' === $format ) {
+                $format = get_option( 'time_format' );
+        }
+
+        $date = mysql2date( $format, $comment_date, $translate );
 
         /**

trunk/src/wp-includes/general-template.php

@@ -2526 +2526 @@
         }
 
-        if ( '' === $format ) {
-                $the_date = get_post_time( get_option( 'date_format' ), false, $post, true );
-        } else {
-                $the_date = get_post_time( $format, false, $post, true );
-        }
+        if ( ! is_string( $format ) || '' === $format ) {
+                $format = get_option( 'date_format' );
+        }
+
+        $the_date = get_post_time( $format, false, $post, true );
 
         /**
@@ -2655 +2655 @@
         }
 
-        if ( '' === $format ) {
-                $the_time = get_post_time( get_option( 'time_format' ), false, $post, true );
-        } else {
-                $the_time = get_post_time( $format, false, $post, true );
-        }
+        if ( ! is_string( $format ) || '' === $format ) {
+                $format = get_option( 'time_format' );
+        }
+
+        $the_time = get_post_time( $format, false, $post, true );
 
         /**

trunk/tests/phpunit/tests/date/getPostTime.php

@@ -11 +11 @@
          * @ticket 28310
          */
-        public function test_get_post_time_with_id_returns_correct_time() {
+        public function test_get_post_time_returns_correct_time_with_post_id() {
                 $post_id = self::factory()->post->create( array( 'post_date' => '2014-03-01 16:35:00' ) );
+
                 $this->assertEquals( '16:35:00', get_post_time( 'H:i:s', false, $post_id ) );
         }
@@ -29 +30 @@
          * @ticket 28310
          */
-        public function test_get_post_modified_time_with_id_returns_correct_time() {
+        public function test_get_post_modified_time_returns_correct_time_with_post_id() {
                 $post_id = self::factory()->post->create( array( 'post_date' => '2014-03-01 16:35:00' ) );
+
                 $this->assertEquals( '16:35:00', get_post_modified_time( 'H:i:s', false, $post_id ) );
         }

trunk/tests/phpunit/tests/date/getTheDate.php

@@ -11 +11 @@
          * @ticket 13771
          */
-        function test_get_the_date_with_id_returns_correct_time() {
+        function test_get_the_date_returns_correct_time_with_post_id() {
                 $post_id = self::factory()->post->create( array( 'post_date' => '2014-03-01 16:35:00' ) );
+
                 $this->assertEquals( 'March 1, 2014', get_the_date( 'F j, Y', $post_id ) );
         }
@@ -27 +28 @@
 
         /**
+         * @ticket 51184
+         */
+        function test_get_the_date_returns_correct_time_with_empty_format() {
+                $post_id = self::factory()->post->create( array( 'post_date' => '2020-08-29 01:51:00' ) );
+
+                $this->assertEquals( 'August 29, 2020', get_the_date( '', $post_id ) );
+                $this->assertEquals( 'August 29, 2020', get_the_date( false, $post_id ) );
+        }
+
+        /**
          * @ticket 28310
          */
-        function test_get_the_time_with_id_returns_correct_time() {
+        function test_get_the_time_returns_correct_time_with_post_id() {
                 $post_id = self::factory()->post->create( array( 'post_date' => '2014-03-01 16:35:00' ) );
+
                 $this->assertEquals( '16:35:00', get_the_time( 'H:i:s', $post_id ) );
         }
@@ -43 +55 @@
                 $this->assertFalse( get_the_time( 'h:i:s', 9 ) );
         }
+
+        /**
+         * @ticket 51184
+         */
+        function test_get_the_time_returns_correct_time_with_empty_format() {
+                $post_id = self::factory()->post->create( array( 'post_date' => '2020-08-29 01:51:00' ) );
+
+                $this->assertEquals( '1:51 am', get_the_time( '', $post_id ) );
+                $this->assertEquals( '1:51 am', get_the_time( false, $post_id ) );
+        }
 }