<!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>[56985] trunk: Sitemaps: add `lastmod` for individual posts and the homepage.</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/56985">56985</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/56985","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-10-23 15:40:44 +0000 (Mon, 23 Oct 2023)</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'>Sitemaps: add `lastmod` for individual posts and the homepage.
When the XML sitemaps feature was originally introduced, the `lastmod` field was omitted because guidance at the time indicated it was less important for search engines, plus for some entities it was computationally expensive to add. Now that the guidance has slightly changed, we are revisiting this and adding `lastmod` where easily possible.
- Adds `lastmod` to all individual post objects (of any post type) in the sitemap
- Adds `lastmod` to the homepage sitemap entry if the homepage is set to display the latest posts.
No `lastmod` is added for the individual sitemap pages in the sitemap index, nor for term archives or user archives. Those enhancements require additional changes, such as storing the modified date for a taxonomy term when something is added to that term. They can be revisited in separate follow-up tickets.
Props swissspidy, joemcgill.
Fixes <a href="https://core.trac.wordpress.org/ticket/52099">#52099</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludessitemapsprovidersclasswpsitemapspostsphp">trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php</a></li>
<li><a href="#trunktestsphpunittestssitemapssitemapsphp">trunk/tests/phpunit/tests/sitemaps/sitemaps.php</a></li>
<li><a href="#trunktestsphpunittestssitemapswpSitemapsPostsphp">trunk/tests/phpunit/tests/sitemaps/wpSitemapsPosts.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludessitemapsprovidersclasswpsitemapspostsphp"></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/sitemaps/providers/class-wp-sitemaps-posts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php 2023-10-23 13:15:17 UTC (rev 56984)
+++ trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php 2023-10-23 15:40:44 UTC (rev 56985)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -112,6 +112,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'loc' => home_url( '/' ),
</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">+ /*
+ * Get the most recent posts displayed on the homepage,
+ * and then sort them by their modified date to find
+ * the date the homepage was approximately last updated.
+ */
+ $latest_posts = new WP_Query(
+ array(
+ 'post_type' => 'post',
+ 'post_status' => 'publish',
+ 'orderby' => 'date',
+ 'order' => 'DESC',
+ 'no_found_rows' => true,
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ )
+ );
+
+ if ( ! empty( $latest_posts->posts ) ) {
+ $posts = wp_list_sort( $latest_posts->posts, 'post_modified_gmt', 'DESC' );
+ $sitemap_entry['lastmod'] = wp_date( DATE_W3C, strtotime( $posts[0]->post_modified_gmt ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the sitemap entry for the home page when the 'show_on_front' option equals 'posts'.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -125,7 +147,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $query->posts as $post ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $sitemap_entry = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'loc' => get_permalink( $post ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'loc' => get_permalink( $post ),
+ 'lastmod' => wp_date( DATE_W3C, strtotime( $post->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"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestssitemapssitemapsphp"></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/sitemaps/sitemaps.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/sitemaps/sitemaps.php 2023-10-23 13:15:17 UTC (rev 56984)
+++ trunk/tests/phpunit/tests/sitemaps/sitemaps.php 2023-10-23 15:40:44 UTC (rev 56985)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -251,6 +251,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post_list = $providers['posts']->get_url_list( 1, 'page' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_list_sorted = wp_list_sort( $post_list, 'lastmod', 'DESC' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $expected = $this->_get_expected_url_list( 'page', self::$pages );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add the homepage to the front of the URL list.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -257,7 +259,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array_unshift(
</span><span class="cx" style="display: block; padding: 0 10px"> $expected,
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'loc' => home_url( '/' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'loc' => home_url( '/' ),
+ 'lastmod' => $post_list_sorted[0]['lastmod'],
</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">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -378,7 +381,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return array_map(
</span><span class="cx" style="display: block; padding: 0 10px"> static function ( $post ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'loc' => get_permalink( $post ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'loc' => get_permalink( $post ),
+ 'lastmod' => get_post_modified_time( DATE_W3C, true, $post ),
</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"> $posts
</span></span></pre></div>
<a id="trunktestsphpunittestssitemapswpSitemapsPostsphp"></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/sitemaps/wpSitemapsPosts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/sitemaps/wpSitemapsPosts.php 2023-10-23 13:15:17 UTC (rev 56984)
+++ trunk/tests/phpunit/tests/sitemaps/wpSitemapsPosts.php 2023-10-23 15:40:44 UTC (rev 56985)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -59,7 +59,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $url_list = $posts_provider->get_url_list( 1, 'page' );
</span><span class="cx" style="display: block; padding: 0 10px"> $sitemap_entry = array_shift( $url_list );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertArrayHasKey( 'lastmod', $sitemap_entry );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEqualSetsWithIndex(
+ array(
+ 'loc' => home_url( '/' ),
+ 'lastmod' => '2000-01-01',
+ ),
+ $sitemap_entry
+ );
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,7 +72,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Callback for 'wp_sitemaps_posts_show_on_front_entry' filter.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function _show_on_front_entry( $sitemap_entry ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $sitemap_entry['lastmod'] = wp_date( DATE_W3C, time() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $sitemap_entry['lastmod'] = '2000-01-01';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $sitemap_entry;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -93,7 +99,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $expected = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $post_ids as $post_id ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $expected[] = array( 'loc' => home_url( "?p={$post_id}" ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $expected[] = array(
+ 'loc' => home_url( "?p={$post_id}" ),
+ 'lastmod' => get_post_modified_time( DATE_W3C, true, $post_id ),
+ );
</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"> // Check that the URL list is still in the order of the post IDs (i.e., sticky post wasn't moved to the front).
</span></span></pre>
</div>
</div>
</body>
</html>