Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/helick/gtm
Plugin for Google Tag Manager integration
https://github.com/helick/gtm
composer wordpress wordpress-plugin
Last synced: 19 days ago
JSON representation
Plugin for Google Tag Manager integration
- Host: GitHub
- URL: https://github.com/helick/gtm
- Owner: helick
- License: mit
- Created: 2019-06-06T16:36:11.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-08-23T12:05:48.000Z (over 5 years ago)
- Last Synced: 2024-12-16T06:01:55.284Z (about 2 months ago)
- Topics: composer, wordpress, wordpress-plugin
- Language: PHP
- Homepage:
- Size: 47.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Helick Google Tag Manager
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Total Downloads][ico-downloads]][link-downloads]
[![Software License][ico-license]](LICENSE.md)
[![Quality Score][ico-code-quality]][link-code-quality]
Google Tag Manager integration.
## Requirements
Make sure all dependencies have been installed before moving on:
* [PHP](http://php.net/manual/en/install.php) >= 7.1
* [Composer](https://getcomposer.org/download/)
## Install
Install via Composer:
``` bash
$ composer require helick/gtm
```
Update your application config by declaring the following:
``` php
Config::define('GTM_CONTAINER_ID', env('GTM_CONTAINER_ID'));
```
Update your env variables by declaring the following:
``` dotenv
GTM_CONTAINER_ID=GTM-XXXX
```
## Usage
To support the fallback iframe for devices without javascript add the following code just after the opening `` tag in your theme:
``` php
```
### Data layer
Google Tag Manager offers a [data layer](https://developers.google.com/tag-manager/devguide) which allows you pass arbitrary data that can be used to modify which tags are added to your site.
This plugin adds some default information such as post, tags and categories and provides a simple filter for adding in your own custom data.
``` php
add_filter('helick_gtm_data_layer', function (array $dataLayer) {
$dataLayer['foo'] = 'bar';
return $dataLayer;
});
```
### Event tracking
To deactivate the event tracking you may declare the following:
``` php
add_filter('helick_gtm_enable_event_tracking', '__return_false');
```
By default the event listener script will look for the elements on the page with special data attributes in your markup and listen for the specified event to push to the data layer.
The data attributes are:
- `data-gtm-variable` *string* Optionally override the default data layer variable name for this event.
- `data-gtm-on` *enum* [click|submit|keyup|focus|blur] The JS event to listen for, defaults to 'click'.
- `data-gtm-event` *string* The event name.
- `data-gtm-category` *string* Optional group the event belongs to.
- `data-gtm-label` *string* Optional human readable label for the event.
- `data-gtm-value` *number* Optional numeric value associated with the event.
- `data-gtm-fields` *string* Optional extra data provided as encoded JSON.
Example:
``` html
Play video
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Evgenii Nasyrov][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/helick/gtm.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/helick/gtm.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/helick/gtm.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/helick/gtm
[link-code-quality]: https://scrutinizer-ci.com/g/helick/gtm
[link-downloads]: https://packagist.org/packages/helick/gtm
[link-author]: https://github.com/nasyrov
[link-contributors]: ../../contributors