Add the possibility to add images to sitemaps (#451)

* Add the possibility to add images to sitemaps. See also https://developers.google.com/search/docs/advanced/sitemaps/image-sitemaps * And an example how to add images to urls
spatie · Jun 13, 2022 · 0da6e85 · 0da6e85
1 parent 55f33c9
commit 0da6e85
Show file tree

Hide file tree

Showing 25 changed files with 164 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -378,6 +378,20 @@ SitemapGenerator::create('https://example.com')
 
 Note the ```addAlternate``` function which takes an alternate URL and the locale it belongs to.
 
+#### Adding images to links
+
+Urls can also have images. See also https://developers.google.com/search/docs/advanced/sitemaps/image-sitemaps
+
+```php
+use Spatie\Sitemap\Sitemap;
+use Spatie\Sitemap\Tags\Url;
+
+Sitemap::create()
+    // here we add an image to a URL
+    ->add(Url::create('https://example.com')->addImage('https://example.com/images/home.jpg', 'Home page image'))
+    ->writeToFile($sitemapPath);
+```
+
 ### Manually creating a sitemap
 
 You can also create a sitemap fully manual:

diff --git a/resources/views/image.blade.php b/resources/views/image.blade.php
@@ -0,0 +1,17 @@
+<image:image>
+@if (! empty($image->url))
+    <image:loc>{{ url($image->url) }}</image:loc>
+@endif
+@if (! empty($image->caption))
+    <image:caption>{{ $image->caption }}</image:caption>
+@endif
+@if (! empty($image->geo_location))
+    <image:geo_location>{{ $image->geo_location }}</image:geo_location>
+@endif
+@if (! empty($image->title))
+    <image:title>{{ url($image->title) }}</image:title>
+@endif
+@if (! empty($image->license))
+    <image:license>{{ url($image->license) }}</image:license>
+@endif
+</image:image>
diff --git a/resources/views/sitemap.blade.php b/resources/views/sitemap.blade.php
@@ -1,5 +1,5 @@
 <?= '<'.'?'.'xml version="1.0" encoding="UTF-8"?>'."\n"; ?>
-<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml">
+<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">
 @foreach($tags as $tag)
     @include('sitemap::' . $tag->getType())
 @endforeach

diff --git a/resources/views/url.blade.php b/resources/views/url.blade.php
@@ -16,4 +16,5 @@
 @if (! empty($tag->priority))
     <priority>{{ number_format($tag->priority,1) }}</priority>
     @endif
+    @each('sitemap::image', $tag->images, 'image')
 </url>
diff --git a/src/Tags/Image.php b/src/Tags/Image.php
@@ -0,0 +1,69 @@
+<?php
+
+namespace Spatie\Sitemap\Tags;
+
+class Image
+{
+    public string $url;
+
+    public string $caption;
+
+    public string $geo_location;
+
+    public string $title;
+
+    public string $license;
+
+    public static function create(string $url, string $caption = '', string $geo_location = '', string $title = '', string $license = ''): static
+    {
+        return new static($url, $caption, $geo_location, $title, $license);
+    }
+
+    public function __construct(string $url, string $caption = '', string $geo_location = '', string $title = '', string $license = '')
+    {
+        $this->setUrl($url);
+
+        $this->setCaption($caption);
+
+        $this->setGeoLocation($geo_location);
+
+        $this->setTitle($title);
+
+        $this->setLicense($license);
+    }
+
+    public function setUrl(string $url = ''): static
+    {
+        $this->url = $url;
+
+        return $this;
+    }
+
+    public function setCaption(string $caption = ''): static
+    {
+        $this->caption = $caption;
+
+        return $this;
+    }
+
+    public function setGeoLocation(string $geo_location = ''): static
+    {
+        $this->geo_location = $geo_location;
+
+        return $this;
+    }
+
+    public function setTitle(string $title = ''): static
+    {
+        $this->title = $title;
+
+        return $this;
+    }
+
+    public function setLicense(string $license = ''): static
+    {
+        $this->license = $license;
+
+        return $this;
+    }
+}
diff --git a/src/Tags/Url.php b/src/Tags/Url.php
@@ -26,6 +26,9 @@ class Url extends Tag
     /** @var \Spatie\Sitemap\Tags\Alternate[] */
     public array $alternates = [];
 
+    /** @var \Spatie\Sitemap\Tags\Image[] */
+    public array $images = [];
+
     public static function create(string $url): static
     {
         return new static($url);
@@ -75,6 +78,13 @@ public function addAlternate(string $url, string $locale = ''): static
         return $this;
     }
 
+    public function addImage(string $url, string $caption = '', string $geo_location = '', string $title = '', string $license = ''): static
+    {
+        $this->images[] = new Image($url, $caption, $geo_location, $title, $license);
+
+        return $this;
+    }
+
     public function path(): string
     {
         return parse_url($this->url, PHP_URL_PATH) ?? '';

diff --git a/tests/ImageTest.php b/tests/ImageTest.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Spatie\Sitemap\Test;
+
+use Spatie\Sitemap\Sitemap;
+use Spatie\Sitemap\Tags\Url;
+
+class ImageTest extends TestCase
+{
+    public function testXmlHasImage()
+    {
+        $expected_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">
+                            <url>
+                                <loc>https://localhost</loc>
+                                <lastmod>2016-01-01T00:00:00+00:00</lastmod>
+                                <changefreq>daily</changefreq>
+                                <priority>0.8</priority>
+                                <image:image>
+                                    <image:loc>https://localhost/favicon.ico</image:loc>
+                                    <image:caption>Favicon</image:caption>
+                                </image:image>
+                            </url>
+                        </urlset>';
+
+        $sitemap = Sitemap::create();
+        $url = Url::create('https://localhost')->addImage('https://localhost/favicon.ico', 'Favicon');
+        $sitemap->add($url);
+
+        $render_output = $sitemap->render();
+
+        $this->assertXmlStringEqualsXmlString($expected_xml, $render_output);
+    }
+}
diff --git a/tests/__snapshots__/SitemapGeneratorTest__it_can_generate_a_sitemap__1.xml b/tests/__snapshots__/SitemapGeneratorTest__it_can_generate_a_sitemap__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost:4020/</loc>
     <lastmod>2016-01-01T00:00:00+00:00</lastmod>

diff --git a/...__/SitemapGeneratorTest__it_can_modify_the_attributes_while_generating_the_sitemap__1.xml b/...__/SitemapGeneratorTest__it_can_modify_the_attributes_while_generating_the_sitemap__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost:4020/</loc>
     <lastmod>2016-01-01T00:00:00+00:00</lastmod>

diff --git a/tests/__snapshots__/SitemapGeneratorTest__it_can_use_a_custom_profile__1.xml b/tests/__snapshots__/SitemapGeneratorTest__it_can_use_a_custom_profile__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost:4020/</loc>
     <lastmod>2016-01-01T00:00:00+00:00</lastmod>

diff --git a/...torTest__it_will_not_add_the_url_to_the_site_map_if_has_crawled_does_not_return_it__1.xml b/...torTest__it_will_not_add_the_url_to_the_site_map_if_has_crawled_does_not_return_it__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost:4020/</loc>
     <lastmod>2016-01-01T00:00:00+00:00</lastmod>

diff --git a/...ots__/SitemapGeneratorTest__it_will_not_crawl_an_url_if_should_crawl_returns_false__1.xml b/...ots__/SitemapGeneratorTest__it_will_not_crawl_an_url_if_should_crawl_returns_false__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost:4020/</loc>
     <lastmod>2016-01-01T00:00:00+00:00</lastmod>

diff --git a/tests/__snapshots__/SitemapTest__a_url_object_can_not_be_added_twice_to_the_sitemap__1.xml b/tests/__snapshots__/SitemapTest__a_url_object_can_not_be_added_twice_to_the_sitemap__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost/home</loc>
     <lastmod>2016-01-01T00:00:00+00:00</lastmod>

diff --git a/tests/__snapshots__/SitemapTest__a_url_string_can_not_be_added_twice_to_the_sitemap__1.xml b/tests/__snapshots__/SitemapTest__a_url_string_can_not_be_added_twice_to_the_sitemap__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost/home</loc>
     <lastmod>2016-01-01T00:00:00+00:00</lastmod>

diff --git a/tests/__snapshots__/SitemapTest__an_url_object_can_be_added_to_the_sitemap__1.xml b/tests/__snapshots__/SitemapTest__an_url_object_can_be_added_to_the_sitemap__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost/home</loc>
     <lastmod>2016-01-01T00:00:00+00:00</lastmod>

diff --git a/tests/__snapshots__/SitemapTest__an_url_string_can_be_added_to_the_sitemap__1.xml b/tests/__snapshots__/SitemapTest__an_url_string_can_be_added_to_the_sitemap__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost/home</loc>
     <lastmod>2016-01-01T00:00:00+00:00</lastmod>

diff --git a/tests/__snapshots__/SitemapTest__an_url_with_an_alternate_can_be_added_to_the_sitemap__1.xml b/tests/__snapshots__/SitemapTest__an_url_with_an_alternate_can_be_added_to_the_sitemap__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost/home</loc>
     <xhtml:link rel="alternate" hreflang="nl" href="http://localhost/thuis"/>

diff --git a/tests/__snapshots__/SitemapTest__it_can_render_an_empty_sitemap__1.xml b/tests/__snapshots__/SitemapTest__it_can_render_an_empty_sitemap__1.xml
@@ -1,3 +1,3 @@
 <?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">
+<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">
 </urlset>
diff --git a/tests/__snapshots__/SitemapTest__it_can_render_an_url_with_all_its_set_properties__1.xml b/tests/__snapshots__/SitemapTest__it_can_render_an_url_with_all_its_set_properties__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost/home</loc>
     <lastmod>2015-12-31T00:00:00+00:00</lastmod>

diff --git a/tests/__snapshots__/SitemapTest__it_can_write_a_sitemap_to_a_file__1.xml b/tests/__snapshots__/SitemapTest__it_can_write_a_sitemap_to_a_file__1.xml
@@ -1,3 +1,3 @@
 <?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">
+<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">
 </urlset>
diff --git a/tests/__snapshots__/SitemapTest__it_can_write_a_sitemap_to_a_storage_disk__1.xml b/tests/__snapshots__/SitemapTest__it_can_write_a_sitemap_to_a_storage_disk__1.xml
@@ -1,3 +1,3 @@
 <?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">
+<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">
 </urlset>
diff --git a/tests/__snapshots__/SitemapTest__multiple_urls_can_be_added_in_one_call__1.xml b/tests/__snapshots__/SitemapTest__multiple_urls_can_be_added_in_one_call__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost</loc>
     <lastmod>2016-01-01T00:00:00+00:00</lastmod>

diff --git a/tests/__snapshots__/SitemapTest__multiple_urls_can_be_added_to_the_sitemap__1.xml b/tests/__snapshots__/SitemapTest__multiple_urls_can_be_added_to_the_sitemap__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost/home</loc>
     <lastmod>2016-01-01T00:00:00+00:00</lastmod>

diff --git a/tests/__snapshots__/SitemapTest__sitemapable_object_can_be_added__1.xml b/tests/__snapshots__/SitemapTest__sitemapable_object_can_be_added__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost</loc>
     <lastmod>2016-01-01T00:00:00+00:00</lastmod>

diff --git a/tests/__snapshots__/SitemapTest__sitemapable_objects_can_be_added__1.xml b/tests/__snapshots__/SitemapTest__sitemapable_objects_can_be_added__1.xml
@@ -1,5 +1,5 @@
 <?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">
+<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">
   <url>
     <loc>http://localhost/blog/post-1</loc>
     <lastmod>2016-01-01T00:00:00+00:00</lastmod>