You are here

Home » API reference » Ubercart 8.4 » uc_googleanalytics.api.php

function hook_ucga_trans_alter in Ubercart 8.4

Same name and namespace in other branches
  1. 6.2 docs/hooks.php \hook_ucga_trans_alter()
  2. 7.3 uc_googleanalytics/uc_googleanalytics.api.php \hook_ucga_trans_alter()

Allows modules to alter the transaction data passed to Google Analytics.

The UC Google Analytics module constructs function calls that work through the Google Analytics JS API to report order information for e-commerce tracking purposes. The module builds the argument list for the transaction and uses this hook to give other modules a chance to alter what gets reported to Google Analytics.

Nothing should be returned. Hook implementations should receive the $trans array by reference and alter it directly.

Parameters

array $trans: An array of arguments being passed to Google Analytics representing the transaction, including order_id, store, total, tax, shipping, city, state, and country.

\Drupal\uc_order\OrderInterface $order: The order object being reported to Google Analytics.

1 invocation of hook_ucga_trans_alter()
uc_googleanalytics_ecommerce_js in uc_googleanalytics/uc_googleanalytics.module
Builds the e-commerce JS passed to Google Analytics for order tracking.

File

uc_googleanalytics/uc_googleanalytics.api.php, line 96
Hooks provided by the Google Analytics for Ubercart module.

Code

function hook_ucga_trans_alter(array &$trans, OrderInterface $order) {

  // Example implementation: prefix all orders with "UC-".
  $trans['order_id'] = 'UC-' . $trans['order_id'];
}