Kevin Burkholder

<p><strong>{eac}Doojigger SimpleGTM</strong> is an <a href="https://eacDoojigger.earthasylum.com/" rel="nofollow ugc">{eac}Doojigger</a> extension that installs the Google Tag Manager (GTM) or Google Analytics (GA4) script, sets default consent options, and enables tracking of page views, site searches, content views, and, when using <a href="https://woocommerce.com/" rel="nofollow ugc">WooCommerce</a>, e-commerce actions.</p>
<p><em>{eac}SimpleGTM</em> is a very light-weight and simple extension that uses PHP to add small JavaScript snippets to your web pages for configuring and tracking with Google Analytics. Many web site owners will find this more than sufficient over more complicated (and over-bearing) alternatives.</p>
<h4>Default Consent (advanced)</h4>
<p>The selected consent attributes are set to ‘granted’ before other tags are loaded or actions taken. This does not make your site GDPR/CCPA compliant and should not be used in place of a Consent Management Platform (CMP). See Google’s <a href="https://support.google.com/analytics/answer/12329599" rel="nofollow ugc">Introduction to user consent</a>. This is typically not necessary and not recommended when using a CMP.</p>
<p>If no consent attributes are selected than the “consent default” configuration is not sent, otherwise, unselected attributes are set to “denied”.</p>
<p>Default consent settings passed when initializing GTM or GA4:</p>
<pre><code>ad_storage  
analytics_storage   
ad_user_data    
ad_personalization  
functionality_storage   
personalization_storage 
security_storage    
</code></pre>
<h4>Consent Options (advanced)</h4>
<ul>
<li>URL passthrough</li>
</ul>
<p>When consent attributes <code>ad_storage</code> and/or <code>analytics_storage</code> are set to <code>denied</code>, pass information about ad clicks or analytics through URL parameters.</p>
<ul>
<li>Allow Google Signals</li>
</ul>
<p>Allows session data that Google associates with users who have signed in to their Google accounts, and who have turned on Ads Personalization.</p>
<ul>
<li>Redact Ads Data</li>
</ul>
<p>When ads_data_redaction is true and <code>ad_storage</code> is <code>denied</code>, ad click identifiers sent in network requests by Google Ads and Floodlight tags will be redacted. Network requests will also be sent through a cookieless domain.</p>
<h4>Send Event Tags</h4>
<p>When to send events to the browser. <em>In Page Footer</em> sends events in the page footer as the page loads.<br />
<em>On Document Load</em> sends events as soon as the document is loaded but before the browser renders the page.<br />
<em>On Window Ready</em> waits for the page to be rendered (this may be helpful with late-loading CMP plugins).</p>
<h4>Events To Track</h4>
<p>Custom events are simple events with limited data that use Google’s recommended names and attributes</p>
<p>See Recommended events:<br />
<a href="https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client_type=gtm" rel="nofollow ugc">Tag Manager</a><br />
<a href="https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client_type=gtag" rel="nofollow ugc">Google Tag</a></p>
<ul>
<li>
<p>Page Views</p>
<ul>
<li><code>page_view {page_title, page_location, page_referrer, user_agent, page_encoding, language}</code></li>
</ul>
</li>
<li>
<p>Site Search</p>
<ul>
<li><code>search {search_term}</code></li>
</ul>
</li>
<li>
<p>View Content (category, tag, term)</p>
<ul>
<li><code>select_content {content_type, content_id}</code></li>
</ul>
</li>
<li>
<p>View Archive (archive, author, date)</p>
<ul>
<li><code>select_content {content_type, content_id}</code></li>
</ul>
</li>
<li>
<p>E-Commerce</p>
<ul>
<li><code>view_item_list {item_list_id, item_list_name}</code></li>
<li><code>view_item {currency, value, items}</code></li>
<li><code>view_cart {currency, value, items}</code></li>
<li><code>begin_checkout {currency, value, coupon, discount, items}</code></li>
<li><code>purchase {transaction_id, currency, value, coupon, discount, shipping, tax, items}</code></li>
<li><em>items = {item_id, item_name, price, discount, quantity, item_variant, item_category}</em></li>
</ul>
</li>
<li>
<p>Cart Actions</p>
<ul>
<li><code>select_promotion {promotion_id, promotion_name}</code></li>
<li><code>add_to_cart {currency, value, items}</code></li>
<li><code>remove_from_cart {currency, value, items}</code></li>
<li><code>update_cart_item {currency, value, items}</code></li>
<li><em>items = {item_id, item_name, price, discount, quantity, item_variant, item_category}</em></li>
</ul>
</li>
<li>
<p>Enhanced Conversions</p>
<ul>
<li><a href="https://support.google.com/google-ads/answer/13258081" rel="nofollow ugc">Enhanced Conversions for web</a> is a feature that can improve the accuracy of your conversion measurement. It supplements your existing conversion tags by sending hashed first-party conversion data from your website in a privacy safe way.</li>
</ul>
</li>
<li>
<p>Page Not Found</p>
<ul>
<li><code>page_not_found {request_uri}</code></li>
</ul>
</li>
</ul>
<blockquote>
<p>* Session storage is used when cart actions are triggered. This requires enabling/setting <em>{eac}Doojigger <span aria-hidden="true" class="wp-exclude-emoji">→</span> Session Extension</em>.</p>
<p>* Page Views are typically included in your tag container, other tags & triggers may need to be configured in<br />
  <a href="https://tagmanager.google.com/" rel="nofollow ugc">Google Tag Manager</a>.</p>
<p>* If enabled, <a href="https://wordpress.org/plugins/wp-consent-api/" rel="ugc">WP Consent API</a> may block events (when ‘statistics-anonymous’ consent is denied) and Enhanced Conversions (when ‘statistics’ consent is denied).</p>
</blockquote>
<h4>Actions and Filters</h4>
<ul>
<li>
<p>eacDoojigger_google_tag_event   – Action to add a custom event.</p>
<ul>
<li><code>do_action( 'eacDoojigger_google_tag_event( 'event_name', [...event parameters...] ) );</code></li>
</ul>
</li>
<li>
<p>eacDoojigger_google_tag_data    – Action to add data to the Google tag data layer.</p>
<ul>
<li><code>do_action( 'eacDoojigger_google_tag_data( 'data_name', [...data array...] ) );</code></li>
</ul>
</li>
<li>
<p>eacDoojigger_google_ecommerce_event – Action to add an ecommerce event.</p>
<ul>
<li><code>do_action( 'eacDoojigger_google_ecommerce_event( 'event_name', [...event parameters...] ) );</code></li>
</ul>
</li>
<li>
<p>eacDoojigger_google_tag_consent – Filter the consent array.</p>
<ul>
<li><code>add_filter( 'eacDoojigger_google_tag_consent', function($consent) {...} );</code></li>
<li><code>$consent</code> is an array of <code>[ $option => 'granted|denied' ]</code></li>
</ul>
</li>
<li>
<p>eacDoojigger_google_tag_configuration – Filter the configuration array.</p>
<ul>
<li><code>add_filter( 'eacDoojigger_google_tag_configuration', function($config) {...} );</code></li>
<li><code>$config</code> is an array of <code>[ $option => bool|null ]</code></li>
</ul>
</li>
<li>
<p>eacDoojigger_google_tag_events  – Filter the events array prior to output.</p>
<ul>
<li><code>add_filter( 'eacDoojigger_google_tag_events', function($events) {...} );</code></li>
<li><code>$events</code> is an array of <code>[ $event => [$attributes] ]</code></li>
<li><code>$event</code> is an array <code>[type,event_name]</code> where type is ‘set’, ‘data’, ‘gtm’, ‘gtag’, or ‘ecommerce’.</li>
</ul>
</li>
</ul>
<h4>3rd Party Service</h4>
<p>By loading the Google Tag Manager (GTM) or Google Analytics (GA4) script, {eac}SimpleGTM causes data collected from your website <em>and from your users</em> to be transmitted to Google.</p>
<ul>
<li><a href="https://support.google.com/analytics/answer/12159447?hl=en" rel="nofollow ugc">How Google Analytics works</a></li>
<li><a href="https://support.google.com/tagmanager/answer/6102821?hl=en" rel="nofollow ugc">Introduction to Google Tag Manager</a></li>
</ul>
<p><em>You are responsible for the proper configuration of your Google Analytics property and/or Google Tag Manager settings as well as proper notification and consent from your users.</em></p>
<ul>
<li><a href="https://support.google.com/analytics/answer/12329599" rel="nofollow ugc">Introduction to user consent</a></li>
</ul>
<h4>Privacy Disclosures Policy</h4>
<p>When you use Google Analytics on your site or application, you must disclose the use of Google Analytics and how it collects and processes data.</p>
<ul>
<li><a href="https://www.google.com/policies/privacy/partners/" rel="nofollow ugc">Google’s Privacy & Terms</a></li>
<li><a href="https://support.google.com/analytics/answer/6004245" rel="nofollow ugc">Safeguarding your data</a></li>
</ul>
<h4>Additional Information</h4>
<ul>
<li>
<p>{eac}SimpleGTM is an extension plugin to and requires installation and registration of <a href="https://eacDoojigger.earthasylum.com/" rel="nofollow ugc">{eac}Doojigger</a>.</p>
</li>
<li>
<p>Visit the <a href="https://github.com/EarthAsylum" rel="nofollow ugc">EarthAsylum GitHub Repository</a> or the <a href="https://eacdoojigger.earthasylum.com/" rel="nofollow ugc">{eac}Doojigger Web Site</a> for all plugins, extensions, and documentation.</p>
</li>
</ul>
<h3>Copyright</h3>
<h4>Copyright © 2025, EarthAsylum Consulting, distributed under the terms of the GNU GPL.</h4>
<p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should receive a copy of the GNU General Public License along with this program. If not, see <a href="https://www.gnu.org/licenses/" rel="nofollow ugc">https://www.gnu.org/licenses/</a>.</p>


{eac}Doojigger Simple GTM Extension for WordPress

{eac}eacSimpleGTM installs and configures the Google Tag Manager (GTM) or Google Analytics (GA4) script with optional tracking events.

<p><em>{eac}Readme</em> is an <a href="https://eacDoojigger.earthasylum.com/" rel="nofollow ugc">{eac}Doojigger</a> extension which loads and translates a WordPress markdown ‘readme’ file providing shortcodes and embedding URLs to access header lines and section blocks.</p>
<h4>Shortcode Usage</h4>
<p>The first used shortcode must indicate the file to load…</p>
<pre><code>[eacReadme file='/docfolder/readme.txt']        # file is relative to the WordPress document root folder
[eacReadme content='/contentfolder/readme.txt'] # content file is relative to the WordPress content folder (wp-content/)
[eacReadme plugin='/pluginfolder/readme.txt']   # plugin file is relative to the WordPress plugins folder (wp-content/plugins/)
[eacReadme theme='/themefolder/readme.txt']     # theme file is relative to the WordPress themes folder (wp-content/themes/)
[eacReadme wpsvn='/slugname/trunk/readme.txt']  # load file from WordPress SVN repository
[eacReadme github='/owner/repository/main/readme.txt']      # load file from a github repository
</code></pre>
<p>After which, headers and sections may be pulled from that file…</p>
<pre><code>[eacReadme]All Headers[/eacReadme]              # parses all header lines
[eacReadme]headerName[/eacReadme]               # gets the value of the named header line

[eacReadme]All Sections[/eacReadme]             # parses all section blocks
[eacReadme]sectionName[/eacReadme]              # parses the content of the named section block
[eacReadme]sectionName/sub-section[/eacReadme]  # parses the content of the named sub-section within section block
</code></pre>
<p>One shortcode can do it all…</p>
<pre><code>[eacReadme plugin='/pluginfolder/readme.txt']Document[/eacReadme]    # loads the file and parses the entire document
</code></pre>
<p>Or load the entire file as a single code block…</p>
<pre><code>[eacReadme theme='/themefolder/functions.php']Code File[/eacReadme]
</code></pre>
<h4>Shortcode Examples</h4>
<p>Get header values…</p>
<pre><code>[eacReadme]Contributors[/eacReadme]
[eacReadme]Donate link[/eacReadme]
[eacReadme]Requires at least[/eacReadme]
[eacReadme]Stable tag[/eacReadme]
</code></pre>
<p>Get unnamed segments…</p>
<pre><code>[eacReadme]Title[/eacReadme]                    # gets the '=== plugin name ===' line (before headers)
[eacReadme]Short Description[/eacReadme]        # gets the short description (between headers and first section block)
</code></pre>
<p>Get section blocks…</p>
<pre><code>[eacReadme]Description[/eacReadme]
[eacReadme]Installation[/eacReadme]
[eacReadme]Screenshots[/eacReadme]
[eacReadme]Changelog[/eacReadme]
</code></pre>
<p>Get multiple blocks and/or sub-sections…</p>
<pre><code>[eacReadme plugin='/eacReadme/readme.txt']Short Description,Description[/eacReadme]
[eacReadme plugin='/eacReadme/readme.txt']Short Description,Description/Shortcode Examples[/eacReadme]
</code></pre>
<p>Get a file as a code block…</p>
<pre><code>[eacReadme theme='/my-child-theme/functions.js' lang='js']Code File[/eacReadme]
[eacReadme theme='/my-child-theme/style.css' lang='css']Code File[/eacReadme]
</code></pre>
<h4>Other Options</h4>
<p>Change the default cache time-to-live by adding to wp-config.php:</p>
<pre><code>define('EAC_README_CACHE_LIFETIME',$seconds);   # default: 1-day (DAY_IN_SECONDS).
</code></pre>
<p>Override the default cache time-to-live</p>
<pre><code>[eacReadme ttl=$seconds ...]                    # minimum: 1-minute (MINUTE_IN_SECONDS).
</code></pre>
<p>Set the default GitHub access token (for private repositories):</p>
<pre><code>define('GITHUB_ACCESS_TOKEN',$token);
</code></pre>
<p>Set/override the GitHub access token</p>
<pre><code>[eacReadme token=$token ...]
</code></pre>
<p>Override option to parse markdown when retrieving a segment</p>
<pre><code>[eacReadme parse='true|false' ...]
</code></pre>
<p>Set class=’language-*’ on code blocks</p>
<pre><code>[eacReadme lang='php|js|css|html' ...]
</code></pre>
<h4>Translating Header/Section Names</h4>
<p>Translate header/section names when retrieving <em>All Headers</em>, <em>All Sections</em>, or <em>Document</em></p>
<pre><code>[eacReadme translate='name=newname,...']
[eacReadme translate='Requires at least=Requires WordPress Version,Screenshots=Screen Shots']
</code></pre>
<p>Erase default translation table</p>
<pre><code>[eacReadme translate='no|none|false']
</code></pre>
<p>Default translation table</p>
<pre><code>[
    'Headers'               => 'Document Header',
    'Plugin URI'            => 'Homepage',
    'Stable tag'            => 'Current Version',
    'Requires at least'     => 'Requires WordPress Version',
    'Tested up to'          => 'Compatible up to',
    'Requires PHP'          => 'Requires PHP Version',
    'WC requires at least'  => 'Requires WooCommerce',
    'Requires EAC'          => 'Requires {eac}Doojigger',
    'Changelog'             => 'Change Log',
    'Screenshots'           => 'Screen Shots',
];
</code></pre>
<h4>Embedding</h4>
<p>{eac}Readme can also be used to embed URLs in a WordPress Post or Page. Simply paste the url in the <code>Embed</code> URL block.</p>
<ul>
<li>Navigate to the post or page where the readme content is to be embedded.</li>
<li>Click the ‘+’ (Block Inserter) icon and search for “Embed” or type /embed.</li>
<li>Select the “Embed” block.</li>
<li>Paste the URL to the readme file into the provided field.</li>
<li>Click the “Embed” button. WordPress will automatically display the unformatted content.</li>
</ul>
<p>The shortcut to this is to simply paste the URL at the end of the page/post where it says “Type / to choose a block”. WordPress will automatically convert your URL to an embed block.</p>
<p>Files can be embedded from your site, from the WordPress repository or from Github. Embedded URLs are transformed internally to the appropriate format.</p>
<p><em>From your site</em></p>
<pre><code>https://<your_site_url>/plugins/<plugin_slug>/readme.txt
https://<your_site_url>/themes/<theme_name>/readme.txt
</code></pre>
<p><em>From the WordPress Repository</em></p>
<pre><code>https://ps.w.org/<plugin_slug>/readme.txt
https://plugins.svn.wordpress.org/<plugin_slug>/readme.txt
</code></pre>
<p><em>From a GitHub Repository</em></p>
<pre><code>https://github.com/<owner>/<repository>/blob/main/readme.md
https://github.com/<owner>/<repository>/main/readme.md
</code></pre>
<p><em>To load only specific sections of the readme file, append a fragment to the url:</em></p>
<pre><code>https://<your_site_url>/plugins/<plugin_slug>/readme.txt#allheaders
https://ps.w.org/<plugin_slug>/readme.txt#description
https://github.com/<owner>/<repository>/main/readme.md#screenshots
</code></pre>
<h4>Readme Format</h4>
<p>{eac}Readme expects a well-formed readme.txt file that follows the <a href="https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works" rel="nofollow ugc">WordPress readme file standard</a>…</p>
<h3>title</h3>
<pre><code>header: value
header: value
short Description<h3>section</h3>    = sub-section =
</code></pre>
<p>…but supports some extensions to that standard:</p>
<ul>
<li>
<p>Author & Author URI</p>
<ul>
<li><code>Author</code> header may be a simple name or a markdown link:
<ul>
<li><code>[Author](Author URI)</code>.</li>
</ul>
</li>
<li>The <code>Author</code> & <code>Author URI</code> headers, if present, are combined as a markdown <code>[Author](Author URI)</code>.</li>
</ul>
</li>
<li>
<p>Homepage</p>
<ul>
<li>Looks for <code>Homepage</code> or <code>Plugin URI</code>.</li>
</ul>
</li>
<li>
<p>Version</p>
<ul>
<li>Looks for <code>Version</code> or <code>Stable tag</code>.</li>
</ul>
</li>
<li>
<p>Contributors</p>
<ul>
<li><code>profileId</code> – wordpress profile (standard)</li>
<li><code>profileId@youremaildomain.com</code> – gravatar profile</li>
<li><code>profileId@wordpress</code> – wordpress profile</li>
<li><code>profileId@gravatar</code> – gravatar profile</li>
<li><code>profileId@github</code> – github profile</li>
<li><code>[display name](mailto:email@address.com)</code> or <code>[display name](http://www.gravatar.com/profileId/)</code></li>
<li><code>[display name](https://profiles.wordpress.org/profileId/)</code></li>
<li><code>[your name]((http://your/profile/url)</code></li>
</ul>
</li>
<li>
<p>A “banner” section may be included between the top title line and the first header line.</p>
<p><code><h3>title</h3>   [![banner](//image_url)](//link_url)<br />
header: value<br />
header: value<br />
short Description<h3>section</h3>    = sub-section =</code></p>
</li>
<li>
<p>The header block may be enclosed in an html <code><header></code> or <code><details></code> tag, opening and closing each on a single line. These tags are ignored by the eacParseReadme parser but may be beneficial if posting your readme file elseware. See <a href="https://github.com/EarthAsylum/eacReadme" rel="nofollow ugc">{eac}Readme on Github</a>.</p>
</li>
</ul>
<blockquote>
<p>Note: these extensions are not supported by the WordPress Plugin Repository.</p>
</blockquote>
<p>{eac}Readme supports standard markdown (readme.md) formatting for section identification.<br />
+   <code>=== title ===</code> and <code>## title</code> are equivalent<br />
+   <code>== section ==</code> and <code>### section</code> are equivalent<br />
+   <code>= sub-section =</code> and <code>#### sub-section</code> are equivalent</p>
<h4>Output HTML</h4>
<p>When retrieving the header block with …</p>
<pre><code>[eacReadme]All Headers[/eacReadme] or `\eacParseReadme::getAllHeaders()`
</code></pre>
<p>Or when retrieving all sections with …</p>
<pre><code>[eacReadme]All Sections[/eacReadme] or `\eacParseReadme::getAllSections()`
</code></pre>
<p>Or when retrieving the entire document with …</p>
<pre><code>[eacReadme]Document[/eacReadme] or `\eacParseReadme::getDocument()`
</code></pre>
<p>Additional html tags and classes are added, including wrapping blocks within a <code><details></code> tags, adding <code>readme-*</code> class names, and adding <code><a></code> anchor links.</p>
<h4>WordPress Actions</h4>
<p>3rd-party actors may load and use the parser class included in {eac}Readme…</p>
<pre><code>    do_action('eacReadme_load_parser');     // loads \eacParseReadme static class
    if (class_exists('\eacParseReadme'))
    {
        \eacParseReadme::loadFile($readme,$context);
        $html_document  = \eacParseReadme::getDocument();
        $title          = \eacParseReadme::getTitle();
        $version        = \eacParseReadme::getVersion();
        $donations      = \eacParseReadme::getHeader('donate_link');
        $description    = \eacParseReadme::getSection('description');
    }= Additional Information =
</code></pre>
<ul>
<li>{eac}Readme is an extension plugin to and requires installation and registration of <a href="https://eacDoojigger.earthasylum.com/" rel="nofollow ugc">{eac}Doojigger</a>.</li>
<li>{eac}Readme uses <a href="http://parsedown.org/" rel="nofollow ugc">Parsedown 1.7.4</a>, Copyright (c) 2013-2018 <a href="erusev.com" rel="nofollow ugc">Emanuil Rusev</a></li>
<li>
<p>{eac}Readme uses <a href="https://prismjs.com/" rel="nofollow ugc">Prism syntax highlighter</a>, Copyright (c) 2012 Lea Verou</p>
</li>
<li>
<p>The <a href="https://swregistry.earthasylum.com/software-taxonomy/" rel="nofollow ugc">{eac}SoftwareRegistry Software Product Taxonomy</a> plugin uses {eac}Readme to parse readme markdown files hosted on Github to provide plugin information and automated updates to WordPress for self-hosted plugins.</p>
</li>
</ul>
<h3>Copyright</h3>
<h4>Copyright © 2019-2025, EarthAsylum Consulting, distributed under the terms of the GNU GPL.</h4>
<p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should receive a copy of the GNU General Public License along with this program. If not, see <a href="https://www.gnu.org/licenses/" rel="nofollow ugc">https://www.gnu.org/licenses/</a>.</p>


{eac}Doojigger Readme Extension for WordPress

{eac}Readme loads and translates a WordPress markdown 'readme' file providing shortcodes and embedding URLs to access header lines and section blocks.

{eac}Doojigger Simple GTM Extension for WordPress vs {eac}Doojigger Readme Extension for WordPress