<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[48912] trunk: Date/Time: Make sure `get_the_date()` and related functions return correct time if the format was specified as `false`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/48912">48912</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/48912","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-08-31 15:56:41 +0000 (Mon, 31 Aug 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/changeset/47808">[47808]</a>, 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 <a href="https://core.trac.wordpress.org/ticket/51184">#51184</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.php</a></li>
<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>
<li><a href="#trunktestsphpunittestsdategetPostTimephp">trunk/tests/phpunit/tests/date/getPostTime.php</a></li>
<li><a href="#trunktestsphpunittestsdategetTheDatephp">trunk/tests/phpunit/tests/date/getTheDate.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsdategetCommentDatephp">trunk/tests/phpunit/tests/date/getCommentDate.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescommenttemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/comment-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment-template.php 2020-08-31 15:33:45 UTC (rev 48911)
+++ trunk/src/wp-includes/comment-template.php 2020-08-31 15:56:41 UTC (rev 48912)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -552,12 +552,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function get_comment_date( $format = '', $comment_ID = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $comment = get_comment( $comment_ID );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( '' === $format ) {
- $date = mysql2date( get_option( 'date_format' ), $comment->comment_date );
- } else {
- $date = mysql2date( $format, $comment->comment_date );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! is_string( $format ) || '' === $format ) {
+ $format = get_option( 'date_format' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $date = mysql2date( $format, $comment->comment_date );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the returned comment date.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1046,12 +1046,12 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $comment_date = $gmt ? $comment->comment_date_gmt : $comment->comment_date;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( '' === $format ) {
- $date = mysql2date( get_option( 'time_format' ), $comment_date, $translate );
- } else {
- $date = mysql2date( $format, $comment_date, $translate );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! is_string( $format ) || '' === $format ) {
+ $format = get_option( 'time_format' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $date = mysql2date( $format, $comment_date, $translate );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the returned comment time.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunksrcwpincludesgeneraltemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/general-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/general-template.php 2020-08-31 15:33:45 UTC (rev 48911)
+++ trunk/src/wp-includes/general-template.php 2020-08-31 15:56:41 UTC (rev 48912)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2525,12 +2525,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( '' === $format ) {
- $the_date = get_post_time( get_option( 'date_format' ), false, $post, true );
- } else {
- $the_date = get_post_time( $format, false, $post, true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! is_string( $format ) || '' === $format ) {
+ $format = get_option( 'date_format' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $the_date = get_post_time( $format, false, $post, true );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the date a post was published.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2654,12 +2654,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( '' === $format ) {
- $the_time = get_post_time( get_option( 'time_format' ), false, $post, true );
- } else {
- $the_time = get_post_time( $format, false, $post, true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! is_string( $format ) || '' === $format ) {
+ $format = get_option( 'time_format' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $the_time = get_post_time( $format, false, $post, true );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the time a post was written.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunktestsphpunittestsdategetCommentDatephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/date/getCommentDate.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/date/getCommentDate.php (rev 0)
+++ trunk/tests/phpunit/tests/date/getCommentDate.php 2020-08-31 15:56:41 UTC (rev 48912)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,49 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group date
+ * @group datetime
+ * @group comment
+ */
+class Tests_Date_Get_Comment_Date extends WP_UnitTestCase {
+
+ /**
+ * @ticket 51184
+ */
+ function test_get_comment_date_returns_correct_time_with_comment_id() {
+ $c = self::factory()->comment->create( array( 'comment_date' => '2020-08-29 01:51:00' ) );
+
+ $this->assertEquals( 'August 29, 2020', get_comment_date( 'F j, Y', $c ) );
+ }
+
+ /**
+ * @ticket 51184
+ */
+ function test_get_comment_date_returns_correct_time_with_empty_format() {
+ $c = self::factory()->comment->create( array( 'comment_date' => '2020-08-29 01:51:00' ) );
+
+ $this->assertEquals( 'August 29, 2020', get_comment_date( '', $c ) );
+ $this->assertEquals( 'August 29, 2020', get_comment_date( false, $c ) );
+ }
+
+ /**
+ * @ticket 51184
+ */
+ function test_get_comment_time_returns_correct_time() {
+ $c = self::factory()->comment->create( array( 'comment_date' => '2020-08-29 01:51:00' ) );
+
+ $GLOBALS['comment'] = get_comment( $c );
+ $this->assertEquals( '1:51 am', get_comment_time( 'g:i a' ) );
+ }
+
+ /**
+ * @ticket 51184
+ */
+ function test_get_comment_time_returns_correct_time_with_empty_format() {
+ $c = self::factory()->comment->create( array( 'comment_date' => '2020-08-29 01:51:00' ) );
+
+ $GLOBALS['comment'] = get_comment( $c );
+ $this->assertEquals( '1:51 am', get_comment_time( '' ) );
+ $this->assertEquals( '1:51 am', get_comment_time( false ) );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/date/getCommentDate.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunittestsdategetPostTimephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/date/getPostTime.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/date/getPostTime.php 2020-08-31 15:33:45 UTC (rev 48911)
+++ trunk/tests/phpunit/tests/date/getPostTime.php 2020-08-31 15:56:41 UTC (rev 48912)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -10,8 +10,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 28310
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_get_post_time_with_id_returns_correct_time() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_get_post_time_returns_correct_time_with_post_id() {
</ins><span class="cx" style="display: block; padding: 0 10px"> $post_id = self::factory()->post->create( array( 'post_date' => '2014-03-01 16:35:00' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '16:35:00', get_post_time( 'H:i:s', false, $post_id ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -28,8 +29,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 28310
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_get_post_modified_time_with_id_returns_correct_time() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_get_post_modified_time_returns_correct_time_with_post_id() {
</ins><span class="cx" style="display: block; padding: 0 10px"> $post_id = self::factory()->post->create( array( 'post_date' => '2014-03-01 16:35:00' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '16:35:00', get_post_modified_time( 'H:i:s', false, $post_id ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsdategetTheDatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/date/getTheDate.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/date/getTheDate.php 2020-08-31 15:33:45 UTC (rev 48911)
+++ trunk/tests/phpunit/tests/date/getTheDate.php 2020-08-31 15:56:41 UTC (rev 48912)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -10,8 +10,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 13771
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function test_get_the_date_with_id_returns_correct_time() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_get_the_date_returns_correct_time_with_post_id() {
</ins><span class="cx" style="display: block; padding: 0 10px"> $post_id = self::factory()->post->create( array( 'post_date' => '2014-03-01 16:35:00' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'March 1, 2014', get_the_date( 'F j, Y', $post_id ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -26,10 +27,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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 ) );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 28310
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function test_get_the_time_with_id_returns_correct_time() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_get_the_time_returns_correct_time_with_post_id() {
</ins><span class="cx" style="display: block; padding: 0 10px"> $post_id = self::factory()->post->create( array( 'post_date' => '2014-03-01 16:35:00' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '16:35:00', get_the_time( 'H:i:s', $post_id ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -42,4 +54,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( get_the_time( '', 9 ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( get_the_time( 'h:i:s', 9 ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @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 ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>