Skip to content

Instantly share code, notes, and snippets.

Last active April 8, 2021 16:53
Show Gist options
  • Save vovafeldman/a19a6c92838dcaa416ec7063a01dc6c9 to your computer and use it in GitHub Desktop.
Save vovafeldman/a19a6c92838dcaa416ec7063a01dc6c9 to your computer and use it in GitHub Desktop.
Freemius Purchase Completion JavaScript Callback Filter
// Add GA tracking only if user opted-in OR if compliant product.
function my_after_purchase_js( $js_function ) {
return 'function ( response ) {
* Since the user just entered their personal & billing information, agreed to the TOS & privacy,
* know they are running within a secure iframe from an external domain, they implicitly permit tracking
* this purchase. So initizlizing GA here (after the purchase), is legitimate.
ga('create', 'UA-XXXXXXX', 'auto');
console.log("checkout", "purchaseCompleted");
function my_checkout_enrich ( $html ) {
return '<script type="text/javascript">
(function() {
if ( null == ga ) {
// Add code to include GA.
</script>' . $html;
my_freemius()->add_filter('checkout/purchaseCompleted', 'my_after_purchase_js');
my_freemius()->add_filter('templates/checkout.php', 'my_checkout_enrich');
Copy link

would you elaborate where does this code goes. shell i add this code to the plugin header where Facebook pixel code already added or somewhere else?
Many thanks
irfan Qasim

Copy link

FQ400 commented Jun 19, 2020

There is a bug in my_freemius()->add_filter('checkout/purchaseCompleted', ''my_after_purchase_js);

It should be my_freemius()->add_filter('checkout/purchaseCompleted', 'my_after_purchase_js');

Copy link

FQ400 commented Jun 19, 2020

@irfan-blackandwhite put it in a PHP file that is included after your freemius code is initialized.

Copy link

daigo75 commented Feb 1, 2021

How does this code tie with the tracking of purchases with Google Analytics? I can see that the purpose is to return a JS function that will act as callback. The callback receives a data object, but it's unclear of what that object contains, and how it can be used to track the purchase. A more detailed example would be useful. Thanks.

Copy link

@daigo75 it's the exact same implementation of the example shown here, just a different way to register for the same event handler.

If you dive into the implementation of the checkout's JS code, the callable param provided as purchaseCompleted in the will use our postMessage FS.PostMessage.receiveOnce( 'purchaseCompleted' , callable ) implementation.

By using the filter, it does the exact same thing in templates/checkout.

Copy link

daigo75 commented Mar 24, 2021

Thanks for the clarification. 👍

Copy link

hqwebs commented Mar 26, 2021


Below is an example with Google Tag Manager.

my_freemius()->add_filter('checkout/purchaseCompleted', function ($js_function) {
	return "function ( response ) {
	    window.dataLayer = window.dataLayer || []
	    function gtag(){dataLayer.push(arguments)}
	    gtag('js', new Date())
            gtag('config', 'UA-XXXXXXXXXXX', {
	      'cookie_domain': ''
		isTrial = (null != response.purchase.trial_ends),
		isSubscription = (null != response.purchase.initial_amount),
		total = isTrial ? 0 : (isSubscription ? response.purchase.initial_amount : response.purchase.gross).toString()
		'event': 'purchase',
		'price': total

my_freemius()->add_filter('templates/checkout.php', function ($html) {
	return '<script async src=""></script>' . $html;

Copy link

@hqwebs This might be a silly question, but where should I add this code?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment