Changeset 56985

Timestamp:

10/23/2023 03:40:44 PM (14 months ago)

Author:

swissspidy

Message:

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 #52099

Location:

trunk

Files:

• src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php (modified) (2 diffs)
• tests/phpunit/tests/sitemaps/sitemaps.php (modified) (3 diffs)
• tests/phpunit/tests/sitemaps/wpSitemapsPosts.php (modified) (3 diffs)

trunk/src/wp-includes/sitemaps/providers/class-wp-sitemaps-posts.php

@@ -113 +113 @@
             );
 
+            /*
+             * 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 ) );
+            }
+
             /**
              * Filters the sitemap entry for the home page when the 'show_on_front' option equals 'posts'.
@@ -126 +148 @@
         foreach ( $query->posts as $post ) {
             $sitemap_entry = array(
-                'loc' => get_permalink( $post ),
+                'loc'     => get_permalink( $post ),
+                'lastmod' => wp_date( DATE_W3C, strtotime( $post->post_modified_gmt ) ),
             );
 

trunk/tests/phpunit/tests/sitemaps/sitemaps.php

@@ -252 +252 @@
         $post_list = $providers['posts']->get_url_list( 1, 'page' );
 
+        $post_list_sorted = wp_list_sort( $post_list, 'lastmod', 'DESC' );
+
         $expected = $this->_get_expected_url_list( 'page', self::$pages );
 
@@ -258 +260 @@
             $expected,
             array(
-                'loc' => home_url( '/' ),
+                'loc'     => home_url( '/' ),
+                'lastmod' => $post_list_sorted[0]['lastmod'],
             )
         );
@@ -379 +382 @@
             static function ( $post ) {
                 return array(
-                    'loc' => get_permalink( $post ),
+                    'loc'     => get_permalink( $post ),
+                    'lastmod' => get_post_modified_time( DATE_W3C, true, $post ),
                 );
             },

trunk/tests/phpunit/tests/sitemaps/wpSitemapsPosts.php

@@ -60 +60 @@
         $sitemap_entry = array_shift( $url_list );
 
-        $this->assertArrayHasKey( 'lastmod', $sitemap_entry );
+        $this->assertEqualSetsWithIndex(
+            array(
+                'loc'     => home_url( '/' ),
+                'lastmod' => '2000-01-01',
+            ),
+            $sitemap_entry
+        );
     }
 
@@ -67 +73 @@
      */
     public function _show_on_front_entry( $sitemap_entry ) {
-        $sitemap_entry['lastmod'] = wp_date( DATE_W3C, time() );
+        $sitemap_entry['lastmod'] = '2000-01-01';
 
         return $sitemap_entry;
@@ -94 +100 @@
 
         foreach ( $post_ids as $post_id ) {
-            $expected[] = array( 'loc' => home_url( "?p={$post_id}" ) );
+            $expected[] = array(
+                'loc'     => home_url( "?p={$post_id}" ),
+                'lastmod' => get_post_modified_time( DATE_W3C, true, $post_id ),
+            );
         }