=== GTM4WP - A Google Tag Manager (GTM) plugin for WordPress === Contributors: duracelltomi Donate link: https://gtm4wp.com/ Tags: google tag manager, tag manager, gtm, google ads, google analytics Requires at least: 6.3 Requires PHP: 8.0 Tested up to: 7.1 Stable tag: 2.1.1 License: GPLv3 License URI: http://www.gnu.org/licenses/gpl.html Advanced tag management for WordPress with Google Tag Manager == Description == Google Tag Manager (GTM) is Google's free tool for everyone to manage and deploy analytics and marketing tags as well as other code snippets using an intuitive web UI. To learn more about this tool, visit the [official website](https://marketingplatform.google.com/about/tag-manager/). This plugin places the GTM container code snippets onto your WordPress website so that you do not need to add them manually. Multiple containers are also supported, and each container can have its own environment parameters, custom domain and custom path. The plugin complements your GTM setup by pushing page meta data and user information into the so-called data layer. Google's official help pages include [more details about the data layer](https://developers.google.com/tag-platform/tag-manager/datalayer#datalayer). **PHP 8.0 and WordPress 6.3 are required to use this plugin.** = GTM container code placement = The original GTM container code is divided into two parts: The first part is a javascript code snippet that is added to the `` section of every page of the website. This part is critical to enable all features of GTM, and this plugin helps to place this part correctly on your site. The second part is an iframe snippet that acts as a failsafe/fallback should users' JavaScript be disabled. Google recommends – for best performance – to place this code snippet directly after the opening `` tag on each page. Albeit not ideal, it will work when placed lower in the code. This plugin provides a code placement option for the second code snippet. If your WordPress theme is compatible with the additions of WordPress 5.2, then this plugin will place this second snippet in the right place. Users of the Genesis theme, GeneratePress theme, Elementor, Oxygen Builder and Beaver Builder Theme will also have it placed correctly. To utilize this, set the compatibility mode in the plugin options to off. All other users can place this second code snippet using custom PHP code (the "Manually coded" option), or select the so-called "Footer" option to add the code lower on the page (this is not the recommended way, but it will work). = Basic data included = * post/page titles * post/page dates * post/page category slugs * post/page tag slugs * post/page author ID and name * post/page ID * post types * post format * post count on the current page + in the current category/tag/taxonomy * custom terms associated with any post type * logged in status * logged in user role * logged in user ID (to track cross device behavior in Google Analytics) * logged in user email address (both unhashed and SHA256 hashed values to be used with tracking) * logged in user creation date * site search data * site name and id (for WordPress multisite instances) * IP address of the visitor (please obtain the visitor's explicit consent before using this) * post author data from PublishPress Authors, including co-authors and guest authors = Content & engagement data = Optional page variables that help with behavior tracking and Google Analytics 4 content grouping: * content word count and estimated reading time * last modified date and content age in days * comment count and comment status * page template, featured image presence, page hierarchy and sticky flag * primary category, detected from Yoast SEO or Rank Math * page language, detected from WPML or Polylang * optionally, titles, categories and terms in the default language of a WPML or Polylang site, so reports combine across translations = Browser / OS / Device data = * browser data (name, version, engine) * OS data (name, version) * device data (type, manufacturer, model) Data is collected in the browser using User-Agent Client Hints and pushed as a gtm4wp.deviceData event. Note that Safari and Firefox expose less detail than Chromium based browsers. = Media player events = Track users' interactions with any embedded media: * YouTube * Vimeo * Soundcloud * HTML5 audio and video * Dailymotion * Mixcloud * Cloudflare Stream * Wistia * JW Player * VideoPress * Spotify * Twitch You can choose to fire data layer events when the media player loads, when the media is played, when it is paused or stopped, and optionally when the user reaches 10, 20, 30, ..., 90, 100% of the media duration. Each event also populates Google Tag Manager's built-in Video variables (Video Status, Video URL, Video Title, Video Provider, Video Duration, Video Current Time, Video Percent, Video Visible). Tracking is supported for embedded media using the built-in oEmbed feature of WordPress, as well as most other media plugins and copy/pasted embed codes. Players inserted into the page after it has loaded (for example in a popup, a lightbox or via AJAX) can also be tracked by turning on the optional "Track dynamically inserted players" setting. = Tag restrictions: allowlist & blocklist Tag Manager tags, triggers and variables = To increase website security, you have the option to allowlist or blocklist tags, triggers and variables. You can prevent specific tags from firing, or prevent the use of certain variable types, regardless of your GTM setup. If the Google account associated with your GTM account is compromised, an attacker could easily execute malware on your website without accessing its code on your hosting server. By blocklisting custom HTML tags, custom JavaScript variables and sandboxed scripts (custom tag and variable templates), you can secure the Tag Manager container. = Integration = Google Tag Manager for WordPress integrates with several popular plugins. More integrations to come! * Contact Form 7: fire an event when a form is submitted with any result (mail sent, mail failed, spam detected, invalid input, submission aborted or terms not accepted). Optionally push the Google Analytics 4 recommended form events (form_start, form_submit, generate_lead) as well * WooCommerce: * Implementation of [GA4 E-commerce](https://developers.google.com/tag-manager/ecommerce-ga4) * Support for the Cart, Checkout, Mini-Cart, Product Collection and cross-sell blocks, not only the classic shortcode based pages * Enhanced Conversions user data on the purchase event for Google Ads * Compatibility with High Performance Order Storage (HPOS) * Refunds reported from the server through the Google Data Manager API (see below) * Does not support promotions, since WooCommerce does not have such a feature (yet) * Easy Digital Downloads (EDD 3.0+, beta): the same GA4 e-commerce events from view_item to purchase for the classic shortcodes and the EDD blocks, with Enhanced Conversions user data and reliable purchase tracking * CheckoutWC: optional support for its multi step checkout template * PublishPress Authors: co-author and guest author data in the page variables * WPML and Polylang: page language detection, plus optional default-language values for page variables, WooCommerce and EDD items and Contact Form 7 form names * AMP: load your AMP container on the AMP version of your pages * Google Consent Mode v2: fire the "default" command with specific consent flags to integrate with non-certified Consent Management Platforms (CMPs) and plugins * Cookiebot: use automatic cookie blocking mode if needed * Axeptio: load the Axeptio SDK and push every consent change into the data layer * CookieYes: push a data layer event whenever the visitor's consent changes = Server side containers = If you are using a [server side container](https://developers.google.com/tag-manager/serverside/send-data#update_the_gtmjs_source_domain), you can enter your custom domain name and custom path to load gtm.js from there. Both can be set per container, so you can mix server side and standard containers on the same site. = Cache-safe data layer = (experimental, off by default) On sites using a full page cache (LiteSpeed, WP Rocket, Varnish, Cloudflare APO), the HTML generated for one visitor is served to everyone else as well. Any visitor specific value written into the data layer would therefore leak to other visitors - the classic example being a page cached while an editor was logged in, then served to anonymous visitors with that editor's email address and role still in the data layer. When this option is enabled, the visitor-specific data layer variables (IP address, logged-in user, store customer and cart) are left out of cacheable HTML and delivered in the browser instead, under the same names, so your existing Google Tag Manager setup keeps working. An anonymous page keeps the fixed logged-out values of visitorLoginState and visitorType. = Export & import your settings = You can export all plugin settings into a JSON file and import them on another site, which makes it easy to roll out the same configuration across several websites. Imported files are treated as untrusted and every value is validated before it is stored. = Server-side events with the Google Data Manager API = (experimental, off by default) Some signals never reach a browser tag. A refund is issued in the store admin, where no page is loaded and no tag fires, so Google Analytics keeps counting revenue you have given back. The plugin can send such events from the server through the Google Data Manager API: * Google service accounts: upload the JSON key of a Google Cloud service account, several side by side. Keys are stored encrypted and never shown again. * Data Manager destinations: one row per GA4 property, each with a Test button that validates the setup before anything is sent. * Attribution capture: each new WooCommerce or EDD order stores the Analytics client and session IDs, the Google Ads click IDs and the consent state it was placed with, so a later server-side event is matched to the right session. * Refund events: a refund issued in WooCommerce or EDD is sent to every destination as a GA4 refund event with amount, items, shipping and tax. Google Analytics itself currently processes only the first of several refunds on one order; this is reported to Google. * Consent requirement: choose whether orders from the EEA, the UK and Switzerland, every order, or no order need analytics consent before anything is sent. * Recent sends: what was sent, what Google did with it, and the reason for every deliberate skip. Failed refunds can be queued again. = Site Health = Tools → Site Health reports the whole plugin: every module's option states, the containers and their placement, the data layer name and any wp-config.php overrides in the Info section, plus status tests for the configuration, the Google service account keys and Data Manager sending. The copied text carries no keys, addresses or visitor data, so it can be pasted into a support thread as it is. = AI assistants (WordPress Abilities API) = (experimental) On WordPress 6.9 and newer the plugin registers eleven abilities with the WordPress Abilities API, so an AI assistant connected through the WordPress MCP Adapter or another client can read the configuration, help work out why an event is not firing, and change a setting once you have confirmed it. Six abilities are read-only, every one requires the settings capability, and none returns keys or visitor data. Two filters switch the surface off or keep it read-only. = Exclude specific user roles from being tracked = You can set which user roles need to be excluded from tracking when a user with that role visits the frontend. This will completely disable the container code for that user. = Staging and development sites = The container can be limited to production environments only, so a cloned or staging copy of your site does not send data into your production Google Tag Manager container. This relies on the WP_ENVIRONMENT_TYPE setting of WordPress. = For developers = Version 2.0 is a complete object oriented rewrite. Every feature is a module, and third party plugins can register their own modules through the gtm4wp_register_modules action. All public template functions, filter and action names, wp-config constants and the option storage key of the 1.x versions are unchanged, so existing integrations keep working. A third party module can report into Site Health and register its own abilities through the same interfaces the built-in modules use. == Installation == 1. Upload `duracelltomi-google-tag-manager-for-wordpress` to the `/wp-content/plugins/` directory 1. Activate the plugin through the 'Plugins' menu in WordPress 1. Go to Settings / Google Tag Manager and enter your Google Tag Manager container ID and set additional options == Frequently Asked Questions == = How can I ... = Tutorials for various Google Tag Manager settings and implementation are available on the plugin's website: https://gtm4wp.com/setup-gtm4wp-features = PayPal / 3rd party payment gateway transactions in WooCommerce are not being tracked in Google Analytics = PayPal and some other 3rd party payment gateways do not redirect users back to your website after a successful transaction by default. They offer a route back for your customer, but it can happen that users close the browser before arriving at your thank you page (also known as the order received page). This means that neither Google Analytics tags nor any other tags have a chance to fire. Enable auto-return in your payment gateway settings. This will instruct the gateway to show a quick info page after payment and redirect the user back to your site. This will improve the accuracy and frequency of tracked transactions. = Purchase event is not tracked with WooCommerce = This can happen if you are using a 3rd party plugin that alters the default order received page in a way that does not use WooCommerce's integration hooks. Either stop using that plugin, or ask its authors to mimic the behavior of the default order received page more closely by supporting the woocommerce is_order_received_page function and the woocommerce_thankyou action. Since version 2.0 the plugin also offers two settings that work around this without changing the 3rd party plugin: "Custom order received (thank-you) page" fires the purchase event on a bespoke confirmation page, and "Reliable purchase tracking" emits a missed purchase event on the next page the customer views in the same browser session. Both are de-duplicated, so an order is never counted twice. = Can the plugin report refunds to Google Analytics? = Yes, since 2.1, from the server: a refund is issued in the store admin where no tag can fire, so the plugin sends a GA4 refund event through the Google Data Manager API instead. It needs a Google Cloud service account with access to your GA4 property and refund sending switched on before the order was placed. Note that Google Analytics itself currently processes only the first of several refunds on one order; this has been reported to Google and needs no plugin change once fixed. = Does the plugin support Easy Digital Downloads? = Yes, since 2.1: Easy Digital Downloads 3.0 and newer gets the same GA4 e-commerce events as WooCommerce, for the classic shortcodes and the EDD blocks alike, with its own settings section. = Why isn't there an option to blocklist tag/variable classes = Although Google recommends blocklisting tags and variables using classes, people struggle to know which tags and variables get affected. Therefore I opted for individual tags and variables rather than classes on the tag restriction tabs. Regarding variables: ensure they are not part of any critical tags, as blocklisting such variables will render those tags useless. = How can I track scroll events in Google Tag Manager? = Google Tag Manager supports basic scroll depth tracking based on percentage or pixels natively. Add a Scroll Depth trigger in your container and use it to fire your Google Analytics 4 and/or Google Ads remarketing/conversion tags. (The plugin's own scroll tracking feature was removed in 2.0 in favor of this built-in GTM functionality.) = I use a page cache. Can visitor data leak between visitors? = Yes, this is a real risk with any full page cache, and it is not specific to this plugin: the HTML generated for one visitor is stored and served to everyone else. If visitor specific values (email address, user role, IP address) are written into the data layer, the cached copy will contain the values of whoever happened to trigger the caching. Turn on the "Cache-safe data layer" option to avoid this. With it enabled, the visitor-specific data layer variables are left out of cacheable HTML and delivered in the browser instead, under the same names. = Why does the plugin load several separate JavaScript files instead of one? = Each tracking feature (WooCommerce, each media player, Contact Form 7, device data, etc.) is its own small JavaScript file, and the plugin loads only the files a page actually needs - the YouTube tracker, for instance, loads only on pages that embed a YouTube video, and with the "defer" strategy so it never blocks rendering. Those files are already minified by the plugin's build. Merging several files into one is intentionally left to a caching / performance plugin (WP Rocket, Autoptimize, LiteSpeed Cache, etc.), which can combine scripts across your whole site and in a way that suits your hosting and HTTP setup. On modern HTTP/2 hosting, many small conditionally-loaded files usually perform as well as one combined file. (1.x combined its own scripts; 2.0 delegates this.) == Screenshots == 1. Admin panel 2. Basic settings 3. Events 4. Integration panel 5. Advanced settings == Changelog == The full changelog of every version is on gtm4wp.com: https://gtm4wp.com/changelog = 2.1.1 = * Fixed: some sites received an incomplete 2.1.0 package and stopped with a fatal error naming `EasyDigitalDownloadsModule`. 2.1.1 is the same code as a complete package. A site already showing the error needs the plugin folder removed and the plugin installed again. = 2.1.0 = * Changed: for developers, `ContainerCode::header_top()` always prints its block; the never-used argument that made it return the block instead is gone. * Changed: the container loader requests `gtm.js` over `https://` instead of the protocol-relative `//` form the plugin has emitted since 1.x, matching the snippet Google publishes today. Only a site still served over plain http sees a difference; the `