Parse, build and manipulate URL's

1.3.3 2020-08-31 10:28 UTC

This package is auto-updated.

Last update: 2020-08-31 10:28:58 UTC


Latest Version on Packagist Software License Build Status StyleCI Total Downloads

A simple package to deal with URL's in your applications.

Retrieve parts of the URL:

use Spatie\Url\Url;

$url = Url::fromString('');

echo $url->getScheme(); // 'https'
echo $url->getHost(); // ''
echo $url->getPath(); // '/opensource'

Transform any part of the URL (the Url class is immutable):

$url = Url::fromString('');

echo $url->withHost('')->withPath('spatie');
// ''

Retrieve and transform query parameters:

$url = Url::fromString('');

echo $url->getQuery(); // 'utm_source=github&utm_campaign=packages'
echo $url->getQueryParameter('utm_source'); // 'github'
echo $url->withoutQueryParameter('utm_campaign'); // ''

Retrieve path segments:

$url = Url::fromString('');

echo $url->getSegment(1); // 'opensource'
echo $url->getSegment(2); // 'laravel'

Implements PSR-7's UriInterface interface:

class Url implements UriInterface { /* ... */ }

The league/uri is a more powerful package than this one. The main reason this package exists, is because the alternatives requires non-standard php extensions. If you're dealing with special character encodings or need bulletproof validation, you're definitely better off using league/uri.

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

Support us

Learn how to create a package like this one, by watching our premium video course:

Laravel Package training

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.


You can install the package via composer:

composer require spatie/url


Usage is pretty straightforward. Check out the code examples at the top of this readme.


Please see CHANGELOG for more information what has changed recently.


composer test


Please see CONTRIBUTING for details.


If you discover any security related issues, please email instead of using the issue tracker.


You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.

We publish all received postcards on our company website.



The MIT License (MIT). Please see License File for more information.