README

Version: 1.1.2

This package adds Google Tag Manager to WordPress sites. The goal of the project is to help remove development noise from collected stats. Tracking snippets are only injected when no users are logged in, for development tasks where WP_DEBUG set to true, a fallback UA-xxxx tracking ID will be used.

Google Tag Manager code will only be injected when is_user_logged_in() is false. We want to collect traffic from visitors, not authors or developers. For sites with lower traffic, this can make a real difference.

When is_user_logged_in() is false, tracking code will be injected with either the primary or fallback tracking ID. This package assumes that when WP_DEBUG is true, the site is in development and should use a fallback tracking ID. Otherwise, with no one logged in and WP_DEBUG unset or false, the primary tracking id will be served.

Usage

This library is available on Packagist, just require it in composer.json to add it to the project or tell Composer to load the package:

$ composer require ideasonpurpose/wp-google-analytics

Then initialize the code with a primary and fallback tracking ID:

use IdeasOnPurpose\WP\GoogleAnalytics;

new GoogleAnalytics("G-XYZ456", "G-JKL890");

For the sake of future maintenance, it's a good idea to store tracking IDs in descriptive variables:

$client_prod_id = "G-XYZ456";
$local_dev_id = "G-JKL890";
new GoogleAnalytics($client_prod_id, $local_dev_id);

Backwards compatibility with GA4 and Universal Analytics

In some situations, Google recommends injecting two snippets into the page, one for the older Universal Analytics property, and then a copy with the new GA4 property ID.

Analytics ID arguments can be a single string or an array of strings. When multiple IDs are provided, a snippet will be injected for each:

new GoogleAnalytics(["UA-012345-1", "G-XYZ456"], $local_dev_id);

Will produce something like this:

<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-012345-1"></script>
<script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());

  gtag('config', 'UA-012345-1');
</script>

<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-XYZ456"></script>
<script>
  window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());

  gtag('config', 'G-XYZ456');
</script>

ideasonpurpose / wp-google-analytics

Maintainers

Details

README

Version: 1.1.2

Usage

Backwards compatibility with GA4 and Universal Analytics