https://github.com/spatie/laravel-sitemap
Create and generate sitemaps with ease
https://github.com/spatie/laravel-sitemap
google laravel php seo sitemap xml
Last synced: 17 days ago
JSON representation
Create and generate sitemaps with ease
- Host: GitHub
- URL: https://github.com/spatie/laravel-sitemap
- Owner: spatie
- License: mit
- Created: 2016-08-12T11:56:26.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2026-08-07T11:21:37.000Z (3 months ago)
- Last Synced: 2026-10-16T10:00:59.622Z (20 days ago)
- Topics: google, laravel, php, seo, sitemap, xml
- Language: PHP
- Homepage: https://spatie.be/docs/laravel-sitemap
- Size: 680 KB
- Stars: 2,619
- Watchers: 32
- Forks: 294
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Support: docs/support-us.md
Awesome Lists containing this project
- awesome-php - spatie/laravel-sitemap - Create and generate sitemaps with ease (Other / Mathematics)
README
Generate sitemaps with ease
[](https://packagist.org/packages/spatie/laravel-sitemap)
[](LICENSE.md)
[](https://github.com/spatie/laravel-sitemap/actions/workflows/run-tests.yml)
[](https://github.com/spatie/laravel-sitemap/actions/workflows/fix-php-code-style-issues.yml)
[](https://github.com/spatie/laravel-sitemap/actions/workflows/phpstan.yml)
[](https://packagist.org/packages/spatie/laravel-sitemap)
This package can generate a sitemap without you having to add URLs to it manually. This works by crawling your entire site.
```php
use Spatie\Sitemap\SitemapGenerator;
SitemapGenerator::create('https://example.com')->writeToFile($path);
```
You can also create your sitemap manually:
```php
use Carbon\Carbon;
use Spatie\Sitemap\Sitemap;
use Spatie\Sitemap\Tags\Url;
Sitemap::create()
->add(Url::create('/home')
->setLastModificationDate(Carbon::yesterday()))
->add(...)
->writeToFile($path);
```
Or you can have the best of both worlds by generating a sitemap and then adding more links to it:
```php
use Spatie\Sitemap\SitemapGenerator;
use Spatie\Sitemap\Tags\Url;
SitemapGenerator::create('https://example.com')
->getSitemap()
->add(Url::create('/extra-page')
->setLastModificationDate(Carbon::yesterday()))
->add(...)
->writeToFile($path);
```
## Splitting a crawl into multiple sitemaps
Sometimes you want the crawled URLs grouped into separate sitemap files (for example one for your blog and one for the rest of the site). 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.
```php
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` from the closure leaves that URL out of every sitemap.
By default no sitemap index is written. Call `sitemapIndexPath` to also generate an index that references each written sitemap.
```php
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'));
```
When you combine this with `maxTagsPerSitemap()`, a group that exceeds the limit is split further into numbered files (`sitemap-blog_0.xml`, `sitemap-blog_1.xml`), each listed in the index.
You can also add your models directly by implementing the `Sitemapable` interface.
```php
use Spatie\Sitemap\Contracts\Sitemapable;
use Spatie\Sitemap\Tags\Url;
class Post extends Model implements Sitemapable
{
public function toSitemapTag(): Url | string | array
{
return route('blog.post.show', $this);
}
}
```
## Support us
[
](https://spatie.be/github-ad-click/laravel-sitemap)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Documentation
All documentation is available [on our documentation site](https://spatie.be/docs/laravel-sitemap).
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security
If you've found a bug regarding security please mail [security@spatie.be](mailto:security@spatie.be) instead of using the issue tracker.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.