<!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>[46154] trunk: Date/Time: Introduce `get_post_datetime()` to retrieve post published or modified time as a `DateTimeImmutable` object instance.</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/46154">46154</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/46154","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>2019-09-17 11:13:25 +0000 (Tue, 17 Sep 2019)</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: Introduce `get_post_datetime()` to retrieve post published or modified time as a `DateTimeImmutable` object instance.
Introduce `get_post_timestamp()` to retrieve post published or modified time as a Unix timestamp.
Use `get_post_datetime()` in `get_post_time()` and `get_post_modified_time()` to return correct GMT time if default timezone is changed from UTC.
Props Rarst, johnregan3.
Fixes <a href="https://core.trac.wordpress.org/ticket/25002">#25002</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsdatepostTimephp">trunk/tests/phpunit/tests/date/postTime.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2019-09-16 23:33:45 UTC (rev 46153)
+++ trunk/src/wp-includes/general-template.php 2019-09-17 11:13:25 UTC (rev 46154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2515,7 +2515,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $d Optional. Format to use for retrieving the time the post
</span><span class="cx" style="display: block; padding: 0 10px"> * was written. Either 'G', 'U', or php date format defaults
</span><span class="cx" style="display: block; padding: 0 10px"> * to the value specified in the time_format option. Default empty.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Post $post WP_Post object or ID. Default is global $post object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Post $post WP_Post object or ID. Default is global `$post` object.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string|int|false Formatted date string or Unix timestamp if `$d` is 'U' or 'G'. False on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_the_time( $d = '', $post = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2553,7 +2553,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $d Optional. Format to use for retrieving the time the post
</span><span class="cx" style="display: block; padding: 0 10px"> * was written. Either 'G', 'U', or php date format. Default 'U'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $gmt Optional. Whether to retrieve the GMT time. Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Post $post WP_Post object or ID. Default is global $post object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Post $post WP_Post object or ID. Default is global `$post` object.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param bool $translate Whether to translate the time string. Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string|int|false Formatted date string or Unix timestamp if `$d` is 'U' or 'G'. False on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2564,14 +2564,29 @@
</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 ( $gmt ) {
- $time = $post->post_date_gmt;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $datetime = get_post_datetime( $post );
+
+ if ( false === $datetime ) {
+ return false;
+ }
+
+ 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 );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $time = $post->post_date;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $gmt ) {
+ $datetime = $datetime->setTimezone( new DateTimeZone( 'UTC' ) );
+ }
+
+ $time = $datetime->format( $d );
</ins><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">- $time = mysql2date( $d, $time, $translate );
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the localized time a post was written.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2586,6 +2601,55 @@
</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">+ * Retrieve post published or modified time as a `DateTimeImmutable` object instance.
+ *
+ * The object will be set to the timezone from WordPress settings.
+ *
+ * @since 5.3.0
+ *
+ * @param int|WP_Post $post Optional. WP_Post object or ID. Default is global `$post` object.
+ * @param string $field Optional. Post field to use. Accepts 'date' or 'modified'.
+ * @return DateTimeImmutable|false Time object on success, false on failure.
+ */
+function get_post_datetime( $post = null, $field = 'date' ) {
+ $post = get_post( $post );
+
+ if ( ! $post ) {
+ return false;
+ }
+
+ $time = ( 'modified' === $field ) ? $post->post_modified : $post->post_date;
+
+ if ( empty( $time ) || '0000-00-00 00:00:00' === $time ) {
+ return false;
+ }
+
+ return date_create_immutable_from_format( 'Y-m-d H:i:s', $time, wp_timezone() );
+}
+
+/**
+ * Retrieve post 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.3.0
+ *
+ * @param int|WP_Post $post Optional. WP_Post object or ID. Default is global `$post` object.
+ * @param string $field Optional. Post field to use. Accepts 'date' or 'modified'.
+ * @return int|false Unix timestamp on success, false on failure.
+ */
+function get_post_timestamp( $post = null, $field = 'date' ) {
+ $datetime = get_post_datetime( $post, $field );
+
+ if ( false === $datetime ) {
+ return false;
+ }
+
+ return $datetime->getTimestamp();
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Display the time at which the post was last modified.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2653,7 +2717,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $d Optional. Format to use for retrieving the time the post
</span><span class="cx" style="display: block; padding: 0 10px"> * was modified. Either 'G', 'U', or php date format. Default 'U'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $gmt Optional. Whether to retrieve the GMT time. Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|WP_Post $post WP_Post object or ID. Default is global $post object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|WP_Post $post WP_Post object or ID. Default is global `$post` object.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param bool $translate Whether to translate the time string. Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string|int|false Formatted date string or Unix timestamp if `$d` is 'U' or 'G'. False on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2664,14 +2728,29 @@
</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 ( $gmt ) {
- $time = $post->post_modified_gmt;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $datetime = get_post_datetime( $post, 'modified' );
+
+ if ( false === $datetime ) {
+ return false;
+ }
+
+ 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 );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $time = $post->post_modified;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $gmt ) {
+ $datetime = $datetime->setTimezone( new DateTimeZone( 'UTC' ) );
+ }
+
+ $time = $datetime->format( $d );
</ins><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">- $time = mysql2date( $d, $time, $translate );
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the localized time a post was last modified.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunktestsphpunittestsdatepostTimephp"></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/postTime.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/date/postTime.php (rev 0)
+++ trunk/tests/phpunit/tests/date/postTime.php 2019-09-17 11:13:25 UTC (rev 46154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,65 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group date
+ * @group datetime
+ */
+class Tests_Date_Post_Time extends WP_UnitTestCase {
+
+ /**
+ * @ticket 25002
+ */
+ public function test_should_return_wp_timestamp() {
+ $timezone = 'Europe/Kiev';
+ update_option( 'timezone_string', $timezone );
+
+ $datetime = new DateTimeImmutable( 'now', new DateTimeZone( $timezone ) );
+ $mysql = $datetime->format( 'Y-m-d H:i:s' );
+ $timestamp = $datetime->getTimestamp();
+ $wp_timestamp = $datetime->getTimestamp() + $datetime->getOffset();
+
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $mysql,
+ 'post_modified' => $mysql,
+ )
+ );
+
+ $this->assertEquals( $wp_timestamp, get_post_time( 'U', false, $post_id ) );
+ $this->assertEquals( $wp_timestamp, get_post_time( 'G', false, $post_id ) );
+ $this->assertEquals( $timestamp, get_post_time( 'U', true, $post_id ) );
+ $this->assertEquals( $timestamp, get_post_time( 'G', true, $post_id ) );
+ $this->assertEquals( $wp_timestamp, get_post_modified_time( 'U', false, $post_id ) );
+ $this->assertEquals( $wp_timestamp, get_post_modified_time( 'G', false, $post_id ) );
+ $this->assertEquals( $timestamp, get_post_modified_time( 'U', true, $post_id ) );
+ $this->assertEquals( $timestamp, get_post_modified_time( 'G', true, $post_id ) );
+ }
+
+ /**
+ * @ticket 25002
+ */
+ public function test_should_return_time() {
+ $timezone = 'Europe/Kiev';
+ update_option( 'timezone_string', $timezone );
+
+ $datetime = new DateTimeImmutable( 'now', new DateTimeZone( $timezone ) );
+ $mysql = $datetime->format( 'Y-m-d H:i:s' );
+ $rfc3339 = $datetime->format( DATE_RFC3339 );
+ $rfc3339_utc = $datetime->setTimezone( new DateTimeZone( 'UTC' ) )->format( DATE_RFC3339 );
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $mysql,
+ 'post_modified' => $mysql,
+ )
+ );
+
+ $this->assertEquals( $rfc3339, get_post_time( DATE_RFC3339, false, $post_id ) );
+ $this->assertEquals( $rfc3339_utc, get_post_time( DATE_RFC3339, true, $post_id ) );
+ $this->assertEquals( $rfc3339, get_post_time( DATE_RFC3339, false, $post_id, true ) );
+ $this->assertEquals( $rfc3339_utc, get_post_time( DATE_RFC3339, true, $post_id, true ) );
+ $this->assertEquals( $rfc3339, get_post_modified_time( DATE_RFC3339, false, $post_id ) );
+ $this->assertEquals( $rfc3339_utc, get_post_modified_time( DATE_RFC3339, true, $post_id ) );
+ $this->assertEquals( $rfc3339, get_post_modified_time( DATE_RFC3339, false, $post_id, true ) );
+ $this->assertEquals( $rfc3339_utc, get_post_modified_time( DATE_RFC3339, true, $post_id, true ) );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>