Changeset 48872 for trunk/src/wp-includes/sitemaps.php

Timestamp:

08/27/2020 01:28:24 AM (5 years ago)

Author:

peterwilsoncc

Message:

Sitemaps: Prevent incorrect redirection of paged sitemap requests.

Update redirect_canonical() to account for custom pagination and URL format used by sitemaps in order to follow standard practices.

Introduce the function get_sitemap_url() to simplify getting the index and provider URLs as needed.

Props jonathanstegall, pbiron, GamerZ, salvoaranzulla, peterwilsoncc.
Fixes #50910.

File:

• trunk/src/wp-includes/sitemaps.php (modified) (1 diff)

trunk/src/wp-includes/sitemaps.php

@@ -88 +88 @@
     return apply_filters( 'wp_sitemaps_max_urls', 2000, $object_type );
 }
+
+/**
+ * Retrieves the full URL for a sitemap.
+ *
+ * @since 5.5.1
+ *
+ * @param string $name         The sitemap name.
+ * @param string $subtype_name The sitemap subtype name.  Default empty string.
+ * @param int    $page         The page of the sitemap.  Default 1.
+ * @return string|false The sitemap URL or false if the sitemap doesn't exist.
+ */
+function get_sitemap_url( $name, $subtype_name = '', $page = 1 ) {
+    $sitemaps = wp_sitemaps_get_server();
+    if ( ! $sitemaps ) {
+        return false;
+    }
+
+    if ( 'index' === $name ) {
+        return $sitemaps->index->get_index_url();
+    }
+
+    $provider = $sitemaps->registry->get_provider( $name );
+    if ( ! $provider ) {
+        return false;
+    }
+
+    if ( $subtype_name && ! in_array( $subtype_name, array_keys( $provider->get_object_subtypes() ), true ) ) {
+        return false;
+    }
+
+    $page = absint( $page );
+    if ( 0 >= $page ) {
+        $page = 1;
+    }
+    return $provider->get_sitemap_url( $subtype_name, $page );
+}