<!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>[29344] trunk: Clarify that `get_the_date()`, `get_the_time()`, `get_post_time()` and `get_post_modified_time()` should return `false` when `get_post()` is `null`.</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 { 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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/29344">29344</a></dd>
<dt>Author</dt> <dd>wonderboymusic</dd>
<dt>Date</dt> <dd>2014-08-01 18:39:22 +0000 (Fri, 01 Aug 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Clarify that `get_the_date()`, `get_the_time()`, `get_post_time()` and `get_post_modified_time()` should return `false` when `get_post()` is `null`.
Adds unit tests.
Props GaryJ, SergeyBiryukov, tollmanz.
Fixes <a href="http://core.trac.wordpress.org/ticket/28310">#28310</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>
<li><a href="#trunktestsphpunittestspostphp">trunk/tests/phpunit/tests/post.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/functions.php (29343 => 29344)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/functions.php 2014-08-01 18:31:52 UTC (rev 29343)
+++ trunk/src/wp-includes/functions.php 2014-08-01 18:39:22 UTC (rev 29344)
</span><span class="lines">@@ -21,7 +21,7 @@
</span><span class="cx"> * @param string $format Format of the date to return.
</span><span class="cx"> * @param string $date Date string to convert.
</span><span class="cx"> * @param bool $translate Whether the return date should be translated. Default true.
</span><del>- * @return string|int Formatted date string, or Unix timestamp.
</del><ins>+ * @return string|int|bool Formatted date string or Unix timestamp. False if $date is empty.
</ins><span class="cx"> */
</span><span class="cx"> function mysql2date( $format, $date, $translate = true ) {
</span><span class="cx"> if ( empty( $date ) )
</span></span></pre></div>
<a id="trunksrcwpincludesgeneraltemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/general-template.php (29343 => 29344)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/general-template.php 2014-08-01 18:31:52 UTC (rev 29343)
+++ trunk/src/wp-includes/general-template.php 2014-08-01 18:39:22 UTC (rev 29344)
</span><span class="lines">@@ -1725,11 +1725,15 @@
</span><span class="cx"> *
</span><span class="cx"> * @param string $d Optional. PHP date format defaults to the date_format option if not specified.
</span><span class="cx"> * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
</span><del>- * @return string Date the current post was written.
</del><ins>+ * @return string|bool Date the current post was written. False on failure.
</ins><span class="cx"> */
</span><span class="cx"> function get_the_date( $d = '', $post = null ) {
</span><span class="cx"> $post = get_post( $post );
</span><span class="cx">
</span><ins>+ if ( ! $post ) {
+ return false;
+ }
+
</ins><span class="cx"> if ( '' == $d ) {
</span><span class="cx"> $the_date = mysql2date( get_option( 'date_format' ), $post->post_date );
</span><span class="cx"> } else {
</span><span class="lines">@@ -1839,11 +1843,15 @@
</span><span class="cx"> * was written. Either 'G', 'U', or php date format defaults
</span><span class="cx"> * to the value specified in the time_format option. Default empty.
</span><span class="cx"> * @param int|WP_Post $post WP_Post object or ID. Default is global $post object.
</span><del>- * @return string|int Formatted date string, or Unix timestamp.
</del><ins>+ * @return string|int|bool Formatted date string or Unix timestamp. False on failure.
</ins><span class="cx"> */
</span><span class="cx"> function get_the_time( $d = '', $post = null ) {
</span><span class="cx"> $post = get_post($post);
</span><span class="cx">
</span><ins>+ if ( ! $post ) {
+ return false;
+ }
+
</ins><span class="cx"> if ( '' == $d )
</span><span class="cx"> $the_time = get_post_time(get_option('time_format'), false, $post, true);
</span><span class="cx"> else
</span><span class="lines">@@ -1873,11 +1881,15 @@
</span><span class="cx"> * @param bool $gmt Optional. Whether to retrieve the GMT time. Default false.
</span><span class="cx"> * @param int|WP_Post $post WP_Post object or ID. Default is global $post object.
</span><span class="cx"> * @param bool $translate Whether to translate the time string. Default false.
</span><del>- * @return string|int Formatted date string, or Unix timestamp.
</del><ins>+ * @return string|int|bool Formatted date string or Unix timestamp. False on failure.
</ins><span class="cx"> */
</span><span class="cx"> function get_post_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
</span><span class="cx"> $post = get_post($post);
</span><span class="cx">
</span><ins>+ if ( ! $post ) {
+ return false;
+ }
+
</ins><span class="cx"> if ( $gmt )
</span><span class="cx"> $time = $post->post_date_gmt;
</span><span class="cx"> else
</span><span class="lines">@@ -1951,15 +1963,20 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><span class="cx"> *
</span><del>- * @param string $d Optional, default is 'U'. Either 'G', 'U', or php date format.
- * @param bool $gmt Optional, default is false. Whether to return the gmt time.
- * @param int|object $post Optional, default is global post object. A post_id or post object
- * @param bool $translate Optional, default is false. Whether to translate the result
- * @return string Returns timestamp
</del><ins>+ * @param string $d Optional. Format to use for retrieving the time the post
+ * was modified. Either 'G', 'U', or php date format. Default 'U'.
+ * @param bool $gmt Optional. Whether to retrieve the GMT time. Default false.
+ * @param int|WP_Post $post WP_Post object or ID. Default is global $post object.
+ * @param bool $translate Whether to translate the time string. Default false.
+ * @return string|int|bool Formatted date string or Unix timestamp. False on failure.
</ins><span class="cx"> */
</span><span class="cx"> function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
</span><span class="cx"> $post = get_post($post);
</span><span class="cx">
</span><ins>+ if ( ! $post ) {
+ return false;
+ }
+
</ins><span class="cx"> if ( $gmt )
</span><span class="cx"> $time = $post->post_modified_gmt;
</span><span class="cx"> else
</span></span></pre></div>
<a id="trunktestsphpunittestspostphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/tests/post.php (29343 => 29344)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/tests/post.php 2014-08-01 18:31:52 UTC (rev 29343)
+++ trunk/tests/phpunit/tests/post.php 2014-08-01 18:39:22 UTC (rev 29344)
</span><span class="lines">@@ -875,6 +875,163 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * @ticket 28310
+ */
+ function test_get_the_date_returns_false_with_null_post() {
+ $this->assertFalse( get_the_date() );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_the_date_returns_false_with_format_and_null_post() {
+ $this->assertFalse( get_the_date( 'F j, Y h:i:s' ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_the_date_returns_false_with_post_that_is_not_found() {
+ $this->assertFalse( get_the_date( '', 9 ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_the_date_returns_false_with_format_and_post_that_is_not_found() {
+ $this->assertFalse( get_the_date( 'F j, Y h:i:s', 9 ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_the_time_with_id_returns_correct_time() {
+ $post_id = $this->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 ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_the_time_returns_false_with_null_post() {
+ $this->assertFalse( get_the_time() );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_the_time_returns_false_with_format_and_null_post() {
+ $this->assertFalse( get_the_time( 'h:i:s' ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_the_time_returns_false_with_post_that_is_not_found() {
+ $this->assertFalse( get_the_time( '', 9 ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_the_time_returns_false_with_format_and_post_that_is_not_found() {
+ $this->assertFalse( get_the_time( 'h:i:s', 9 ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_post_time_with_id_returns_correct_time() {
+ $post_id = $this->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 ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_post_time_returns_false_with_null_post() {
+ $this->assertFalse( get_post_time() );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_post_time_returns_false_with_format_and_null_post() {
+ $this->assertFalse( get_post_time( 'h:i:s' ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_post_time_returns_false_with_post_that_is_not_found() {
+ $this->assertFalse( get_post_time( '', false, 9 ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_post_time_returns_false_with_format_and_post_that_is_not_found() {
+ $this->assertFalse( get_post_time( 'h:i:s', false, 9 ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_post_modified_time_with_id_returns_correct_time() {
+ $post_id = $this->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 ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_post_modified_time_returns_false_with_null_post() {
+ $this->assertFalse( get_post_modified_time() );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_post_modified_time_returns_false_with_format_and_null_post() {
+ $this->assertFalse( get_post_modified_time( 'h:i:s' ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_post_modified_time_returns_false_with_post_that_is_not_found() {
+ $this->assertFalse( get_post_modified_time( '', false, 9 ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_get_post_modified_time_returns_false_with_format_and_post_that_is_not_found() {
+ $this->assertFalse( get_post_modified_time( 'h:i:s', false, 9 ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_mysql2date_returns_false_with_no_date() {
+ $this->assertFalse( mysql2date( 'F j, Y H:i:s', '' ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_mysql2date_returns_gmt_unix_timestamp() {
+ $this->assertEquals( '441013392', mysql2date( 'G', '1983-12-23 07:43:12' ) );
+ }
+
+ /**
+ * @ticket 28310
+ */
+ function test_mysql2date_returns_unix_timestamp() {
+ $this->assertEquals( '441013392', mysql2date( 'U', '1983-12-23 07:43:12' ) );
+ }
+
+ /**
</ins><span class="cx"> * @ticket 25566
</span><span class="cx"> */
</span><span class="cx"> function test_wp_tag_cloud_link_with_post_type() {
</span></span></pre>
</div>
</div>
</body>
</html>