Parse, build and manipulate URLs

, _(*1)

A simple package to deal with URLs in your applications., _(*2)

Installation

You can install the package via composer:, _(*3)

composer require spatie/url

Usage

Parse and transform a URL

Retrieve any part of the URL:, _(*4)

use Spatie\Url\Url;

$url = Url::fromString('https://spatie.be/opensource');

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

Transform any part of the URL:, _(*5)

Note the Url class is immutable., _(*6)

$url = Url::fromString('https://spatie.be/opensource');

echo $url->withHost('github.com')->withPath('spatie');
// 'https://github.com/spatie'

Scheme

Transform the URL scheme., _(*7)

$url = Url::fromString('http://spatie.be/opensource');

echo $url->withScheme('https'); // 'https://spatie.be/opensource'

Use a list of allowed schemes., _(*8)

Note each scheme in the list will be sanitized, _(*9)

$url = Url::fromString('https://spatie.be/opensource');

echo $url->withAllowedSchemes(['wss'])->withScheme('wss'); // 'wss://spatie.be/opensource'

or pass the list directly to fromString as the URL's scheme will be sanitized and validated immediately:, _(*10)

$url = Url::fromString('https://spatie.be/opensource', [...SchemeValidator::VALID_SCHEMES, 'wss']);

echo $url->withScheme('wss'); // 'wss://spatie.be/opensource'

Query parameters

Retrieve and transform query parameters:, _(*11)

$url = Url::fromString('https://spatie.be/opensource?utm_source=github&utm_campaign=packages');

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

echo $url->getQueryParameter('utm_source'); // 'github'
echo $url->getQueryParameter('utm_medium'); // null
echo $url->getQueryParameter('utm_medium', 'social'); // 'social'
echo $url->getQueryParameter('utm_medium', function() {
    //some logic
    return 'email';
}); // 'email'

echo $url->withoutQueryParameter('utm_campaign'); // 'https://spatie.be/opensource?utm_source=github'
echo $url->withQueryParameters(['utm_campaign' => 'packages']); // 'https://spatie.be/opensource?utm_source=github&utm_campaign=packages'

Path segments

Retrieve path segments:, _(*12)

$url = Url::fromString('https://spatie.be/opensource/laravel');

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

PSR-7 `UriInterface`

Implements PSR-7's UriInterface interface:, _(*13)

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., _(*14)

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

Testing

composer test

Support us

, _(*16)

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., _(*17)

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., _(*18)

Changelog

Please see CHANGELOG for more information on what has changed recently., _(*19)

Contributing

Please see CONTRIBUTING for details., _(*20)

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities., _(*21)

Postcardware

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., _(*22)

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium., _(*23)

We publish all received postcards on our company website., _(*24)