Laravel Sitemap

https://github.com/spatie/laravel-sitemap
Admin
Laravel Sitemap is a package that automatically generates XML sitemaps for your Laravel application...
Tokens:24,877
Snippets:214
Trust Score:10
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install package via Composer

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/installation-setup.md

Run this command to install the spatie/laravel-sitemap package. The package will automatically register itself.

```bash
composer require spatie/laravel-sitemap
```

--------------------------------

### Config file before and after upgrade

Source: https://github.com/spatie/laravel-sitemap/blob/main/UPGRADING.md

The config file has been simplified. The before example includes Guzzle options with cookies, timeouts, and redirects disabled. The after example has an empty guzzle_options array and chrome_binary_path set to null. Guzzle options are now merged with crawler defaults.

```php
// Before
use GuzzleHttp\RequestOptions;
use Spatie\Sitemap\Crawler\Profile;

return [
    'guzzle_options' => [
        RequestOptions::COOKIES => true,
        RequestOptions::CONNECT_TIMEOUT => 10,
        RequestOptions::TIMEOUT => 10,
        RequestOptions::ALLOW_REDIRECTS => false,
    ],
    'execute_javascript' => false,
    'chrome_binary_path' => '',
    'crawl_profile' => Profile::class,
];
```

```php
// After
use Spatie\Sitemap\Crawler\Profile;

return [
    'guzzle_options' => [

    ],
    'execute_javascript' => false,
    'chrome_binary_path' => null,
    'crawl_profile' => Profile::class,
];
```

--------------------------------

### Install spatie/browsershot for JavaScript execution

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/customizing-the-crawler/configuring-the-crawler.md

Composer command to install spatie/browsershot, required for executing JavaScript on pages. The package uses headless Chrome and requires separate installation.

```bash
composer require spatie/browsershot
```

--------------------------------

### Generated sitemap index XML example

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/creating-a-sitemap-index.md

Example of the generated sitemap index XML structure. It includes `<sitemap>` entries with `<loc>` and `<lastmod>` elements.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
    <sitemap>
        <loc>http://www.example.com/pages_sitemap.xml</loc>
        <lastmod>2016-01-01T00:00:00+00:00</lastmod>
    </sitemap>
    <sitemap>
        <loc>http://www.example.com/posts_sitemap.xml</loc>
        <lastmod>2015-12-31T00:00:00+00:00</lastmod>
    </sitemap>
</sitemapindex>
```

--------------------------------

### Generate a sitemap with SitemapGenerator

Source: https://github.com/spatie/laravel-sitemap/blob/main/README.md

Use SitemapGenerator::create to generate a sitemap for a given URL. The example shows the basic usage of the package's main class.

```php
SitemapGenerator::create('https://example.com')->writeToFile($path);
```

--------------------------------

### Example generated sitemap XML

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/generating-a-sitemap.md

Shows the structure of the generated sitemap, including the urlset root element and url entries with loc and lastmod tags.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9">
    <url>
        <loc>https://example.com</loc>
        <lastmod>2016-01-01T00:00:00+00:00</lastmod>
    </url>
    <url>
        <loc>https://example.com/page</loc>
        <lastmod>2016-01-01T00:00:00+00:00</lastmod>
    </url>

    ...
</urlset>
```

--------------------------------

### Add image to URL with addImage

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/adding-content-to-urls/images.md

Use the addImage method on a Url instance to attach an image URL and optional caption. The example creates a sitemap, adds a URL with an image, and writes it to a file.

```php
use Spatie\Sitemap\Sitemap;
use Spatie\Sitemap\Tags\Url;

Sitemap::create()
    ->add(
        Url::create('https://example.com')
            ->addImage('https://example.com/images/home.jpg', 'Home page image')
    )
    ->writeToFile($sitemapPath);
```

--------------------------------

### Custom crawl profile before and after upgrade

Source: https://github.com/spatie/laravel-sitemap/blob/main/UPGRADING.md

Custom crawl profiles must implement the Spatie\Crawler\CrawlProfiles\CrawlProfile interface. The shouldCrawl method now receives a string instead of UriInterface. The before example extends CrawlProfile and uses UriInterface, the after example implements CrawlProfile and uses a string.

```php
// Before
use Psr\Http\Message\UriInterface;
use Spatie\Crawler\CrawlProfiles\CrawlProfile;

class CustomCrawlProfile extends CrawlProfile
{
    public function shouldCrawl(UriInterface $url): bool
    {
        return $url->getHost() === 'example.com';
    }
}
```

```php
// After
use Spatie\Crawler\CrawlProfiles\CrawlProfile;

class CustomCrawlProfile implements CrawlProfile
{
    public function __construct(protected string $baseUrl)
    {
    }

    public function shouldCrawl(string $url): bool
    {
        return parse_url($url, PHP_URL_HOST) === 'example.com';
    }
}
```

--------------------------------

### shouldCrawl callback before and after upgrade

Source: https://github.com/spatie/laravel-sitemap/blob/main/UPGRADING.md

The shouldCrawl callback now receives a string URL instead of a UriInterface object. The before example uses Psr\Http\Message\UriInterface and the after example uses a string with parse_url.

```php
// Before
use Psr\Http\Message\UriInterface;

SitemapGenerator::create('https://example.com')
    ->shouldCrawl(function (UriInterface $url) {
        return strpos($url->getPath(), '/contact') === false;
    })
    ->writeToFile($path);
```

```php
// After
SitemapGenerator::create('https://example.com')
    ->shouldCrawl(function (string $url) {
        return ! str_contains(parse_url($url, PHP_URL_PATH) ?? '', '/contact');
    })
    ->writeToFile($path);
```

--------------------------------

### hasCrawled callback before and after upgrade

Source: https://github.com/spatie/laravel-sitemap/blob/main/UPGRADING.md

The hasCrawled callback now receives a Spatie\Crawler\CrawlResponse as its second argument instead of Psr\Http\Message\ResponseInterface. The before example uses ResponseInterface and the after example uses CrawlResponse.

```php
// Before
use Psr\Http\Message\ResponseInterface;
use Spatie\Sitemap\Tags\Url;

->hasCrawled(function (Url $url, ?ResponseInterface $response = null) {
    return $url;
})
```

```php
// After
use Spatie\Crawler\CrawlResponse;
use Spatie\Sitemap\Tags\Url;

->hasCrawled(function (Url $url, ?CrawlResponse $response = null) {
    return $url;
})
```

--------------------------------

### Combine grouping with maxTagsPerSitemap

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/grouping-urls-into-multiple-sitemaps.md

When maxTagsPerSitemap is set, groups exceeding the limit are split into numbered files (e.g., sitemap-blog_0.xml, sitemap-blog_1.xml). Each chunk is listed in the index. This example sets the limit to 20000 and writes an index.

```php
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'));
```

--------------------------------

### Group URLs by path with writeToFile closure

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/grouping-urls-into-multiple-sitemaps.md

Pass a closure to writeToFile that returns the file path for each URL based on its path. URLs starting with '/blog' go to sitemap-blog.xml, others to sitemap-pages.xml. Returning null or an empty string excludes the URL from all sitemaps.

```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'));
```

--------------------------------

### Return Sitemap and SitemapIndex from routes

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/returning-a-response.md

Both Sitemap and SitemapIndex implement Laravel's Responsable interface, so they can be returned directly from a route or controller. The example defines two routes: one for a sitemap and one for a sitemap index. The response will have the correct text/xml content type.

```php
use Spatie\Sitemap\Sitemap;
use Spatie\Sitemap\SitemapIndex;

Route::get('sitemap.xml', function () {
    return Sitemap::create()
        ->add('/page1')
        ->add('/page2');
});

Route::get('sitemap_index.xml', function () {
    return SitemapIndex::create()
        ->add('/pages_sitemap.xml')
        ->add('/posts_sitemap.xml');
});
```

--------------------------------

### Case-sensitive sorting example

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/sorting-urls.md

Shows the result of sorting URLs with mixed case. The sort() method is case-sensitive, placing uppercase letters before lowercase, resulting in the order /BANANA, /Zebra, /apple.

```php
$sitemap = Sitemap::create()
    ->add('/Zebra')
    ->add('/apple')
    ->add('/BANANA')
    ->sort();

// Results in order: /BANANA, /Zebra, /apple
```

--------------------------------

### Set max tags per sitemap with SitemapGenerator

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/splitting-large-sitemaps.md

Use `maxTagsPerSitemap(20000)` on the sitemap generator to split the sitemap into multiple files when the URL count exceeds the limit. The example writes the sitemap to `sitemap.xml` in the public path.

```php
use Spatie\Sitemap\SitemapGenerator;

SitemapGenerator::create('https://example.com')
    ->maxTagsPerSitemap(20000)
    ->writeToFile(public_path('sitemap.xml'));
```

--------------------------------

### Exclude links from sitemap with hasCrawled

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/customizing-the-crawler/filtering-urls.md

Use `hasCrawled` to filter out crawled links from the sitemap. Return nothing for URLs you want to exclude, otherwise return the URL object. In this example, URLs whose first segment is 'contact' are omitted.

```php
use Spatie\Sitemap\SitemapGenerator;
use Spatie\Sitemap\Tags\Url;

SitemapGenerator::create('https://example.com')
    ->hasCrawled(function (Url $url) {
        if ($url->segment(1) === 'contact') {
            return;
        }

        return $url;
    })
    ->writeToFile($sitemapPath);
```

--------------------------------

### Prevent crawling pages with shouldCrawl

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/customizing-the-crawler/filtering-urls.md

Use `shouldCrawl` to prevent the underlying crawler from crawling certain pages. The callable receives the URL string and should return a boolean. This example excludes the contact page from crawling, so links on it won't be added to the sitemap unless they appear on a crawlable page.

```php
use Spatie\Sitemap\SitemapGenerator;

SitemapGenerator::create('https://example.com')
    ->shouldCrawl(function (string $url) {
        // All pages will be crawled, except the contact page.
        // Links present on the contact page won't be added to the
        // sitemap unless they are present on a crawlable page.

        return ! str_contains(parse_url($url, PHP_URL_PATH) ?? '', '/contact');
    })
    ->writeToFile($sitemapPath);
```

--------------------------------

### Create a sitemap manually with Sitemap::create()

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/manually-creating-a-sitemap.md

Creates a sitemap by hand, adding URLs with optional last modification dates, and writes it to a file. Uses Carbon for the date and Url::create() for advanced options.

```php
use Carbon\Carbon;
use Spatie\Sitemap\Sitemap;
use Spatie\Sitemap\Tags\Url;

Sitemap::create()
    ->add('/page1')
    ->add('/page2')
    ->add(Url::create('/page3')->setLastModificationDate(Carbon::create('2016', '1', '1')))
    ->writeToFile($sitemapPath);
```

--------------------------------

### Create a sitemap index with SitemapIndex::create()

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/creating-a-sitemap-index.md

Creates a sitemap index by adding sitemap URLs and writing to a file. The `writeToFile` method requires a path variable `$sitemapIndexPath`.

```php
use Spatie\Sitemap\SitemapIndex;

SitemapIndex::create()
    ->add('/pages_sitemap.xml')
    ->add('/posts_sitemap.xml')
    ->writeToFile($sitemapIndexPath);
```

--------------------------------

### Write sitemap index to disk

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/advanced-usage/writing-to-disks.md

Create a sitemap index with SitemapIndex, add sitemap URLs, and write it to a disk using writeToDisk.

```php
use Spatie\Sitemap\SitemapIndex;

SitemapIndex::create()
    ->add('/pages_sitemap.xml')
    ->add('/posts_sitemap.xml')
    ->writeToDisk('public', 'sitemap.xml');
```

--------------------------------

### Add video with required attributes

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/adding-content-to-urls/videos.md

Creates a sitemap and adds a URL with video metadata using the required parameters: thumbnail, title, description, source, and player URL. The sitemap is written to a file.

```php
use Spatie\Sitemap\Sitemap;
use Spatie\Sitemap\Tags\Url;

Sitemap::create()
    ->add(
        Url::create('https://example.com')
            ->addVideo(
                'https://example.com/images/thumbnail.jpg',
                'Video title',
                'Video Description',
                'https://example.com/videos/source.mp4',
                'https://example.com/video/123',
            )
    )
    ->writeToFile($sitemapPath);
```

--------------------------------

### Add video with optional parameters

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/adding-content-to-urls/videos.md

Adds video metadata with optional parameters: family_friendly, live, platform, restriction, and tags. Uses the Video class constants for option values.

```php
use Spatie\Sitemap\Sitemap;
use Spatie\Sitemap\Tags\Url;
use Spatie\Sitemap\Tags\Video;

$options = ['family_friendly' => Video::OPTION_YES, 'live' => Video::OPTION_NO];
$allowOptions = ['platform' => Video::OPTION_PLATFORM_MOBILE];
$denyOptions = ['restriction' => 'CA'];
$tags = ['cooking', 'recipes'];

Sitemap::create()
    ->add(
        Url::create('https://example.com')
            ->addVideo(
                'https://example.com/images/thumbnail.jpg',
                'Video title',
                'Video Description',
                'https://example.com/videos/source.mp4',
                'https://example.com/video/123',
                $options,
                $allowOptions,
                $denyOptions,
                $tags,
            )
    )
    ->writeToFile($sitemapPath);
```

--------------------------------

### Write sitemap to disk

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/advanced-usage/writing-to-disks.md

Use SitemapGenerator to create a sitemap and write it to a disk. The writeToDisk method takes the disk name and the filename as parameters.

```php
use Spatie\Sitemap\SitemapGenerator;

SitemapGenerator::create('https://example.com')
    ->getSitemap()
    ->writeToDisk('public', 'sitemap.xml');
```

--------------------------------

### Chain sort() with writeToFile()

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/sorting-urls.md

Demonstrates method chaining: sort() returns the sitemap instance, allowing you to chain other methods like writeToFile() to save the sorted sitemap to a file.

```php
$sitemap = Sitemap::create()
    ->add('/page1')
    ->add('/page3')
    ->add('/page2')
    ->sort()
    ->writeToFile(public_path('sitemap.xml'));
```

--------------------------------

### Run tests with composer test

Source: https://github.com/spatie/laravel-sitemap/blob/main/README.md

Use this command to run the package's test suite. It is the standard testing command for this project.

```bash
composer test
```

--------------------------------

### Implement Sitemapable interface with toSitemapTag returning a route string

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/adding-content-to-urls/sitemapable-models.md

Define a toSitemapTag method on a model that returns a route string. This is the minimal implementation required to make the model sitemapable.

```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);
    }
}
```

--------------------------------

### Publish config file

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/installation-setup.md

Optionally publish the config file to config/sitemap.php using this artisan command. The provider and tag are specified.

```bash
php artisan vendor:publish --provider="Spatie\Sitemap\SitemapServiceProvider" --tag=sitemap-config
```

--------------------------------

### Write sitemap index with sitemapIndexPath

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/grouping-urls-into-multiple-sitemaps.md

Adds a sitemap index file that references each written sitemap. Call sitemapIndexPath before writeToFile to generate the index. The closure groups URLs into sitemap-blog.xml and sitemap-pages.xml.

```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'));
```

--------------------------------

### Write sitemap to disk with public visibility

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/advanced-usage/writing-to-disks.md

Set the third parameter of writeToDisk to true to make the sitemap publicly visible, useful for S3 or other disks where you need public access.

```php
use Spatie\Sitemap\SitemapGenerator;

SitemapGenerator::create('https://example.com')
    ->getSitemap()
    ->writeToDisk('public', 'sitemap.xml', true);
```

--------------------------------

### Split crawl into multiple sitemaps with writeToFile closure

Source: https://github.com/spatie/laravel-sitemap/blob/main/README.md

Pass a closure to writeToFile that receives each Url and returns the file path for that URL. URLs whose closure returns null are excluded from every sitemap. By default no sitemap index is written.

```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'));
```

--------------------------------

### Crawl domain and write sitemap to file

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/generating-a-sitemap.md

Crawls the given domain and writes the sitemap to the specified path. The destination is set by the $path variable.

```php
use Spatie\Sitemap\SitemapGenerator;

SitemapGenerator::create('https://example.com')->writeToFile($path);
```

--------------------------------

### Sort URLs alphabetically with sort()

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/sorting-urls.md

Creates a sitemap with several URLs and calls sort() to arrange them in alphabetical order. The sort is case-sensitive, with uppercase letters before lowercase.

```php
use Spatie\Sitemap\Sitemap;

$sitemap = Sitemap::create()
    ->add('/zoo')
    ->add('/blog')
    ->add('/about')
    ->add('/contact')
    ->sort();
```

--------------------------------

### Add Google News tags with optional access and genres

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/adding-content-to-urls/news.md

Adds Google News tags with optional parameters 'access' and 'genres' by passing an options array as the fifth argument to addNews. Uses the News class constants for the access and genres values.

```php
use Carbon\Carbon;
use Spatie\Sitemap\Sitemap;
use Spatie\Sitemap\Tags\News;
use Spatie\Sitemap\Tags\Url;

$options = [
    'access' => News::OPTION_ACCESS_SUB,
    'genres' => implode(', ', [News::OPTION_GENRES_BLOG, News::OPTION_GENRES_OPINION]),
];

Sitemap::create()
    ->add(
        Url::create('https://example.com/news-article')
            ->addNews('Publication Name', 'en', 'Article title', Carbon::now(), $options)
    )
    ->writeToFile($sitemapPath);
```

--------------------------------

### Default config file

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/installation-setup.md

The default configuration file copied to config/sitemap.php. It includes Guzzle options, JavaScript execution settings, Chrome binary path, and crawl profile.

```php
use Spatie\Sitemap\Crawler\Profile;

return [
    /*
     * These options will be passed to GuzzleHttp\Client when it is created.
     * They are merged with the crawler's defaults (cookies enabled,
     * connect timeout 10s, request timeout 10s, redirects followed).
     *
     * For in-depth information on all options see the Guzzle docs:
     *
     * http://docs.guzzlephp.org/en/stable/request-options.html
     */
    'guzzle_options' => [

    ],

    /*
     * The sitemap generator can execute JavaScript on each page so it will
     * discover links that are generated by your JS scripts. This feature
     * is powered by headless Chrome.
     *
     * You'll need to install spatie/browsershot to use this feature:
     *
     * composer require spatie/browsershot
     */
    'execute_javascript' => false,

    /*
     * The package will make an educated guess as to where Google Chrome is installed.
     * You can also manually pass its location here.
     */
    'chrome_binary_path' => null,

    /*
     * The sitemap generator uses a CrawlProfile implementation to determine
     * which urls should be crawled for the sitemap.
     */
    'crawl_profile' => Profile::class,
];
```

--------------------------------

### Schedule the sitemap:generate command daily

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/advanced-usage/scheduled-generation.md

Schedules the 'sitemap:generate' command to run daily using Laravel's Schedule facade in routes/console.php.

```php
use Illuminate\Support\Facades\Schedule;

Schedule::command('sitemap:generate')->daily();
```

--------------------------------

### Artisan command to generate sitemap

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/advanced-usage/scheduled-generation.md

Defines an artisan command 'sitemap:generate' that uses SitemapGenerator to create a sitemap and write it to public/sitemap.xml. The command is intended to be scheduled.

```php
namespace App\Console\Commands;

use Illuminate\Console\Command;
use Spatie\Sitemap\SitemapGenerator;

class GenerateSitemap extends Command
{
    protected $signature = 'sitemap:generate';

    protected $description = 'Generate the sitemap.';

    public function handle(): void
    {
        SitemapGenerator::create(config('app.url'))
            ->writeToFile(public_path('sitemap.xml'));
    }
}
```

--------------------------------

### Implement CustomCrawlProfile with shouldCrawl()

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/customizing-the-crawler/crawl-profiles.md

Define a custom crawl profile by implementing the CrawlProfile interface. The shouldCrawl() method returns true only for URLs on the localhost host with a path of '/'. Register this class in config/sitemap.php.

```php
use Spatie\Crawler\CrawlProfiles\CrawlProfile;

class CustomCrawlProfile implements CrawlProfile
{
    public function __construct(protected string $baseUrl)
    {
    }

    public function shouldCrawl(string $url): bool
    {
        if (parse_url($url, PHP_URL_HOST) !== 'localhost') {
            return false;
        }

        return parse_url($url, PHP_URL_PATH) === '/';
    }
}
```

--------------------------------

### Register CustomCrawlProfile in config/sitemap.php

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/customizing-the-crawler/crawl-profiles.md

Set the 'crawl_profile' configuration key to the custom crawl profile class so the sitemap generator uses it.

```php
return [
    /*
     * The sitemap generator uses a CrawlProfile implementation to determine
     * which urls should be crawled for the sitemap.
     */
    'crawl_profile' => CustomCrawlProfile::class,
];
```

--------------------------------

### Set max tags per sitemap when building manually

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/splitting-large-sitemaps.md

When building a sitemap manually, `maxTagsPerSitemap(20000)` causes `writeToFile` and `writeToDisk` to create chunk files (`sitemap_0.xml`, `sitemap_1.xml`, ...) and a sitemap index as the main file when the URL limit is exceeded. If within the limit, a single sitemap file is written as normal.

```php
use Spatie\Sitemap\Sitemap;

Sitemap::create()
    ->maxTagsPerSitemap(20000)
    ->add(/* ... */)
    ->writeToFile(public_path('sitemap.xml'));
```

--------------------------------

### Manually add links to crawled sitemap

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/generating-a-sitemap.md

Adds extra URLs to the sitemap generated by crawling, then writes the result to a file. Uses Url::create to define each additional link.

```php
use Spatie\Sitemap\SitemapGenerator;
use Spatie\Sitemap\Tags\Url;

SitemapGenerator::create('https://example.com')
    ->getSitemap()
    ->add(Url::create('/extra-page'))
    ->add(Url::create('/another-extra-page'))
    ->writeToFile($sitemapPath);
```

--------------------------------

### Check and retrieve a URL from the sitemap

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/manually-creating-a-sitemap.md

Checks if a specific URL exists in the sitemap and retrieves it. hasUrl() returns a boolean, getUrl() returns a Url object or null.

```php
$sitemap->hasUrl('/page2'); // returns true or false
$sitemap->getUrl('/page2'); // returns a Url object or null
```

--------------------------------

### Add a single model or a collection to the sitemap

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/adding-content-to-urls/sitemapable-models.md

Use the Sitemap facade to add a single model instance or an entire collection of models to the sitemap. This avoids crawling pages.

```php
use Spatie\Sitemap\Sitemap;

Sitemap::create()
    ->add($post)
    ->add(Post::all());
```

--------------------------------

### Control crawl depth with depth method

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/customizing-the-crawler/configuring-the-crawler.md

Limits how deep the crawler follows links by setting depth to 3 within the configureCrawler callback.

```php
use Spatie\Crawler\Crawler;
use Spatie\Sitemap\SitemapGenerator;

SitemapGenerator::create('https://example.com')
    ->configureCrawler(function (Crawler $crawler) {
        $crawler->depth(3);
    })
    ->writeToFile($path);
```

--------------------------------

### Return a Url object with setLastModificationDate for more control

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/adding-content-to-urls/sitemapable-models.md

Return a Url object from toSitemapTag to set additional properties like the last modification date. This gives more control over the sitemap entry.

```php
use Carbon\Carbon;
use Spatie\Sitemap\Contracts\Sitemapable;
use Spatie\Sitemap\Tags\Url;

class Post extends Model implements Sitemapable
{
    public function toSitemapTag(): Url | string | array
    {
        return Url::create(route('blog.post.show', $this))
            ->setLastModificationDate(Carbon::create($this->updated_at));
    }
}
```

--------------------------------

### Url::addVideo

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/adding-content-to-urls/videos.md

Adds video metadata to a URL in a sitemap. The method accepts required video attributes and optional parameters for additional video options.

```APIDOC
## Url::addVideo

### Description
Adds video metadata to a URL in a sitemap. The method accepts required video attributes and optional parameters for additional video options.

### Method
addVideo

### Signature
```php
Url::addVideo(
    string $thumbnailLoc,
    string $title,
    string $description,
    string $contentLoc,
    string $playerLoc,
    array $options = [],
    array $allowOptions = [],
    array $denyOptions = [],
    array $tags = []
)
```

### Parameters
- **thumbnailLoc** (string) - Required - The URL of the video thumbnail image.
- **title** (string) - Required - The title of the video.
- **description** (string) - Required - A description of the video.
- **contentLoc** (string) - Required - The URL of the video content (e.g., MP4 file).
- **playerLoc** (string) - Required - The URL of the video player page.
- **options** (array) - Optional - An associative array of video options, e.g., `['family_friendly' => Video::OPTION_YES, 'live' => Video::OPTION_NO]`.
- **allowOptions** (array) - Optional - An associative array of allow options, e.g., `['platform' => Video::OPTION_PLATFORM_MOBILE]`.
- **denyOptions** (array) - Optional - An associative array of deny options, e.g., `['restriction' => 'CA']`.
- **tags** (array) - Optional - An array of tags for the video, e.g., `['cooking', 'recipes']`.

### Example
```php
use Spatie\Sitemap\Sitemap;
use Spatie\Sitemap\Tags\Url;

Sitemap::create()
    ->add(
        Url::create('https://example.com')
            ->addVideo(
                'https://example.com/images/thumbnail.jpg',
                'Video title',
                'Video Description',
                'https://example.com/videos/source.mp4',
                'https://example.com/video/123',
            )
    )
    ->writeToFile($sitemapPath);
```

### Example with Optional Parameters
```php
use Spatie\Sitemap\Sitemap;
use Spatie\Sitemap\Tags\Url;
use Spatie\Sitemap\Tags\Video;

$options = ['family_friendly' => Video::OPTION_YES, 'live' => Video::OPTION_NO];
$allowOptions = ['platform' => Video::OPTION_PLATFORM_MOBILE];
$denyOptions = ['restriction' => 'CA'];
$tags = ['cooking', 'recipes'];

Sitemap::create()
    ->add(
        Url::create('https://example.com')
            ->addVideo(
                'https://example.com/images/thumbnail.jpg',
                'Video title',
                'Video Description',
                'https://example.com/videos/source.mp4',
                'https://example.com/video/123',
                $options,
                $allowOptions,
                $denyOptions,
                $tags,
            )
    )
    ->writeToFile($sitemapPath);
```
```

--------------------------------

### Sitemap::sort()

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/sorting-urls.md

Sorts the URLs in the sitemap alphabetically. The sort is case-sensitive, with uppercase letters sorted before lowercase letters. Returns the sitemap instance for method chaining.

```APIDOC
## Sitemap::sort()

### Description
Sorts the URLs in the sitemap alphabetically. The sort is case-sensitive, with uppercase letters sorted before lowercase letters. Returns the sitemap instance for method chaining.

### Method
sort()

### Parameters
None

### Return Value
Returns the sitemap instance, allowing method chaining.

### Example
```php
use Spatie\Sitemap\Sitemap;

$sitemap = Sitemap::create()
    ->add('/zoo')
    ->add('/blog')
    ->add('/about')
    ->add('/contact')
    ->sort();
```

### Case Sensitivity Example
```php
$sitemap = Sitemap::create()
    ->add('/Zebra')
    ->add('/apple')
    ->add('/BANANA')
    ->sort();

// Results in order: /BANANA, /Zebra, /apple
```

### Method Chaining Example
```php
$sitemap = Sitemap::create()
    ->add('/page1')
    ->add('/page3')
    ->add('/page2')
    ->sort()
    ->writeToFile(public_path('sitemap.xml'));
```
```

--------------------------------

### Ignore robots checks with configureCrawler

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/customizing-the-crawler/configuring-the-crawler.md

Configures the crawler to ignore robots.txt checks by calling ignoreRobots() on the Crawler instance within the configureCrawler callback.

```php
use Spatie\Crawler\Crawler;
use Spatie\Sitemap\SitemapGenerator;

SitemapGenerator::create('https://example.com')
    ->configureCrawler(function (Crawler $crawler) {
        $crawler->ignoreRobots();
    })
    ->writeToFile($sitemapPath);
```

--------------------------------

### Add alternates with addAlternate

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/adding-content-to-urls/alternates.md

Adds alternate language versions of a page to a sitemap using the addAlternate method, which takes the alternate URL and its locale. Use this for multilingual sites where each language version should be listed as an alternate.

```php
use Spatie\Sitemap\SitemapGenerator;
use Spatie\Sitemap\Tags\Url;

SitemapGenerator::create('https://example.com')
    ->getSitemap()
    ->add(
        Url::create('/extra-page')
            ->addAlternate('/extra-pagina', 'nl')
            ->addAlternate('/page-supplementaire', 'fr')
    )
    ->writeToFile($sitemapPath);
```

--------------------------------

### Set lastModificationDate on a sitemap in the index

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/creating-a-sitemap-index.md

Creates a sitemap index and manually sets the `lastModificationDate` property for a sitemap using a `Spatie\Sitemap\Tags\Sitemap` object. The `setLastModificationDate` method accepts a Carbon date, here `Carbon::yesterday()`.

```php
use Carbon\Carbon;
use Spatie\Sitemap\SitemapIndex;
use Spatie\Sitemap\Tags\Sitemap;

SitemapIndex::create()
    ->add('/pages_sitemap.xml')
    ->add(Sitemap::create('/posts_sitemap.xml')
        ->setLastModificationDate(Carbon::yesterday()))
    ->writeToFile($sitemapIndexPath);
```

--------------------------------

### Add Google News tags to a URL

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/adding-content-to-urls/news.md

Adds a Google News entry to a sitemap URL using the addNews method with the required parameters: publication name, language, title, and publication date. The sitemap is then written to a file.

```php
use Carbon\Carbon;
use Spatie\Sitemap\Sitemap;
use Spatie\Sitemap\Tags\Url;

Sitemap::create()
    ->add(
        Url::create('https://example.com/news-article')
            ->addNews('Publication Name', 'en', 'Article title', Carbon::now())
    )
    ->writeToFile($sitemapPath);
```

--------------------------------

### Set crawl concurrency with setConcurrency

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/customizing-the-crawler/configuring-the-crawler.md

Sets the number of concurrent connections the crawler uses to 1. The default concurrency is 10.

```php
use Spatie\Sitemap\SitemapGenerator;

SitemapGenerator::create('https://example.com')
    ->setConcurrency(1)
    ->writeToFile($sitemapPath);
```

--------------------------------

### Check and retrieve a sitemap from the index

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/creating-a-sitemap-index.md

Checks if the sitemap index contains a specific sitemap and retrieves it. `hasSitemap` returns a boolean, `getSitemap` returns a `Sitemap` tag object or `null`.

```php
$sitemapIndex->hasSitemap('/pages_sitemap.xml'); // returns true or false
$sitemapIndex->getSitemap('/pages_sitemap.xml'); // returns a Sitemap tag object or null
```

--------------------------------

### addAlternate

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/adding-content-to-urls/alternates.md

Adds an alternate URL with its locale to a Url tag for multilingual sitemaps.

```APIDOC
## addAlternate

### Description
Adds an alternate URL with its locale to a Url tag for multilingual sitemaps.

### Method
addAlternate

### Signature
`Url::addAlternate(string $url, string $locale)`

### Parameters
- **url** (string) - Required - The alternate URL.
- **locale** (string) - Required - The locale code for the alternate URL.

### Example
```php
use Spatie\Sitemap\SitemapGenerator;
use Spatie\Sitemap\Tags\Url;

SitemapGenerator::create('https://example.com')
    ->getSitemap()
    ->add(
        Url::create('/extra-page')
            ->addAlternate('/extra-pagina', 'nl')
            ->addAlternate('/page-supplementaire', 'fr')
    )
    ->writeToFile($sitemapPath);
```
```

--------------------------------

### Set XSL stylesheet on Sitemap and SitemapIndex

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/creating-sitemaps/adding-an-xsl-stylesheet.md

Call `setStylesheet` on a `Sitemap` or `SitemapIndex` to add an XSL stylesheet processing instruction. The stylesheet path is passed as a string. When using `maxTagsPerSitemap` on a `Sitemap` with a stylesheet set, the stylesheet is propagated to both the generated index and all chunk sitemaps.

```php
use Spatie\Sitemap\Sitemap;
use Spatie\Sitemap\SitemapIndex;

Sitemap::create()
    ->setStylesheet('/sitemap.xsl')
    ->add('/page1')
    ->writeToFile($sitemapPath);

SitemapIndex::create()
    ->setStylesheet('/sitemap-index.xsl')
    ->add('/pages_sitemap.xml')
    ->writeToFile($sitemapIndexPath);
```

--------------------------------

### Limit crawl count with setMaximumCrawlCount

Source: https://github.com/spatie/laravel-sitemap/blob/main/docs/customizing-the-crawler/configuring-the-crawler.md

Limits the number of pages crawled to 500 using setMaximumCrawlCount.

```php
use Spatie\Sitemap\SitemapGenerator;

SitemapGenerator::create('https://example.com')
    ->setMaximumCrawlCount(500)
    ->writeToFile($sitemapPath);
```
Tokens:
Raw