Contrib.social

Recommendation on implementing a partial sitemap index

Open on Drupal.org →
Created on 13 February 2025, about 2 months ago

We have a several sitemaps, and we're interested in using the "Sitemap index" feature of this module as our "default". But unfortunately some of our sitemaps are for specific purposes that we don't want exposed in the default sitemap. For example, we've got the following three sitemaps:

1. Sitemap of all published nodes
2. Sitemap of all published media
3. Sitemap of all published nodes of the "article" type

We would like to have a "sitemap index" that includes sitemaps #1 and #2 above, but not #3. The reason we would like to exclude #3 above is that it just duplicates some of what is already in sitemap #1.

What are some recommendations for how to implement this? Is there a particular hook we should implement? Or should we make a custom plugin to replace the "Sitemap index generator" sitemap generator? Or should we make a custom plugin to replace the "Sitemap URL generator" URL generator? Or something else? (All else being equal, we're looking for the way that will result in the least amount of custom code.)

💬 Support request
Status

Active

Version

4.2

Component

Code

Created by

🇺🇸United States brockfanning

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @brockfanning
  • Comment about 2 months ago →
    🇩🇪Germany gbyte Berlin

    The cleanest solution would be to programmatically create a new URL generator by overriding \Drupal\simple_sitemap\Plugin\simple_sitemap\UrlGenerator\SitemapIndexUrlGenerator and setting the new generator instead of the old one on the sitemap index or create a new sitemap index entirely. Both can be done via UI.

    The simplest solution would be to use hook_simple_sitemap_links_alter(array &$links, SimpleSitemapInterface $sitemap) to alter the links. You can use $link['meta'] information to help you filter out the unwanted sitemaps.

    Let me know if that helps.

  • Comment about 2 months ago →
    🇺🇸United States brockfanning

    Perfect, thank you!

    I was also thinking maybe of a no-code solution: We set sitemap #1 to our "default", and then we could go to /admin/config/search/simplesitemap/custom and add a custom link in our default which links to sitemap #2. Do you see any problems with that approach?

  • Comment about 2 months ago →
    🇩🇪Germany gbyte Berlin

    I haven't tried it, but there may be a problem with it as a sitemap referencing other sitemaps may have a different structure to a sitemap referencing content links. I'd say try it and see if the output fulfills your requirements.

  • Comment about 1 month ago →
    System Message

    Automatically closed - issue fixed for 2 weeks with no activity.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024