Install the spatie/laravel-sitemap package: Install and introduce the spatie/laravel-sitemap package through Composer to support sitemap generation function; 2. Optional configuration: Publish configuration files to customize cache, tags or style settings; 3. Create routes to generate sitemap: Create routes in web.php using SitemapGenerator and return sitemap.xml; 4. Recommended use of planning tasks: Create Artisan commands and generate sitemap regularly daily through Laravel scheduler to improve performance; 5. Service static files: The route only returns the generated static sitemap.xml files to avoid duplicate generation; 6. Add dynamic URLs: Manually add dynamic content such as blog posts through Sitemap::create() and set update frequency, priority and other attributes; 7. Submit to search engines: Submit the generated sitemap.xml to Google Search Console and Bing Webmaster Tools to complete SEO optimization, ultimately implementing efficient and maintainable sitemap integration for Laravel applications.

Adding a sitemap to a Laravel application is a straightforward process, especially if you're using a package like spatie/laravel-sitemap —which is the most popular and well-maintained solution. Here's how to do it step by step.

1. Install the Spatie Sitemap Package

First, install the package via Composer:

 composer requires spatie/laravel-sitemap

This package handles generating sitemaps, managing URLs, and even support sitemap indexes for large sites.

2. Publish and Configure (Optional)

You can publish the config file to customize behavior:

 php artisan vendor:publish --provider="Spatie\Sitemap\SitemapServiceProvider"

This creates config/sitemap.php . You usually don't need to change anything unless you want to customize cache settings, tags, or styling.

3. Generate the Sitemap

Create a route in routes/web.php to generate and serve the sitemap:

 use Spatie\Sitemap\SitemapGenerator;

Route::get('/sitemap.xml', function () {
    // Generate the sitemap
    SitemapGenerator::create(config('app.url'))->writeToFile(public_path('sitemap.xml'));

    // Return the file
    return response()->file(public_path('sitemap.xml'));
});

?? Note : This regenerates the sitemap on every request. That's fine for small or infrequently changing sites, but not ideal for large or high-traffic ones.

4. Better Approach: Use a Scheduled Command (Recommended)

For production, generate the sitemap periodically using Laravel's task scheduler.

a. Create an Artisan Command

 php artisan make:command GenerateSitemap

Edit the new command in app/Console/Commands/GenerateSitemap.php :

 <?php

namespace App\Console\Commands;

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

class GenerateSitemap extends Command
{
    protected $signature = &#39;sitemap:generate&#39;;
    protected $description = &#39;Generate the sitemap&#39;;

    public function handle()
    {
        SitemapGenerator::create(config(&#39;app.url&#39;))
            -> writeToFile(public_path(&#39;sitemap.xml&#39;));

        $this->info(&#39;Sitemap generated successfully.&#39;);
    }
}

b. Schedule the Command

In app/Console/Kernel.php , add the command to the schedule:

 protected function schedule(Schedule $schedule)
{
    $schedule->command('sitemap:generate')->daily();
}

Now the sitemap will be regenerated once per day.

c. Serve the Static File

Update your route to just serve the static file without regenerating:

 Route::get('/sitemap.xml', function () {
    return response()->file(public_path('sitemap.xml'));
});

Make sure the file exists. You can manually run the command once to create it:

 php artisan sitemap:generate

5. Add Dynamic URLs (Optional)

If you have dynamic content (eg, blog posts), you can manually add them:

 use Spatie\Sitemap\Sitemap;
use App\Models\Post;

Sitemap::create()
    ->add('/home')
    ->add('/about')
    ->add('/contact')
    ->add(
        Post::where('published', true)->get()
            ->map(function (Post $post) {
                return $post->toSitemapTag();
            })
    )
    -> writeToFile(public_path('sitemap.xml'));

Make sure your model (eg, Post ) implements Spatie\Sitemap\Tags\Url or use ->add() with Url::create() :

 use Spatie\Sitemap\Tags\Url;

->add(Url::create("/blog/{$post->slug}")
    ->setLastModificationDate($post->updated_at)
    ->setChangeFrequency('weekly')
    ->setPriority(0.8))

6. Submit to Search Engines

Once your sitemap.xml is accessible (eg, https://yoursite.com/sitemap.xml ), submit it to:

• Google Search Console
• Bing Webmaster Tools

Summary

• ? Use spatie/laravel-sitemap for easy integration
• ? Generate sitemap via a scheduled command in production
• ? Serve a static XML file for performance
• ? Include dynamic content by manually adding URLs
• ? Submit to search engines

That's it. Your Laravel app now has a working, SEO-friendly sitemap.

The above is the detailed content of How to add a sitemap to a Laravel application?. For more information, please follow other related articles on the PHP Chinese website!