Skip to content

Sitemaps: Support provider names containing dashes, digits, and underscores. - #15958

Open
TremiDkhar wants to merge 1 commit into
WordPress:trunkfrom
TremiDkhar:fix/51280-sitemap-dash-provider
Open

TremiDkhar wants to merge 1 commit into
WordPress:trunkfrom
TremiDkhar:fix/51280-sitemap-dash-provider

Conversation

@TremiDkhar

Copy link
Copy Markdown

Sitemap providers registered with a name containing a dash, such as wp_register_sitemap_provider( 'custom-plugin', $provider ), are listed in the sitemap index, but their URL shows the home page instead of the sitemap.

The rewrite rules only match [a-z] for the provider name, so wp-sitemap-custom-plugin-1.xml is parsed as provider custom with object subtype plugin. Names with digits or underscores don't match at all.

This PR:

  • Widens the provider part of the sitemap rewrite rules to [a-z\d_-].
  • In WP_Sitemaps::render_sitemaps(), when the parsed provider and subtype don't match a registered provider, matches the full route against the registered provider names.

Core sitemaps (posts, taxonomies, users) are parsed as before.

Testing Instructions

  1. Add this mu-plugin and flush permalinks:

    <?php
    add_filter( 'wp_sitemaps_enabled', '__return_true' );
    add_action( 'init', static function () {
     $provider = new class() extends WP_Sitemaps_Provider {
      public function __construct() {
       $this->name        = 'custom-plugin';
       $this->object_type = 'custom';
      }
      public function get_url_list( $page_num, $object_subtype = '' ) {
       return array( array( 'loc' => home_url( '/custom-url/' ) ) );
      }
      public function get_max_num_pages( $object_subtype = '' ) {
       return 1;
      }
     };
     wp_register_sitemap_provider( 'custom-plugin', $provider );
    } );
  2. Open /wp-sitemap.xml and click the wp-sitemap-custom-plugin-1.xml link.

  3. Before the patch: the theme's 404 page is shown. After the patch: the sitemap lists /custom-url/.

  4. Check that /wp-sitemap-posts-post-1.xml still works.

Unit tests can be added once the approach is agreed on.

Trac ticket: https://core.trac.wordpress.org/ticket/51280

Use of AI Tools

AI assistance: Yes
Tool(s): Claude Code
Model(s): Claude Opus 5.5
Used for: Investigating the bug, drafting the fix and this description; the final change was reviewed and edited by me.


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@github-actions

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs.

Core Committers: Use this line as a base for the props when committing in SVN:

Props tremidkhar.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.


Props Bot commands

You can trigger Props Bot actions by commenting on this PR:

  • @propsbot add <username> to give props to a GitHub or WordPress.org user. Requires write access.
  • @propsbot remove <username> to leave a user out of the props. Requires write access.
  • @propsbot refresh to refresh this list. Adding the props-bot label works too.

@github-actions

Copy link
Copy Markdown

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant