Skip to content

[6.x] Fix is_external for anchor, mailto and tel links in navs #15082

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

Open
duncanmcclean wants to merge 2 commits into
base: 6.x
Choose a base branch
from
+68 −3
Open

[6.x] Fix is_external for anchor, mailto and tel links in navs #15082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8bfb89c
fix `is_external` for anchor, mailto and tel links in navs
duncanmcclean Jul 27, 2026
0900d26
Merge remote-tracking branch 'origin/6.x' into nav-anchor-is-external
jasonvarga Jul 30, 2026
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
23 changes: 20 additions & 3 deletions src/Facades/Endpoint/URL.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,12 +206,23 @@ public function makeAbsolute(?string $url): string
return self::tidy($url);
}

// Protocol-relative URLs and other schemes (mailto:, tel:, etc) already
// point somewhere else, so prepending the site URL would mangle them.
if (Str::startsWith($url, '//') || self::hasScheme($url)) {
return $url;
}

$url = Str::ensureLeft($url, '/');
$url = Str::ensureLeft($url, self::getRequestRootUrl());

return self::tidy($url);
}

private function hasScheme(?string $url): bool
{
return (bool) preg_match('/^[a-z][a-z0-9+.\-]*:/i', (string) $url);
}

/**
* Get the current URL.
*/
Expand Down Expand Up @@ -262,15 +273,21 @@ public function isExternal(?string $url): bool
return false;
}

$url = Str::ensureRight($url, '/');
$cacheKey = $url;

if (Str::startsWith($url, '//')) {
return self::$externalSiteUrlsCache[$cacheKey] = true;
}

if (Str::startsWith($url, ['/', '?', '#'])) {
return self::$externalSiteUrlsCache[$url] = false;
return self::$externalSiteUrlsCache[$cacheKey] = false;
}

$url = Str::ensureRight(Str::before(Str::before($url, '#'), '?'), '/');

$isExternal = ! Str::startsWith($url, Str::ensureRight(Site::current()->absoluteUrl(), '/'));

return self::$externalSiteUrlsCache[$url] = $isExternal;
return self::$externalSiteUrlsCache[$cacheKey] = $isExternal;
}

/**
Expand Down
22 changes: 22 additions & 0 deletions tests/Facades/UrlTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,10 +239,20 @@ public function it_determines_external_url()
$this->assertTrue(URL::isExternal('http://external-site.com/some-slug'));
$this->assertTrue(URL::isExternal('http://external-site.com/some-slug?foo'));
$this->assertTrue(URL::isExternal('http://external-site.com/some-slug#anchor'));
$this->assertTrue(URL::isExternal('//external-site.com'));
$this->assertTrue(URL::isExternal('mailto:foo@external-site.com'));
$this->assertTrue(URL::isExternal('tel:+441234567890'));
$this->assertFalse(URL::isExternal('http://this-site.com'));
$this->assertFalse(URL::isExternal('http://this-site.com/'));
$this->assertFalse(URL::isExternal('http://this-site.com/some-slug'));
$this->assertFalse(URL::isExternal('http://this-site.com#anchor'));
$this->assertFalse(URL::isExternal('http://this-site.com/#anchor'));
$this->assertFalse(URL::isExternal('http://this-site.com?query=1'));
$this->assertFalse(URL::isExternal('http://this-site.com/some-slug#anchor'));
$this->assertFalse(URL::isExternal('/foo'));
$this->assertFalse(URL::isExternal('/#anchor'));
$this->assertFalse(URL::isExternal('/foo#anchor'));
$this->assertFalse(URL::isExternal('?query=1'));
$this->assertFalse(URL::isExternal('#anchor'));
$this->assertFalse(URL::isExternal(''));
$this->assertFalse(URL::isExternal(null));
Expand All @@ -260,7 +270,9 @@ public function it_determines_external_url_when_using_relative_in_config()
$this->assertFalse(URL::isExternal('http://absolute-url-resolved-from-request.com'));
$this->assertFalse(URL::isExternal('http://absolute-url-resolved-from-request.com/'));
$this->assertFalse(URL::isExternal('http://absolute-url-resolved-from-request.com/some-slug'));
$this->assertFalse(URL::isExternal('http://absolute-url-resolved-from-request.com#anchor'));
$this->assertFalse(URL::isExternal('/foo'));
$this->assertFalse(URL::isExternal('/#anchor'));
$this->assertFalse(URL::isExternal('#anchor'));
$this->assertFalse(URL::isExternal(''));
$this->assertFalse(URL::isExternal(null));
Expand Down Expand Up @@ -591,6 +603,16 @@ public static function absoluteProvider()
];
}

#[Test]
public function it_leaves_urls_pointing_elsewhere_alone_when_making_them_absolute()
{
$this->setSiteValue('en', 'url', 'http://this-site.com/');

$this->assertSame('mailto:foo@external-site.com', URL::makeAbsolute('mailto:foo@external-site.com'));
$this->assertSame('tel:+441234567890', URL::makeAbsolute('tel:+441234567890'));
$this->assertSame('//external-site.com', URL::makeAbsolute('//external-site.com'));
}

#[Test]
public function making_urls_absolute_ignores_front_controller_in_request_root()
{
Expand Down
26 changes: 26 additions & 0 deletions tests/Tags/StructureTagTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,32 @@ public function it_sets_is_current_and_is_parent_for_a_nav_when_home_is_an_entry
$this->assertEquals('[home][1=parent][1-1=parent][1-1-1=current][1-1-1-1][2][3]', $result);
}

#[Test]
public function it_sets_is_external_for_a_nav()
{
$this->setSiteValue('en', 'url', 'http://localhost/');

$this->makeNav([
['id' => '1', 'title' => 'Entry', 'url' => '/about'],
['id' => '2', 'title' => 'Homepage anchor', 'url' => '/#anchor'],
['id' => '3', 'title' => 'Bare anchor', 'url' => '#anchor'],
['id' => '4', 'title' => 'Page anchor', 'url' => '/about#anchor'],
['id' => '5', 'title' => 'Query string', 'url' => '/about?query=1'],
['id' => '6', 'title' => 'Own domain', 'url' => 'http://localhost/about'],
['id' => '7', 'title' => 'External', 'url' => 'https://statamic.com'],
['id' => '8', 'title' => 'Protocol relative', 'url' => '//statamic.com'],
['id' => '9', 'title' => 'Email', 'url' => 'mailto:foo@statamic.com'],
['id' => '10', 'title' => 'Phone', 'url' => 'tel:+441234567890'],
]);

$template = '{{ nav:test }}[{{ id }}{{ if is_external }}=external{{ /if }}]{{ /nav:test }}';

$this->assertEquals(
'[1][2][3][4][5][6][7=external][8=external][9=external][10=external]',
(string) Antlers::parse($template, [], true)
);
}

#[Test]
public function it_sets_is_parent_based_on_the_url_too()
{
Expand Down
Loading