Skip to content

Commit

Permalink
try a new module with woocommerce tracking, ported from recent google…
Browse files Browse the repository at this point in the history 
… analytics enhancements (#8296)
  • Loading branch information
@greenafrican @oskosk
greenafrican authored and oskosk committed Feb 21, 2018
1 parent aa4cacd commit 5df5c2e
Show file tree
Hide file tree
Showing 5 changed files with 491 additions and 0 deletions.
1 change: 1 addition & 0 deletions modules/module-extras.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
'seo-tools/jetpack-seo-posts.php',
'simple-payments/simple-payments.php',
'verification-tools/verification-tools-utils.php',
'woocommerce-analytics/wp-woocommerce-analytics.php',
);

// Not every tool needs to be included if Jetpack is inactive and not in development mode
Expand Down
15 changes: 15 additions & 0 deletions modules/module-info.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -667,3 +667,18 @@ function jetpack_google_analytics_more_info() {
, 'jetpack' );
}
add_action( 'jetpack_module_more_info_google-analytics', 'jetpack_google_analytics_more_info' );

/**
* WooCommerce Analytics
*/
function jetpack_woocommerce_analytics_more_link() {
echo 'https://jetpack.com/support/';
}
add_action( 'jetpack_learn_more_button_woocommerce-analytics', 'jetpack_woocommerce_analytics_more_link' );

function jetpack_woocommerce_analytics_more_info() {
esc_html_e(
'Enhanced analytics for WooCommerce and Jetpack users.'
, 'jetpack' );
}
add_action( 'jetpack_module_more_info_woocommerce-analytics', 'jetpack_woocommerce_analytics_more_info' );
328 changes: 328 additions & 0 deletions modules/woocommerce-analytics/classes/wp-woocommerce-analytics-universal.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,328 @@
<?php
/**
* Jetpack_WooCommerce_Analytics_Universal
*
* @package Jetpack
* @author Automattic
*/

/**
* Bail if accessed directly
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}

/**
* Class Jetpack_WooCommerce_Analytics_Universal
* Filters and Actions added to Store pages to perform analytics
*/
class Jetpack_WooCommerce_Analytics_Universal {
/**
* Jetpack_WooCommerce_Analytics_Universal constructor.
*/
public function __construct() {
// loading _wca
add_action( 'wp_head', array( $this, 'wp_head_top' ), 1 );

// loading s.js
add_action( 'wp_head', array( $this, 'wp_head_bottom' ), 999999 );

// single product page view
add_action( 'woocommerce_after_single_product', array( $this, 'product_detail' ) );

// add to cart on single product page
add_action( 'woocommerce_after_add_to_cart_button', array( $this, 'add_to_cart' ) );

// add to carts from list views (search, store etc.)
add_action( 'wp_footer', array( $this, 'loop_add_to_cart' ) );


add_action( 'woocommerce_after_cart', array( $this, 'remove_from_cart' ) );
add_action( 'woocommerce_after_mini_cart', array( $this, 'remove_from_cart' ) );
add_action( 'wcct_before_cart_widget', array( $this, 'remove_from_cart' ) );
add_filter( 'woocommerce_cart_item_remove_link', array( $this, 'remove_from_cart_attributes' ), 10, 2 );

// cart checkout
add_action( 'woocommerce_after_checkout_form', array( $this, 'checkout_process' ) );

// order confirmed
add_action( 'woocommerce_thankyou', array( $this, 'order_process' ), 10, 1 );
add_action( 'woocommerce_after_cart', array( $this, 'remove_from_cart_via_quantity' ), 10, 1 );
}

/**
* Make _wca available to queue events
*/
public function wp_head_top() {
if ( is_cart() || is_checkout() || is_checkout_pay_page() || is_order_received_page() || is_add_payment_method_page() ) {
$prevent_referrer_code = "<script>window._wca_prevent_referrer = true;</script>";
echo "$prevent_referrer_code\r\n";
}
$wca_code = "<script>window._wca = window._wca || [];</script>";
echo "$wca_code\r\n";
}


/**
* Place script to call s.js, Store Analytics
*/
public function wp_head_bottom() {
$filename = 's-' . gmdate( 'YWd' ) . '.js';
$async_code = "<script async src='https://stats.wp.com/" . $filename . "'></script>";
echo "$async_code\r\n";
}

/**
* On a product page, add a click event listener to "Add to Cart" button click
*/
public function add_to_cart() {

if ( ! is_single() ) {
return;
}

$blogid = Jetpack::get_option( 'id' );
global $product;

wc_enqueue_js(
"jQuery( '" . esc_js( '.single_add_to_cart_button' ) . "' ).click( function() {
_wca.push( {
'_en': 'woocommerceanalytics_add_to_cart',
'blog_id': " . esc_js( $blogid ) . ",
'pi': '" . esc_js( $product->get_id() ) . "',
'pn' : '" . esc_js( $product->get_title() ) . "',
'pq': jQuery( 'input.qty' ).val() ? jQuery( 'input.qty' ).val() : '1',
'ui': '" . esc_js( $this->get_user_id() ) . "',
} );
} );"
);
}

/**
* On product lists or other non-product pages, add an event listener to "Add to Cart" button click
*/
public function loop_add_to_cart() {
$blogid = Jetpack::get_option( 'id' );
$selector = '.add_to_cart_button:not(.product_type_variable, .product_type_grouped)';

wc_enqueue_js(
"jQuery( '" . esc_js( $selector ) . "' ).click( function() {
var productID = jQuery( this ).data( 'product_id' );
var productDetails = {
'id': productID,
'quantity': jQuery( this ).data( 'quantity' ),
};
_wca.push( {
'_en': 'woocommerceanalytics_product_view',
'blog_id': '" . esc_js( $blogid ) . "',
'pi': productDetails.id,
'ui': '" . esc_js( $this->get_user_id() ) . "',
} );
_wca.push( {
'_en': 'woocommerceanalytics_add_to_cart',
'blog_id': " . esc_js( $blogid ) . ",
'pi': productDetails.id,
'pq': productDetails.quantity,
'ui': '" . esc_js( $this->get_user_id() ) . "',
} );
} );"
);
}

/**
* On the cart page, add an event listener for removal of product click
*/
public function remove_from_cart() {

// We listen at div.woocommerce because the cart 'form' contents get forcibly
// updated and subsequent removals from cart would then not have this click
// handler attached.
$blogid = Jetpack::get_option( 'id' );
wc_enqueue_js(
"jQuery( 'div.woocommerce' ).on( 'click', 'a.remove', function() {
var productID = jQuery( this ).data( 'product_id' );
var quantity = jQuery( this ).parent().parent().find( '.qty' ).val()
var productDetails = {
'id': productID,
'quantity': quantity ? quantity : '1',
};
_wca.push( {
'_en': 'woocommerceanalytics_remove_from_cart',
'blog_id': '" . esc_js( $blogid ) . "',
'pi': productDetails.id,
'pq': productDetails.quantity,
'ui': '" . esc_js( $this->get_user_id() ) . "',
} );
} );"
);
}

/**
* Adds the product ID to the remove product link (for use by remove_from_cart above) if not present
*
* @param string $url url.
* @param string $key key.
* @return mixed.
*/
public function remove_from_cart_attributes( $url, $key ) {
if ( false !== strpos( $url, 'data-product_id' ) ) {
return $url;
}

$item = WC()->cart->get_cart_item( $key );
$product = $item['data'];

$new_attributes = sprintf(
'href="%s" data-product_id="%s" data-product_sku="%s"',
esc_attr( $url ),
esc_attr( $product->get_id() ),
esc_attr( $product->get_sku() )
);
$url = str_replace( 'href=', $new_attributes );
return $url;
}

/**
* Gather relevant product information
*
* @param array $product product
* @return array
*/
public function get_item_details( $product ) {
return array(
'id' => $product->get_id(),
'name' => $product->get_title(),
'category' => Jetpack_WooCommerce_Analytics_Utils::get_product_categories_concatenated( $product ),
'price' => $product->get_price(),
);
}

/**
* Track a product page view
*/
public function product_detail() {

global $product;
$blogid = Jetpack::get_option( 'id' );

$item_details = $this->get_item_details( $product );

wc_enqueue_js(
"_wca.push( {
'_en': 'woocommerceanalytics_product_view',
'blog_id': '" . esc_js( $blogid ) . "',
'pi': '" . esc_js( $item_details['id'] ) . "',
'pn': '" . esc_js( $item_details['name'] ) . "',
'pc': '" . esc_js( $item_details['category'] ) . "',
'pp': '" . esc_js( $item_details['price'] ) . "',
'ui': '" . esc_js( $this->get_user_id() ) . "',
} );"
);
}

/**
* On the Checkout page, trigger an event for each product in the cart
*/
public function checkout_process() {

$universal_commands = array();
$cart = WC()->cart->get_cart();
$blogid = Jetpack::get_option( 'id' );

foreach ( $cart as $cart_item_key => $cart_item ) {
/**
* This filter is already documented in woocommerce/templates/cart/cart.php
*/
$product = apply_filters( 'woocommerce_cart_item_product', $cart_item['data'], $cart_item, $cart_item_key );

$item_details = $this->get_item_details( $product );

$universal_commands[] = "_wca.push( {
'_en': 'woocommerceanalytics_product_checkout',
'blog_id': '" . esc_js( $blogid ) . "',
'pi': '" . esc_js( $item_details['id'] ) . "',
'pn': '" . esc_js( $item_details['name'] ) . "',
'pc': '" . esc_js( $item_details['category'] ) . "',
'pp': '" . esc_js( $item_details['price'] ) . "',
'pq': '" . esc_js( $cart_item['quantity'] ) . "',
'ui': '" . esc_js( $this->get_user_id() ) . "',
} );";
}

wc_enqueue_js( implode( "\r\n", $universal_commands ) );
}

/**
* After the checkout process, fire an event for each item in the order
*
* @param string $order_id Order Id.
*/
public function order_process( $order_id ) {
$order = wc_get_order( $order_id );
$universal_commands = array();
$blogid = Jetpack::get_option( 'id' );

// loop through products in the order and queue a purchase event.
foreach ( $order->get_items() as $order_item_id => $order_item ) {
$product = $order->get_product_from_item( $order_item );

$item_details = $this->get_item_details( $product );

$universal_commands[] = "_wca.push( {
'_en': 'woocommerceanalytics_product_purchase',
'blog_id': '" . esc_js( $blogid ) . "',
'pi': '" . esc_js( $item_details['id'] ) . "',
'pn': '" . esc_js( $item_details['name'] ) . "',
'pc': '" . esc_js( $item_details['category'] ) . "',
'pp': '" . esc_js( $item_details['price'] ) . "',
'pq': '" . esc_js( $order_item->get_quantity() ) . "',
'oi': '" . esc_js( $order->get_order_number() ) . "',
'ui': '" . esc_js( $this->get_user_id() ) . "',
} );";
}

wc_enqueue_js( implode( "\r\n", $universal_commands ) );
}

/**
* Listen for clicks on the "Update Cart" button to know if an item has been removed by
* updating its quantity to zero
*/
public function remove_from_cart_via_quantity() {
$blogid = Jetpack::get_option( 'id' );

wc_enqueue_js( "
jQuery( 'input[name=update_cart]' ).on( 'click', function() {
var cartItems = jQuery( '.cart_item' );
cartItems.each( function( item ) {
var qty = jQuery( this ).find( 'input.qty' );
if ( qty && qty.val() === '0' ) {
var productID = jQuery( this ).find( '.product-remove a' ).data( 'product_id' );
_wca.push( {
'_en': 'woocommerceanalytics_remove_from_cart',
'blog_id': '" . esc_js( $blogid ) . "',
'pi': productID,
'ui': '" . esc_js( $this->get_user_id() ) . "',
} );
}
} );
} );
" );
}

/**
* Get the current user id
*
* @return int
*/
public function get_user_id() {
if ( is_user_logged_in() ) {
$blogid = Jetpack::get_option( 'id' );
$userid = get_current_user_id();
return $blogid . ":" . $userid;
}
return 'null';
}

}
Loading

0 comments on commit 5df5c2e

Please sign in to comment.