PHPackages spatie/laravel-referer - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. spatie/laravel-referer ActiveLibrary[Utility & Helpers](/categories/utility) spatie/laravel-referer ====================== Keep a visitor's original referer in session 1.9.3(2mo ago)532797.4k↑10.7%376MITPHPPHP ^7.4|^8.0CI passing Since Feb 2Pushed 2mo ago5 watchersCompare [ Source](https://github.com/spatie/laravel-referer)[ Packagist](https://packagist.org/packages/spatie/laravel-referer)[ Docs](https://github.com/spatie/laravel-referer)[ Fund](https://spatie.be/open-source/support-us)[ GitHub Sponsors](https://github.com/spatie)[ RSS](/packages/spatie-laravel-referer/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (5)Versions (28)Used By (6) Remember a visitor's original referer ===================================== [](#remember-a-visitors-original-referer) [![Latest Version on Packagist](https://camo.githubusercontent.com/eec6b362fa9c9edd7e22feab75fd9e84cae47ef6da583566e3b6f48fe37da484/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7370617469652f6c61726176656c2d726566657265722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/spatie/laravel-referer)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![run-tests](https://github.com/spatie/laravel-referer/actions/workflows/run-tests.yml/badge.svg)](https://github.com/spatie/laravel-referer/actions/workflows/run-tests.yml)[![Total Downloads](https://camo.githubusercontent.com/41c9efcd2703b98b75165f4f6bbef8a63015ae341fdc9123aefc98d0d6b5e5ed/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7370617469652f6c61726176656c2d726566657265722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/spatie/laravel-referer) Remember a visitor's original referer in session. The referer is (highest priority first): - The `utm_source` query parameter - The domain from the request's `Referer` header if there's an external host in the URL - Empty Support us ---------- [](#support-us) [![](https://camo.githubusercontent.com/67c9591e9f469da6e8227276f2aa67d38af74c06427620e3638b44902f75a932/68747470733a2f2f6769746875622d6164732e73332e65752d63656e7472616c2d312e616d617a6f6e6177732e636f6d2f6c61726176656c2d726566657265722e6a70673f743d31)](https://spatie.be/github-ad-click/laravel-referer) We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us). 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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards). Installation ------------ [](#installation) You can install the package via composer: ``` composer require spatie/laravel-referer ``` The package will automatically register itself in Laravel 5.5. In Laravel 5.4. you'll manually need to register the `Spatie\Referer\RefererServiceProvider` service provider in `config/app.php`. You can publish the config file with: ``` php artisan vendor:publish --provider="Spatie\Referer\RefererServiceProvider" ``` Publishing the config file is necessary if you want to change the key in which the referer is stored in the session or if you want to disable a referer source. ``` return [ /* * The key that will be used to remember the referer in the session. */ 'session_key' => 'referer', /* * The sources used to determine the referer. */ 'sources' => [ Spatie\Referer\Sources\UtmSource::class, Spatie\Referer\Sources\RequestHeader::class, ], ]; ``` Usage ----- [](#usage) To capture the referer, all you need to do is add the `Spatie\Referer\CaptureReferer` middleware to your middleware stack. In most configuration's, you'll only want to capture the referer in "web" requests, so it makes sense to register it in the `web` stack. Make sure it comes **after** Laravel's `StartSession` middleware! ``` // app/Http/Kernel.php protected $middlewareGroups = [ 'web' => [ // ... \Illuminate\Session\Middleware\StartSession::class, // ... \Spatie\Referer\CaptureReferer::class, // ... ], // ... ]; ``` The easiest way to retrieve the referer is by just resolving it out of the container: ``` use Spatie\Referer\Referer; $referer = app(Referer::class)->get(); // 'google.com' ``` Or you could opt to use Laravel's automatic facades: ``` use Facades\Spatie\Referer\Referer; $referer = Referer::get(); // 'google.com' ``` The captured referer is (from high to low priority): - The `utm_source` query parameter, or: - The domain from the request's `Referer` header if there's an external host in the URL, or: - Empty An empty referer will never overwrite an exisiting referer. So if a visitor comes from google.com and visits a few pages on your site, those pages won't affect the referer since local hosts are ignored. ### Forgetting or manually setting the referer [](#forgetting-or-manually-setting-the-referer) The `Referer` class provides dedicated methods to forget, or manually set the referer. ``` use Facades\Spatie\Referer\Referer; Referer::put('google.com'); Referer::get(); // 'google.com' Referer::forget(); Referer::get(); // '' ``` ### Changing the way the referer is determined [](#changing-the-way-the-referer-is-determined) The referer is determined by doing checks on various sources, which are defined in the configuration. ``` return [ // ... 'sources' => [ Spatie\Referer\Sources\UtmSource::class, Spatie\Referer\Sources\RequestHeader::class, ], ]; ``` A source implements the `Source` interface, and requires one method, `getReferer`. If a source is able to determine a referer, other sources will be ignored. In other words, the `sources` array is ordered by priority. In the next example, we'll add a source that can use a `?ref` query parameter to determine the referer. Additionally, we'll ignore `?utm_source` parameters. First, create the source implementations: ``` namespace App\Referer; use Illuminate\Http\Request; use Spatie\Referer\Source; class RefParameter implements Source { public function getReferer(Request $request): string { return $request->get('ref', ''); } } ``` Then register your source in the `sources` array. We'll also disable the `utm_source` while we're at it. ``` return [ // ... 'sources' => [ App\Referer\RefParameter::class, Spatie\Referer\Sources\RequestHeader::class, ], ]; ``` That's it! Source implementations can be this simple, or more advanced if necessary. Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. Testing ------- [](#testing) ``` composer test ``` Contributing ------------ [](#contributing) Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details. Security -------- [](#security) If you've found a bug regarding security please mail instead of using the issue tracker. Credits ------- [](#credits) - [Sebastian De Deyne](https://github.com/sebastiandedeyne) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 67 — FairBetter than 100% of packages Maintenance83 Actively maintained with recent releases Popularity59 Moderate usage in the ecosystem Community33 Small or concentrated contributor base Maturity78 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~132 days Recently: every ~281 days Total 26 Last Release 86d ago Major Versions 0.2.0 → 1.0.02017-02-06 PHP version history (4 changes)0.1.0PHP ^7.0 1.4.0PHP ^7.2 1.7.1PHP ^7.2|^8.0 1.8.0PHP ^7.4|^8.0 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/7535935?v=4)[Spatie](/maintainers/spatie)[@spatie](https://github.com/spatie) --- Top Contributors [![freekmurze](https://avatars.githubusercontent.com/u/483853?v=4)](https://github.com/freekmurze "freekmurze (65 commits)")[![sebastiandedeyne](https://avatars.githubusercontent.com/u/1561079?v=4)](https://github.com/sebastiandedeyne "sebastiandedeyne (29 commits)")[![AlexVanderbist](https://avatars.githubusercontent.com/u/6287961?v=4)](https://github.com/AlexVanderbist "AlexVanderbist (9 commits)")[![AdrianMrn](https://avatars.githubusercontent.com/u/12762044?v=4)](https://github.com/AdrianMrn "AdrianMrn (8 commits)")[![patinthehat](https://avatars.githubusercontent.com/u/5508707?v=4)](https://github.com/patinthehat "patinthehat (8 commits)")[![laravel-shift](https://avatars.githubusercontent.com/u/15991828?v=4)](https://github.com/laravel-shift "laravel-shift (8 commits)")[![Bouhnosaure](https://avatars.githubusercontent.com/u/3416579?v=4)](https://github.com/Bouhnosaure "Bouhnosaure (4 commits)")[![riasvdv](https://avatars.githubusercontent.com/u/3626559?v=4)](https://github.com/riasvdv "riasvdv (3 commits)")[![brendt](https://avatars.githubusercontent.com/u/6905297?v=4)](https://github.com/brendt "brendt (3 commits)")[![akoepcke](https://avatars.githubusercontent.com/u/5311185?v=4)](https://github.com/akoepcke "akoepcke (2 commits)")[![vurpa](https://avatars.githubusercontent.com/u/89026549?v=4)](https://github.com/vurpa "vurpa (1 commits)")[![dakira](https://avatars.githubusercontent.com/u/576555?v=4)](https://github.com/dakira "dakira (1 commits)")[![dmyers](https://avatars.githubusercontent.com/u/207171?v=4)](https://github.com/dmyers "dmyers (1 commits)")[![LasseRafn](https://avatars.githubusercontent.com/u/2689341?v=4)](https://github.com/LasseRafn "LasseRafn (1 commits)")[![m1guelpf](https://avatars.githubusercontent.com/u/23558090?v=4)](https://github.com/m1guelpf "m1guelpf (1 commits)")[![mstrokin](https://avatars.githubusercontent.com/u/564552?v=4)](https://github.com/mstrokin "mstrokin (1 commits)")[![nesk](https://avatars.githubusercontent.com/u/817508?v=4)](https://github.com/nesk "nesk (1 commits)")[![nick322](https://avatars.githubusercontent.com/u/9151347?v=4)](https://github.com/nick322 "nick322 (1 commits)")[![richardkeep](https://avatars.githubusercontent.com/u/3874381?v=4)](https://github.com/richardkeep "richardkeep (1 commits)") --- Tags httplaravelrefererseospatielaravel-referer ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/spatie-laravel-referer/health.svg) ``` [![Health](https://phpackages.com/badges/spatie-laravel-referer/health.svg)](https://phpackages.com/packages/spatie-laravel-referer) ``` ### Alternatives [spatie/laravel-enum Laravel Enum support 3655.4M31](/packages/spatie-laravel-enum)[spatie/laravel-honeypot Preventing spam submitted through forms 1.6k6.0M60](/packages/spatie-laravel-honeypot)[psalm/plugin-laravel Psalm plugin for Laravel 3274.9M308](/packages/psalm-plugin-laravel)[spatie/laravel-feed Generate rss feeds 9743.6M28](/packages/spatie-laravel-feed)[spatie/laravel-livewire-wizard Build wizards using Livewire 4061.0M4](/packages/spatie-laravel-livewire-wizard)[spatie/laravel-pjax A pjax middleware for Laravel 5 513371.8k11](/packages/spatie-laravel-pjax) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)