<!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>[46974] trunk: Date/Time: Ensure that `get_feed_build_date()` correctly handles a modified post object with invalid 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/46974">46974</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/46974","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-12-17 20:41:09 +0000 (Tue, 17 Dec 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: Ensure that `get_feed_build_date()` correctly handles a modified post object with invalid date.
* Clarify in the documentation that the function returns `false` on failure.
* Consistently pass the return value through the `get_feed_build_date` filter.
Props Rarst, dd32, azaozz, tellyworth.
Fixes <a href="https://core.trac.wordpress.org/ticket/48957">#48957</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfeedphp">trunk/src/wp-includes/feed.php</a></li>
<li><a href="#trunktestsphpunittestsdategetFeedBuildDatephp">trunk/tests/phpunit/tests/date/getFeedBuildDate.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfeedphp"></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/feed.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/feed.php 2019-12-17 20:24:46 UTC (rev 46973)
+++ trunk/src/wp-includes/feed.php 2019-12-17 20:41:09 UTC (rev 46974)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -648,9 +648,9 @@
</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">- * Get the timestamp of the most recently modified post from WP_Query.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Get the UTC time of the most recently modified post from WP_Query.
</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 viewing a comment feed, the timestamp of the most recently modified
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If viewing a comment feed, the time of the most recently modified
</ins><span class="cx" style="display: block; padding: 0 10px"> * comment will be returned.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Query $wp_query WordPress Query object.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -657,38 +657,41 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $format Format of the timestamp to return, passed to mysql2date.
- *
- * @return string The timestamp.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $format Date format string to return the time in.
+ * @return string|false The time in requested format, or false on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_feed_build_date( $format ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_query;
</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 ( empty( $wp_query ) || ! $wp_query->have_posts() ) {
- // Fallback to last time any post was modified or published.
- return get_lastpostmodified( 'GMT' );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $datetime = false;
+ $max_modified_time = false;
+ $utc = new DateTimeZone( 'UTC' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Extract the post modified times from the posts.
- $modified_times = wp_list_pluck( $wp_query->posts, 'post_modified_gmt' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $wp_query ) && $wp_query->have_posts() ) {
+ // Extract the post modified times from the posts.
+ $modified_times = wp_list_pluck( $wp_query->posts, 'post_modified_gmt' );
</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 this is a comment feed, check those objects too.
- if ( $wp_query->is_comment_feed() && $wp_query->comment_count ) {
- // Extract the comment modified times from the comments.
- $comment_times = wp_list_pluck( $wp_query->comments, 'comment_date_gmt' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If this is a comment feed, check those objects too.
+ if ( $wp_query->is_comment_feed() && $wp_query->comment_count ) {
+ // Extract the comment modified times from the comments.
+ $comment_times = wp_list_pluck( $wp_query->comments, 'comment_date_gmt' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Add the comment times to the post times for comparison.
- $modified_times = array_merge( $modified_times, $comment_times );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Add the comment times to the post times for comparison.
+ $modified_times = array_merge( $modified_times, $comment_times );
+ }
+
+ // Determine the maximum modified time.
+ $datetime = date_create_immutable_from_format( 'Y-m-d H:i:s', max( $modified_times ), $utc );
</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">- // Determine the maximum modified time.
- $datetime = date_create_immutable_from_format(
- 'Y-m-d H:i:s',
- max( $modified_times ),
- new DateTimeZone( 'UTC' )
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( false === $datetime ) {
+ // Fall back to last time any post was modified or published.
+ $datetime = date_create_immutable_from_format( 'Y-m-d H:i:s', get_lastpostmodified( 'GMT' ), $utc );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $max_modified_time = $datetime->format( $format );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( false !== $datetime ) {
+ $max_modified_time = $datetime->format( $format );
+ }
</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"> * Filters the date the last post or comment in the query was modified.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -695,8 +698,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $max_modified_time Date the last post or comment was modified in the query.
- * @param string $format The date format requested in get_feed_build_date.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|false $max_modified_time Date the last post or comment was modified in the query, in UTC.
+ * False on failure.
+ * @param string $format The date format requested in get_feed_build_date().
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'get_feed_build_date', $max_modified_time, $format );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsdategetFeedBuildDatephp"></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/getFeedBuildDate.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/date/getFeedBuildDate.php 2019-12-17 20:24:46 UTC (rev 46973)
+++ trunk/tests/phpunit/tests/date/getFeedBuildDate.php 2019-12-17 20:41:09 UTC (rev 46974)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -37,4 +37,46 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '2018-07-23T03:13:23+00:00', get_feed_build_date( DATE_RFC3339 ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Test that get_feed_build_date() works with invalid post dates.
+ *
+ * @ticket 48957
+ */
+ public function test_should_fall_back_to_last_post_modified() {
+ global $wp_query;
+
+ update_option( 'timezone_string', 'Europe/Kiev' );
+ $datetime = new DateTimeImmutable( 'now', wp_timezone() );
+ $datetime_utc = $datetime->setTimezone( new DateTimeZone( 'UTC' ) );
+
+ $wp_query->posts = array();
+
+ $this->assertFalse( get_feed_build_date( DATE_RFC3339 ), 'False when unable to determine valid time' );
+
+ $this->factory->post->create(
+ array(
+ 'post_date' => $datetime->format( 'Y-m-d H:i:s' ),
+ )
+ );
+
+ $this->assertEquals(
+ $datetime_utc->format( DATE_RFC3339 ),
+ get_feed_build_date( DATE_RFC3339 ),
+ 'Fall back to time of last post modified with no posts'
+ );
+
+ $post_id_broken = $this->factory->post->create();
+ $post_broken = get_post( $post_id_broken );
+
+ $post_broken->post_modified_gmt = 0;
+
+ $wp_query->posts = array( $post_broken );
+
+ $this->assertEquals(
+ $datetime_utc->format( DATE_RFC3339 ),
+ get_feed_build_date( DATE_RFC3339 ),
+ 'Fall back to time of last post modified with broken post object'
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>