<!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>[50012] trunk: Posts: Create a new function for resolving the post date.</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/50012">50012</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/50012","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>pento</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-01-25 01:06:25 +0000 (Mon, 25 Jan 2021)</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'>Posts: Create a new function for resolving the post date.
`wp_insert_post()` has a few checks using `post_date` and `post_date_gmt`, to determine the correct post date. This functionality is now extracted out into a new `wp_resolve_post_date()` function, allowing the checks to be reused elsewhere.
Props jmdodd.
Fixes <a href="https://core.trac.wordpress.org/ticket/52187">#52187</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.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="trunksrcwpincludespostphp"></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/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post.php 2021-01-25 00:08:02 UTC (rev 50011)
+++ trunk/src/wp-includes/post.php 2021-01-25 01:06:25 UTC (rev 50012)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3702,6 +3702,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'guid' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'import_id' => 0,
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => '',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'post_date' => '',
+ '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"> $postarr = wp_parse_args( $postarr, $defaults );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3835,25 +3837,11 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * If the post date is empty (due to having been new or a draft) and status
- * is not 'draft' or 'pending', set date to now.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Resolve the post date from any provided post date or post date GMT strings;
+ * if none are provided, the date will be set to now.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $postarr['post_date'] ) || '0000-00-00 00:00:00' === $postarr['post_date'] ) {
- if ( empty( $postarr['post_date_gmt'] ) || '0000-00-00 00:00:00' === $postarr['post_date_gmt'] ) {
- $post_date = current_time( 'mysql' );
- } else {
- $post_date = get_date_from_gmt( $postarr['post_date_gmt'] );
- }
- } else {
- $post_date = $postarr['post_date'];
- }
-
- // Validate the date.
- $mm = substr( $post_date, 5, 2 );
- $jj = substr( $post_date, 8, 2 );
- $aa = substr( $post_date, 0, 4 );
- $valid_date = wp_checkdate( $mm, $jj, $aa, $post_date );
- if ( ! $valid_date ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_date = wp_resolve_post_date( $postarr['post_date'], $postarr['post_date_gmt'] );
+ if ( ! $post_date ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $wp_error ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'invalid_date', __( 'Invalid date.' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4539,6 +4527,43 @@
</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">+ * Uses wp_checkdate to return a valid Gregorian-calendar value for post_date.
+ * If post_date is not provided, this first checks post_date_gmt if provided,
+ * then falls back to use the current time.
+ *
+ * For back-compat purposes in wp_insert_post, an empty post_date and an invalid
+ * post_date_gmt will continue to return '1970-01-01 00:00:00' rather than false.
+ *
+ * @since 5.7.0
+ *
+ * @param string $post_date The date in mysql format.
+ * @param string $post_date_gmt The GMT date in mysql format.
+ * @return string|false A valid Gregorian-calendar date string, or false on failure.
+ */
+function wp_resolve_post_date( $post_date = '', $post_date_gmt = '' ) {
+ // If the date is empty, set the date to now.
+ if ( empty( $post_date ) || '0000-00-00 00:00:00' === $post_date ) {
+ if ( empty( $post_date_gmt ) || '0000-00-00 00:00:00' === $post_date_gmt ) {
+ $post_date = current_time( 'mysql' );
+ } else {
+ $post_date = get_date_from_gmt( $post_date_gmt );
+ }
+ }
+
+ // Validate the date.
+ $month = substr( $post_date, 5, 2 );
+ $day = substr( $post_date, 8, 2 );
+ $year = substr( $post_date, 0, 4 );
+
+ $valid_date = wp_checkdate( $month, $day, $year, $post_date );
+
+ if ( ! $valid_date ) {
+ return false;
+ }
+ return $post_date;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Computes a unique slug for the post, when given the desired slug and some post details.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span></span></pre></div>
<a id="trunktestsphpunittestspostphp"></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/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post.php 2021-01-25 00:08:02 UTC (rev 50011)
+++ trunk/tests/phpunit/tests/post.php 2021-01-25 01:06:25 UTC (rev 50012)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1395,4 +1395,246 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $tags = wp_get_post_tags( $post->ID, array( 'fields' => 'ids' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSameSets( array( $tag_2['term_id'], $tag_3['term_id'] ), $tags );
</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 52187
+ */
+ public function test_insert_empty_post_date() {
+ $post_date_gmt = '2020-12-29 10:11:45';
+ $invalid_date = '2020-12-41 14:15:27';
+
+ // Empty post_date_gmt with floating status
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_status' => 'draft',
+ )
+ );
+ $post = get_post( $post_id );
+ $this->assertEqualsWithDelta( strtotime( gmdate( 'Y-m-d H:i:s' ) ), strtotime( $post->post_date ), 2, 'The dates should be equal' );
+ $this->assertEquals( '0000-00-00 00:00:00', $post->post_date_gmt );
+
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date_gmt' => '0000-00-00 00:00:00',
+ 'post_status' => 'draft',
+ )
+ );
+ $post = get_post( $post_id );
+ $this->assertEqualsWithDelta( strtotime( gmdate( 'Y-m-d H:i:s' ) ), strtotime( $post->post_date ), 2, 'The dates should be equal' );
+ $this->assertEquals( '0000-00-00 00:00:00', $post->post_date_gmt );
+
+ // Empty post_date_gmt without floating status
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_status' => 'publish',
+ )
+ );
+ $post = get_post( $post_id );
+ $this->assertEqualsWithDelta( strtotime( gmdate( 'Y-m-d H:i:s' ) ), strtotime( $post->post_date ), 2, 'The dates should be equal' );
+ $this->assertEqualsWithDelta( strtotime( gmdate( 'Y-m-d H:i:s' ) ), strtotime( get_gmt_from_date( $post->post_date ) ), 2, 'The dates should be equal' );
+
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date_gmt' => '0000-00-00 00:00:00',
+ 'post_status' => 'publish',
+ )
+ );
+ $post = get_post( $post_id );
+ $this->assertEqualsWithDelta( strtotime( gmdate( 'Y-m-d H:i:s' ) ), strtotime( $post->post_date ), 2, 'The dates should be equal' );
+ $this->assertEqualsWithDelta( strtotime( gmdate( 'Y-m-d H:i:s' ) ), strtotime( get_gmt_from_date( $post->post_date ) ), 2, 'The dates should be equal' );
+
+ // Valid post_date_gmt
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date_gmt' => $post_date_gmt,
+ )
+ );
+ $post = get_post( $post_id );
+ $this->assertEquals( get_date_from_gmt( $post_date_gmt ), $post->post_date );
+ $this->assertEquals( $post_date_gmt, $post->post_date_gmt );
+
+ // Invalid post_date_gmt
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date_gmt' => $invalid_date,
+ )
+ );
+ $post = get_post( $post_id );
+ $this->assertEquals( '1970-01-01 00:00:00', $post->post_date );
+ $this->assertEquals( '0000-00-00 00:00:00', $post->post_date_gmt );
+ }
+
+ /**
+ * @ticket 52187
+ */
+ public function test_insert_valid_post_date() {
+ $post_date = '2020-12-28 11:26:35';
+ $post_date_gmt = '2020-12-29 10:11:45';
+ $invalid_date = '2020-12-41 14:15:27';
+
+ // Empty post_date_gmt with floating status
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $post_date,
+ 'post_status' => 'draft',
+ )
+ );
+ $post = get_post( $post_id );
+ $this->assertEquals( $post_date, $post->post_date );
+ $this->assertEquals( '0000-00-00 00:00:00', $post->post_date_gmt );
+
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $post_date,
+ 'post_date_gmt' => '0000-00-00 00:00:00',
+ 'post_status' => 'draft',
+ )
+ );
+ $post = get_post( $post_id );
+ $this->assertEquals( $post_date, $post->post_date );
+ $this->assertEquals( '0000-00-00 00:00:00', $post->post_date_gmt );
+
+ // Empty post_date_gmt without floating status
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $post_date,
+ 'post_status' => 'publish',
+ )
+ );
+ $post = get_post( $post_id );
+ $this->assertEquals( $post_date, $post->post_date );
+ $this->assertEquals( get_gmt_from_date( $post_date ), $post->post_date_gmt );
+
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $post_date,
+ 'post_date_gmt' => '0000-00-00 00:00:00',
+ 'post_status' => 'publish',
+ )
+ );
+ $post = get_post( $post_id );
+ $this->assertEquals( $post_date, $post->post_date );
+ $this->assertEquals( get_gmt_from_date( $post_date ), $post->post_date_gmt );
+
+ // Valid post_date_gmt
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $post_date,
+ 'post_date_gmt' => $post_date_gmt,
+ )
+ );
+ $post = get_post( $post_id );
+ $this->assertEquals( $post_date, $post->post_date );
+ $this->assertEquals( $post_date_gmt, $post->post_date_gmt );
+
+ // Invalid post_date_gmt
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $post_date,
+ 'post_date_gmt' => $invalid_date,
+ )
+ );
+ $post = get_post( $post_id );
+ $this->assertEquals( $post_date, $post->post_date );
+ $this->assertEquals( '0000-00-00 00:00:00', $post->post_date_gmt );
+ }
+
+ /**
+ * @ticket 52187
+ */
+ public function test_insert_invalid_post_date() {
+ $post_date = '2020-12-28 11:26:35';
+ $post_date_gmt = '2020-12-29 10:11:45';
+ $invalid_date = '2020-12-41 14:15:27';
+
+ // Empty post_date_gmt with floating status
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $invalid_date,
+ 'post_status' => 'draft',
+ )
+ );
+ $this->assertEquals( 0, $post_id );
+
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $invalid_date,
+ 'post_date_gmt' => '0000-00-00 00:00:00',
+ 'post_status' => 'draft',
+ )
+ );
+ $this->assertEquals( 0, $post_id );
+
+ // Empty post_date_gmt without floating status
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $invalid_date,
+ 'post_status' => 'publish',
+ )
+ );
+ $this->assertEquals( 0, $post_id );
+
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $invalid_date,
+ 'post_date_gmt' => '0000-00-00 00:00:00',
+ 'post_status' => 'publish',
+ )
+ );
+ $this->assertEquals( 0, $post_id );
+
+ // Valid post_date_gmt
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $invalid_date,
+ 'post_date_gmt' => $post_date_gmt,
+ )
+ );
+ $this->assertEquals( 0, $post_id );
+
+ // Invalid post_date_gmt
+ $post_id = self::factory()->post->create(
+ array(
+ 'post_date' => $invalid_date,
+ 'post_date_gmt' => $invalid_date,
+ )
+ );
+ $this->assertEquals( 0, $post_id );
+ }
+
+ /**
+ * @ticket 52187
+ */
+ function test_wp_resolve_post_date() {
+ $post_date = '2020-12-28 11:26:35';
+ $post_date_gmt = '2020-12-29 10:11:45';
+ $invalid_date = '2020-12-41 14:15:27';
+
+ $resolved_post_date = wp_resolve_post_date();
+ $this->assertEqualsWithDelta( strtotime( gmdate( 'Y-m-d H:i:s' ) ), strtotime( $resolved_post_date ), 2, 'The dates should be equal' );
+
+ $resolved_post_date = wp_resolve_post_date( '', $post_date_gmt );
+ $this->assertEquals( get_date_from_gmt( $post_date_gmt ), $resolved_post_date );
+
+ $resolved_post_date = wp_resolve_post_date( '', $invalid_date );
+ $this->assertEquals( '1970-01-01 00:00:00', $resolved_post_date );
+
+ $resolved_post_date = wp_resolve_post_date( $post_date );
+ $this->assertEquals( $post_date, $resolved_post_date );
+
+ $resolved_post_date = wp_resolve_post_date( $post_date, $post_date_gmt );
+ $this->assertEquals( $post_date, $resolved_post_date );
+
+ $resolved_post_date = wp_resolve_post_date( $post_date, $invalid_date );
+ $this->assertEquals( $post_date, $resolved_post_date );
+
+ $resolved_post_date = wp_resolve_post_date( $invalid_date );
+ $this->assertFalse( $resolved_post_date );
+
+ $resolved_post_date = wp_resolve_post_date( $invalid_date, $post_date_gmt );
+ $this->assertFalse( $resolved_post_date );
+
+ $resolved_post_date = wp_resolve_post_date( $invalid_date, $invalid_date );
+ $this->assertFalse( $resolved_post_date );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>