Laravel TagManager
An easier way to add Google Tag Manager to your Laravel application. Including recommended GTM events support.
Requirements
- Laravel 8.x
Laravel support
| Version | Release |
|---|---|
| 8.x | 1.0 |
Installation
1. Install package
Install the package
composer require label84/laravel-tagmanager
2. Add the head and body tag to your (layout) view
Add the head tag directly above the closing </head> tag and the body tag directly after the opening <body> tag.
<x-tagmanager-head />
</head>
<body>
<x-tagmanager-body />
3. Add the TagManagerMiddleware to your Kernel
Add the TagManagerMiddleware directly after the StartSession middleware in your 'web' middleware group.
// app/Http/Kernel.php
protected $middlewareGroups = [
'web' => [
\App\Http\Middleware\EncryptCookies::class,
...
\Illuminate\Session\Middleware\StartSession::class,
\Label84\TagManager\Http\Middleware\TagManagerMiddleware::class,
...
4. Publish the config file
Publish the config file. This will generate a tagmanager.php file in your config directory.
php artisan vendor:publish --provider="Label84\TagManager\TagManagerServiceProvider" --tag="config"
5. Add your GTM ID to your .env
// .env
GOOGLE_TAG_MANAGER_ID=
GOOGLE_TAG_MANAGER_ENABLED=true
Go to https://tagmanager.google.com and copy the 'Container ID' of the account (it looks like GTM-XXXXXXX).
Usage
// DashboardController.php (example)
use Label84\TagManager\Facades\TagManager;
TagManager::push(['foo' => 'bar']);
Events
You can also use the following methods. These will automatically set the correct event key and value.
use Label84\TagManager\Facades\TagManager;
TagManager::event('kissed', ['status' => 'failed', 'count' => 0]);
TagManager::login(['foo' => 'bar']);
TagManager::register(['foo' => 'bar']);
You can find a list of recommended events on: https://support.google.com/analytics/answer/9267735?hl=en
User-ID
This package also supports the User-ID feature.
To start using the User-ID feature you've to add the TagManagerUserIdMiddleware in your 'web' middleware group directly after the TagManagerMiddleware.
// app/Http/Kernel.php
protected $middlewareGroups = [
'web' => [
...
\Label84\TagManager\Http\Middleware\TagManagerMiddleware::class,
\Label84\TagManager\Http\Middleware\TagManagerUserIdMiddleware::class,
...
By default the 'id' of the User model will be used. You change the key in config/tagmanager.php.
You can find more information about this feature on: https://developers.google.com/analytics/devguides/collection/ga4/user-id?technology=tagmanager
Tests
./vendor/bin/phpstan analyze
450 Nov 29, 2022
32 Dec 21, 2022
396 Dec 30, 2022
6 Aug 4, 2022
86 Dec 15, 2022
1.7k Jan 5, 2023
109 Dec 26, 2022
10 Nov 28, 2022
6 Aug 25, 2022
859 Dec 11, 2022
19 Aug 29, 2022
269 Dec 21, 2022
335 Dec 4, 2022
25 Oct 12, 2022
371 Dec 17, 2022
2 Jan 25, 2022
6.1k Dec 31, 2022
1 Nov 25, 2021