Skip to content

Skip empty URL string returned from toSitemapTag() #577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
freekmurze merged 1 commit into from
Aug 25, 2025
+35 −0
Merged

Skip empty URL string returned from toSitemapTag() #577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/Sitemap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ public function add(string | Url | Sitemapable | iterable $tag): static
return $this;
}

if (is_string($tag) && trim($tag) === '') {
return $this;
}

if (is_string($tag)) {
$tag = Url::create($tag);
}
Expand Down
25 changes: 25 additions & 0 deletions tests/SitemapTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,13 @@
assertMatchesXmlSnapshot($this->sitemap->render());
});

test('an empty string cannot be added to the sitemap', function () {
$this->sitemap->add('');
$this->sitemap->add(' ');

assertMatchesXmlSnapshot($this->sitemap->render());
});

test('an url cannot be added twice to the sitemap', function () {
$this->sitemap->add('/home');
$this->sitemap->add('/home');
Expand Down Expand Up @@ -162,6 +169,24 @@
assertMatchesXmlSnapshot($this->sitemap->render());
});

test('sitemapable object with empty string cannot be added', function () {
$this->sitemap
->add(new class implements Sitemapable {
public function toSitemapTag(): Url | string | array
{
return '';
}
})
->add(new class implements Sitemapable {
public function toSitemapTag(): Url | string | array
{
return ' ';
}
});

assertMatchesXmlSnapshot($this->sitemap->render());
});

test('sitemapable object can be added', function () {
$this->sitemap
->add(new class implements Sitemapable {
Expand Down
3 changes: 3 additions & 0 deletions tests/__snapshots__/SitemapTest__an_empty_string_cannot_be_added_to_the_sitemap__1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +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" 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">
</urlset>
3 changes: 3 additions & 0 deletions tests/__snapshots__/SitemapTest__sitemapable_object_with_empty_string_cannot_be_added__1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +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" 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">
</urlset>