Grouping URLs into multiple sitemaps | laravel-sitemap | Spatie SPATIE Laravel Sitemap ================== spatie.be/open-source [Docs](https://spatie.be/docs) [Laravel-sitemap](https://spatie.be/docs/laravel-sitemap/v8) Creating-sitemaps Grouping URLs into multiple sitemaps Version v8 Other versions for crawler [v8](https://spatie.be/docs/laravel-sitemap/v8) Grouping URLs into multiple sitemaps - [ Introduction ](https://spatie.be/docs/laravel-sitemap/v8/introduction) - [ Installation & setup ](https://spatie.be/docs/laravel-sitemap/v8/installation-setup) - [ Support us ](https://spatie.be/docs/laravel-sitemap/v8/support-us) - [ Changelog ](https://spatie.be/docs/laravel-sitemap/v8/changelog) - [ Questions and issues ](https://spatie.be/docs/laravel-sitemap/v8/questions-issues) - [ About us ](https://spatie.be/docs/laravel-sitemap/v8/about-us) Creating sitemaps ----------------- - [ Generating a sitemap ](https://spatie.be/docs/laravel-sitemap/v8/creating-sitemaps/generating-a-sitemap) - [ Manually creating a sitemap ](https://spatie.be/docs/laravel-sitemap/v8/creating-sitemaps/manually-creating-a-sitemap) - [ Creating a sitemap index ](https://spatie.be/docs/laravel-sitemap/v8/creating-sitemaps/creating-a-sitemap-index) - [ Splitting large sitemaps ](https://spatie.be/docs/laravel-sitemap/v8/creating-sitemaps/splitting-large-sitemaps) - [ Grouping URLs into multiple sitemaps ](https://spatie.be/docs/laravel-sitemap/v8/creating-sitemaps/grouping-urls-into-multiple-sitemaps) - [ Adding an XSL stylesheet ](https://spatie.be/docs/laravel-sitemap/v8/creating-sitemaps/adding-an-xsl-stylesheet) - [ Returning a response ](https://spatie.be/docs/laravel-sitemap/v8/creating-sitemaps/returning-a-response) - [ Sorting URLs ](https://spatie.be/docs/laravel-sitemap/v8/creating-sitemaps/sorting-urls) Customizing the crawler ----------------------- - [ Crawl profiles ](https://spatie.be/docs/laravel-sitemap/v8/customizing-the-crawler/crawl-profiles) - [ Filtering URLs ](https://spatie.be/docs/laravel-sitemap/v8/customizing-the-crawler/filtering-urls) - [ Configuring the crawler ](https://spatie.be/docs/laravel-sitemap/v8/customizing-the-crawler/configuring-the-crawler) Adding content to URLs ---------------------- - [ Alternates ](https://spatie.be/docs/laravel-sitemap/v8/adding-content-to-urls/alternates) - [ Images ](https://spatie.be/docs/laravel-sitemap/v8/adding-content-to-urls/images) - [ Videos ](https://spatie.be/docs/laravel-sitemap/v8/adding-content-to-urls/videos) - [ News ](https://spatie.be/docs/laravel-sitemap/v8/adding-content-to-urls/news) - [ Sitemapable models ](https://spatie.be/docs/laravel-sitemap/v8/adding-content-to-urls/sitemapable-models) Advanced usage -------------- - [ Scheduled generation ](https://spatie.be/docs/laravel-sitemap/v8/advanced-usage/scheduled-generation) - [ Writing to disks ](https://spatie.be/docs/laravel-sitemap/v8/advanced-usage/writing-to-disks) Grouping URLs into multiple sitemaps ==================================== ### On this page 1. [ Writing a sitemap index ](#content-writing-a-sitemap-index) 2. [ Combining with a maximum number of tags ](#content-combining-with-a-maximum-number-of-tags) Splitting large sitemaps divides URLs across files purely by count. Sometimes you instead want to group URLs by meaning, for example one sitemap for your blog and another for the rest of the site. Grouping like this makes it easier to track indexing coverage per section in Google Search Console. Pass a closure to `writeToFile`. It receives each `Url` and returns the path of the file that URL belongs in. Every distinct path becomes its own sitemap file. ``` use Spatie\Sitemap\SitemapGenerator; use Spatie\Sitemap\Tags\Url; SitemapGenerator::create('https://example.com') ->writeToFile(fn (Url $url) => str_starts_with($url->path(), '/blog') ? public_path('sitemap-blog.xml') : public_path('sitemap-pages.xml')); ``` Returning `null` (or an empty string) from the closure leaves that URL out of every sitemap, so the closure doubles as a filter. Writing a sitemap index ----------------------------------------------------------------------------------------------------------------------------- By default no sitemap index is written. Call `sitemapIndexPath` to also generate an index that references each written sitemap. ``` SitemapGenerator::create('https://example.com') ->sitemapIndexPath(public_path('sitemap.xml')) ->writeToFile(fn (Url $url) => str_starts_with($url->path(), '/blog') ? public_path('sitemap-blog.xml') : public_path('sitemap-pages.xml')); ``` Combining with a maximum number of tags ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- When you combine grouping with `maxTagsPerSitemap`, a group that exceeds the limit is split further into numbered files (`sitemap-blog_0.xml`, `sitemap-blog_1.xml`, ...). Each of those chunks is listed in the index. ``` SitemapGenerator::create('https://example.com') ->maxTagsPerSitemap(20000) ->sitemapIndexPath(public_path('sitemap.xml')) ->writeToFile(fn (Url $url) => str_starts_with($url->path(), '/blog') ? public_path('sitemap-blog.xml') : public_path('sitemap-pages.xml')); ``` A good match? ------------- ### What we do best - All things Laravel - Custom frontend components - Building APIs - AI-powered features - Simplifying things - Clean solutions - Integrating services ### Not our cup of tea - WordPress themes - Cutting corners - Free mockups to win a job - "Just execute the briefing" In short: we'd like to be a **substantial part** of your project. [ Get in touch via email ](mailto:info@spatie.be?subject=A%20good%20match%21&body=Tell%20us%20as%20much%20as%20you%20can%20about%0A-%20your%20online%20project%0A-%20your%20planning%0A-%20your%20budget%0A-%20%E2%80%A6%0A%0AAnything%20that%20helps%20us%20to%20start%20straightforward%21)