Update _source Parameter Used by Proxy Event Tracking Function Citing Site Kit as Source of ICE Events & Rename trackEvent

[10upsimon]

Feature Description

#8641 saw the introduction of a helper/proxy style function to facilitate the tracking of events against gtag's. This function is merely an abstraction against the gtag('event') API call.

However, it was incorrectly instructed that the custom event parameter name citing Site Kit as the source of the event be _source. This is an illegal parameter name as said parameter names may only be alphanumeric and contain underscores, but may not begin with an underscore.

This custom _source event parameter name should be updated to be event_source.

No updates to individual event provider scripts are needed, as they all leverage this helper function.

Further to the event parameter name change, the current trackEvent function name should be updated to be something a little further removed from the internal trackEvent function of the same name. A suitable name would be gtagEvent. This will need to be updated across all existing event provider JS scripts, as they currently call the global._googlesitekit?.trackEvent?.() function as part of individual event provider logic.

---

Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

• The currently named trackEvent function in includes/Core/Conversion_Tracking/Conversion_Tracking.php (created as wp_add_inline_script()) should be updated to be named gtagEvent.
  • All event providers making use of window._googlesitekit.trackEvent() should have their JS code updated to instead reference window._googlesitekit.gtagEvent()
• The currently named _source parameter passed to gtag() within the (now updated) gtagEvent() function at includes/Core/Conversion_Tracking/Conversion_Tracking.php (created as wp_add_inline_script()) should be updated to be named event_source
  • No event provider updates are required as a result of this change

Implementation Brief

• Update includes/Core/Conversion_Tracking/Conversion_Tracking.php
  • Find the wp_add_inline_script() call defining window._googlesitekit.trackEvent and rename trackEvent to gtagEvent
  • Update the _source gtag event parameter and rename it to event_source
• In assets/js/event-providers
  • Update all instances of event provider JS to make use of the renamed function global._googlesitekit?.gtagEvent where there is current usage of global._googlesitekit?.trackEvent

Test Coverage

• No test coverage updates are required as a result of the changes in this issue.

QA Brief

• QA For this issue involves validating that all existing supported ICE plugins continue to track their events as expected
  • Activate Site Kit with Ads and/or GA4 modules enabled
  • Enabled the conversionInfra feature flag in Site Kit Tester plugin
  • Enabled Enhanced Conversion Tracking in either Ads or GA4 settings, it is a shared state between the two modules
  • Continue to activate and test the ICE plugins for conversion events, at the time of writing these are:
    • Contact Form 7
    • Mailchimp for WordPress
    • Optin Monster
    • Popup Maker
    • WooCommerce
    • WP Forms
  • Applicable events should be tracked for each
    • Within the gtag('event') API call, the (previously named) _source event parameter should now be listed as event_source as per the screenshot below:

Changelog entry

• Update conversion event sources to be tracked as event_source instead of __source.

[aaemnnosttv]

LGTM @10upsimon. The only thing missing is the test coverage section. I don't know if we'd need updates here or not but please update with guidance as to whether or not any changes are needed.

[10upsimon]

Thanks @aaemnnosttv I've updated to indicate that no test updates are required, as we do not have coverage for the helper/proxy function.

[aaemnnosttv]

Great, thanks! IB ✅

[kelvinballoo]

QA Update ✅

• Confirming that the events for each plugin is triggered with the relevant event name and the source is 'event_source' and not '_source'.

  • Contact 7 - contact
  • WooCommerce - add_to_cart
  • WPForms - submit_lead_form
  • Mailchimp for WordPress - submit_lead_form
  • Popup Maker - submit_lead_form
  • OptinMonster - submit_lead_form

• Also tested that there is no tracking when enhance toggle is off

• Deactivated one of the modules and tracking was still good with the enhance toggle on

Moving ticket to Approval

• Contact 7 - contact
  

• WooCommerce - add_to_cart

  

• WPForms - submit_lead_form
  

• Mailchimp for WordPress - submit_lead_form
  

• Popup Maker - submit_lead_form
  

• OptinMonster - submit_lead_form