<!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>[40108] trunk: REST API: Shim `post_date_gmt` for drafts / empty dates in the REST API.</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" 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/40108">40108</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/40108","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jnylen0</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-02-24 18:14:21 +0000 (Fri, 24 Feb 2017)</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'>REST API: Shim `post_date_gmt` for drafts / empty dates in the REST API.
Internally, WordPress uses a special `post_date_gmt` value of `0000-00-00 00:00:00` to indicate that a draft's date is "floating" and should be updated whenever the post is saved. This makes it much more difficult for API clients to know the correct date of a draft post.
This commit provides a best guess at a `date_gmt` value for draft posts in this situation using the `date` field and the site's current timezone offset.
Props joehoyle.
Fixes <a href="https://core.trac.wordpress.org/ticket/38883">#38883</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</a></li>
<li><a href="#trunktestsphpunitincludestestcaserestposttypecontrollerphp">trunk/tests/phpunit/includes/testcase-rest-post-type-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestpostscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp"></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/rest-api/endpoints/class-wp-rest-posts-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2017-02-24 17:47:30 UTC (rev 40107)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2017-02-24 18:14:21 UTC (rev 40108)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1391,7 +1391,16 @@
</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"> if ( ! empty( $schema['properties']['date_gmt'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data['date_gmt'] = $this->prepare_date_response( $post->post_date_gmt );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // For drafts, `post_date_gmt` may not be set, indicating that the
+ // date of the draft should be updated each time it is saved (see
+ // #38883). In this case, shim the value based on the `post_date`
+ // field with the site's timezone offset applied.
+ if ( '0000-00-00 00:00:00' === $post->post_date_gmt ) {
+ $post_date_gmt = date( 'Y-m-d H:i:s', strtotime( $post->post_date ) - ( get_option( 'gmt_offset' ) * 3600 ) );
+ } else {
+ $post_date_gmt = $post->post_date_gmt;
+ }
+ $data['date_gmt'] = $this->prepare_date_response( $post_date_gmt );
</ins><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"> if ( ! empty( $schema['properties']['guid'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1407,7 +1416,16 @@
</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"> if ( ! empty( $schema['properties']['modified_gmt'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data['modified_gmt'] = $this->prepare_date_response( $post->post_modified_gmt );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // For drafts, `post_modified_gmt` may not be set (see
+ // `post_date_gmt` comments above). In this case, shim the value
+ // based on the `post_modified` field with the site's timezone
+ // offset applied.
+ if ( '0000-00-00 00:00:00' === $post->post_modified_gmt ) {
+ $post_modified_gmt = date( 'Y-m-d H:i:s', strtotime( $post->post_modified ) - ( get_option( 'gmt_offset' ) * 3600 ) );
+ } else {
+ $post_modified_gmt = $post->post_modified_gmt;
+ }
+ $data['modified_gmt'] = $this->prepare_date_response( $post_modified_gmt );
</ins><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"> if ( ! empty( $schema['properties']['password'] ) ) {
</span></span></pre></div>
<a id="trunktestsphpunitincludestestcaserestposttypecontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/testcase-rest-post-type-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/testcase-rest-post-type-controller.php 2017-02-24 17:47:30 UTC (rev 40107)
+++ trunk/tests/phpunit/includes/testcase-rest-post-type-controller.php 2017-02-24 18:14:21 UTC (rev 40108)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -10,12 +10,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $post->post_name, $data['slug'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( get_permalink( $post->ID ), $data['link'] );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( '0000-00-00 00:00:00' === $post->post_date_gmt ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertNull( $data['date_gmt'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_date_gmt = date( 'Y-m-d H:i:s', strtotime( $post->post_date ) - ( get_option( 'gmt_offset' ) * 3600 ) );
+ $this->assertEquals( mysql_to_rfc3339( $post_date_gmt ), $data['date_gmt'] );
+ } else {
+ $this->assertEquals( mysql_to_rfc3339( $post->post_date_gmt ), $data['date_gmt'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( mysql_to_rfc3339( $post->post_date ), $data['date'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( '0000-00-00 00:00:00' === $post->post_modified_gmt ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertNull( $data['modified_gmt'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_modified_gmt = date( 'Y-m-d H:i:s', strtotime( $post->post_modified ) - ( get_option( 'gmt_offset' ) * 3600 ) );
+ $this->assertEquals( mysql_to_rfc3339( $post_modified_gmt ), $data['modified_gmt'] );
+ } else {
+ $this->assertEquals( mysql_to_rfc3339( $post->post_modified_gmt ), $data['modified_gmt'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( mysql_to_rfc3339( $post->post_modified ), $data['modified'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -139,18 +145,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'edit' === $context ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $post->guid, $data['guid']['raw'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- if ( '0000-00-00 00:00:00' === $post->post_date_gmt ) {
- $this->assertNull( $data['date_gmt'] );
- } else {
- $this->assertEquals( mysql_to_rfc3339( $post->post_date_gmt ), $data['date_gmt'] );
- }
-
- if ( '0000-00-00 00:00:00' === $post->post_modified_gmt ) {
- $this->assertNull( $data['modified_gmt'] );
- } else {
- $this->assertEquals( mysql_to_rfc3339( $post->post_modified_gmt ), $data['modified_gmt'] );
- }
</del><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"> $taxonomies = wp_list_filter( get_object_taxonomies( $post->post_type, 'objects' ), array( 'show_in_rest' => true ) );
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestpostscontrollerphp"></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/rest-api/rest-posts-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2017-02-24 17:47:30 UTC (rev 40107)
+++ trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2017-02-24 18:14:21 UTC (rev 40108)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1251,7 +1251,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $post_date, $post->post_date );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $results['date_gmt'], $data['date_gmt'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // TODO expect null here for drafts (see https://core.trac.wordpress.org/ticket/5698#comment:14)
</del><span class="cx" style="display: block; padding: 0 10px"> $post_date_gmt = str_replace( 'T', ' ', $results['date_gmt'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $post_date_gmt, $post->post_date_gmt );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1350,15 +1349,27 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_create_post_as_contributor() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$contributor_id );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ update_option( 'timezone_string', 'America/Chicago' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'POST', '/wp/v2/posts' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $params = $this->set_post_data(array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $params = $this->set_post_data( array(
+ // This results in a special `post_date_gmt` value of
+ // '0000-00-00 00:00:00'. See #38883.
</ins><span class="cx" style="display: block; padding: 0 10px"> 'status' => 'pending',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ));
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_body_params( $params );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 201, $response->get_status() );
+
+ $data = $response->get_data();
+ $post = get_post( $data['id'] );
+ $this->assertEquals( '0000-00-00 00:00:00', $post->post_date_gmt );
+ $this->assertNotEquals( '0000-00-00T00:00:00', $data['date_gmt'] );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->check_create_post_response( $response );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ update_option( 'timezone_string', '' );
</ins><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"> public function test_create_post_sticky() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1431,9 +1442,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $new_post = get_post( $data['id'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'draft', $data['status'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'draft', $new_post->post_status );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Confirm dates are null
- $this->assertNull( $data['date_gmt'] );
- $this->assertNull( $data['modified_gmt'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Confirm dates are shimmed for gmt_offset
+ $post_modified_gmt = date( 'Y-m-d H:i:s', strtotime( $new_post->post_modified ) + ( get_option( 'gmt_offset' ) * 3600 ) );
+ $post_date_gmt = date( 'Y-m-d H:i:s', strtotime( $new_post->post_date ) + ( get_option( 'gmt_offset' ) * 3600 ) );
+
+ $this->assertEquals( mysql_to_rfc3339( $post_modified_gmt ), $data['modified_gmt'] );
+ $this->assertEquals( mysql_to_rfc3339( $post_date_gmt ), $data['date_gmt'] );
</ins><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"> public function test_create_post_private() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2118,7 +2132,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $post_date, $post->post_date );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $results['date_gmt'], $data['date_gmt'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // TODO expect null here for drafts (see https://core.trac.wordpress.org/ticket/5698#comment:14)
</del><span class="cx" style="display: block; padding: 0 10px"> $post_date_gmt = str_replace( 'T', ' ', $results['date_gmt'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $post_date_gmt, $post->post_date_gmt );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2149,6 +2162,57 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
</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">+ public function test_empty_post_date_gmt_shimmed_using_post_date() {
+ global $wpdb;
+
+ wp_set_current_user( self::$editor_id );
+ update_option( 'timezone_string', 'America/Chicago' );
+
+ // Need to set dates using wpdb directly because `wp_update_post` and
+ // `wp_insert_post` have additional validation on dates.
+ $post_id = $this->factory->post->create();
+ $wpdb->update(
+ $wpdb->posts,
+ array(
+ 'post_date' => '2016-02-23 12:00:00',
+ 'post_date_gmt' => '0000-00-00 00:00:00',
+ ),
+ array(
+ 'ID' => $post_id,
+ ),
+ array( '%s', '%s' ),
+ array( '%d' )
+ );
+ wp_cache_delete( $post_id, 'posts' );
+
+ $post = get_post( $post_id );
+ $this->assertEquals( $post->post_date, '2016-02-23 12:00:00' );
+ $this->assertEquals( $post->post_date_gmt, '0000-00-00 00:00:00' );
+
+ $request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/posts/%d', $post_id ) );
+ $response = $this->server->dispatch( $request );
+ $this->assertEquals( 200, $response->get_status() );
+ $data = $response->get_data();
+
+ $this->assertEquals( '2016-02-23T12:00:00', $data['date'] );
+ $this->assertEquals( '2016-02-23T18:00:00', $data['date_gmt'] );
+
+ $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/posts/%d', $post_id ) );
+ $request->set_param( 'date', '2016-02-23T13:00:00' );
+ $response = $this->server->dispatch( $request );
+ $this->assertEquals( 200, $response->get_status() );
+ $data = $response->get_data();
+
+ $this->assertEquals( '2016-02-23T13:00:00', $data['date'] );
+ $this->assertEquals( '2016-02-23T19:00:00', $data['date_gmt'] );
+
+ $post = get_post( $post_id );
+ $this->assertEquals( $post->post_date, '2016-02-23 13:00:00' );
+ $this->assertEquals( $post->post_date_gmt, '2016-02-23 19:00:00' );
+
+ update_option( 'timezone_string', '' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_update_post_slug() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$editor_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>