prepare_cart_data_fb_response( 'add_payment_info' ) );
}
if ( 'enable' === self::$ga_settings['enable_add_payment_info'] ) {
$vars['add_payment_info_data'] = wp_json_encode( $this->prepare_cart_data_ga_response() );
}
return $vars;
}
/**
* Add the facebook pixel and google analytics code.
*/
public function add_tracking_code() {
$compatibility = Cartflows_Compatibility::get_instance();
if ( $compatibility->is_page_builder_preview() ) {
return;
}
$this->add_facebook_pixel_tracking_code();
$this->add_google_analytics_tracking_code();
}
/**
* Function for facebook pixel.
*/
public function add_facebook_pixel_tracking_code() {
if ( 'enable' === self::$fb_pixel_settings['facebook_pixel_tracking'] ) {
$facebook_id = esc_attr( self::$fb_pixel_settings['facebook_pixel_id'] );
$fb_script = "
![](https://www.facebook.com/tr?id=" . esc_js( $facebook_id ) . "&ev=PageView&noscript=1)
";
if ( 'enable' === self::$fb_pixel_settings['facebook_pixel_tracking_for_site'] ) {
echo $fb_script; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
$this->trigger_viewcontent_events();
} elseif ( wcf()->utils->is_step_post_type() ) {
echo $fb_script; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
$this->trigger_viewcontent_events();
}
// Trigger other events on CartFlows pages only.
if ( wcf()->is_woo_active && wcf()->utils->is_step_post_type() ) {
$this->trigger_other_fb_events();
}
}
}
/**
* Trigger the View Content events for facebook pixel.
*/
public function trigger_viewcontent_events() {
$event_script = '';
// Check if ViewContent is enable or disable.
if ( 'enable' === self::$fb_pixel_settings['facebook_pixel_view_content'] ) {
$view_content = wp_json_encode( $this->prepare_viewcontent_data_fb_response() );
$event_script .= "
";
}
echo $event_script; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Trigger the other events for facebook pixel.
*/
public function trigger_other_fb_events() {
$event_script = '';
if ( _is_wcf_checkout_type() && 'enable' === self::$fb_pixel_settings['facebook_pixel_initiate_checkout'] ) {
$cart_data = wp_json_encode( $this->prepare_cart_data_fb_response( 'add_to_cart' ) );
$initiate_checkout_data = wp_json_encode( $this->prepare_cart_data_fb_response( 'initiate_checkout' ) );
$event_script .= "
";
}
if ( isset( $_GET['wcf-order'] ) && 'enable' === self::$fb_pixel_settings['facebook_pixel_purchase_complete'] ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
$order_id = intval( $_GET['wcf-order'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
$purchase_details = $this->prepare_purchase_data_fb_response( $order_id );
if ( ! empty( $purchase_details ) ) {
$purchase_details = wp_json_encode( $purchase_details );
$event_script .= "
";
}
}
do_action( 'cartflows_facebook_pixel_events' );
echo $event_script; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Prepare checkout purchase response for facebook purchase event.
*
* @param integer $order_id order id.
*/
public function prepare_purchase_data_fb_response( $order_id ) {
$purchase_data = array();
$order = wc_get_order( $order_id );
if ( ! $order ) {
return $purchase_data;
}
$is_checkout_tracked = $order->get_meta( '_wcf_fbp_checkout_tracked' );
if ( $is_checkout_tracked ) {
return $purchase_data;
}
// Do not trigger purchase event if it is optin.
$is_optin = $order->get_meta( '_wcf_optin_id' );
if ( $is_optin ) {
return $purchase_data;
}
$purchase_data['transaction_id'] = $order_id;
$purchase_data['content_type'] = 'product';
$purchase_data['currency'] = wcf()->options->get_checkout_meta_value( $order_id, '_order_currency' );
$purchase_data['userAgent'] = wcf()->options->get_checkout_meta_value( $order_id, '_customer_user_agent' );
$purchase_data['plugin'] = 'CartFlows';
// Iterating through each WC_Order_Item_Product objects.
foreach ( $order->get_items() as $item_key => $item ) {
$product = $item->get_product(); // Get the WC_Product object.
$purchase_data['content_ids'][] = (string) $product->get_id();
$purchase_data['content_names'][] = $product->get_name();
$purchase_data['content_category'][] = wp_strip_all_tags( wc_get_product_category_list( $product->get_id() ) );
}
$purchase_data['value'] = wcf()->options->get_checkout_meta_value( $order_id, '_order_total' );
$order->update_meta_data( '_wcf_fbp_checkout_tracked', true );
$order->save();
return $purchase_data;
}
/**
* Prepare cart data for fb response.
*
* @param string $event event type.
*
* @return array
*/
public function prepare_cart_data_fb_response( $event = '' ) {
$params = array();
if ( ! wcf()->is_woo_active ) {
return $params;
}
$cart_total = self::format_number( WC()->cart->cart_contents_total + WC()->cart->tax_total );
$cart_items_count = WC()->cart->get_cart_contents_count();
$items = WC()->cart->get_cart();
$product_data = $this->get_required_product_data_for_fb( $items );
$params['content_ids'] = $product_data['content_ids'];
$params['content_type'] = 'product';
$params['plugin'] = 'CartFlows-Checkout';
$params['value'] = $cart_total;
$params['content_name'] = substr( $product_data['product_names'], 2 );
$params['content_category'] = substr( $product_data['category_names'], 2 );
$params['contents'] = wp_json_encode( $product_data['cart_contents'] );
$params['currency'] = get_woocommerce_currency();
$params['user_roles'] = implode( ', ', wp_get_current_user()->roles );
if ( 'add_to_cart' !== $event ) {
$params['num_items'] = $cart_items_count;
$params['domain'] = get_site_url();
$params['language'] = get_bloginfo( 'language' );
$params['userAgent'] = isset( $_SERVER['HTTP_USER_AGENT'] ) ? wc_clean( wp_unslash( $_SERVER['HTTP_USER_AGENT'] ) ) : ''; //phpcs:ignore WordPressVIPMinimum.Variables.RestrictedVariables.cache_constraints___SERVER__HTTP_USER_AGENT__
}
return $params;
}
/**
* Prepare view content data for fb response.
*
* @return array
*/
public function prepare_viewcontent_data_fb_response() {
global $post, $wcf_step;
$params = array();
// Page Title.
$step_id = ( $wcf_step ) ? ( $wcf_step->get_current_step() ) : ( get_the_ID() );
$params['content_name'] = get_post_field( 'post_title', $step_id );
// Checkout Page View Content Data.
if ( wcf()->is_woo_active ) {
if ( _is_wcf_checkout_type() ) {
$cart_total = self::format_number( WC()->cart->cart_contents_total + WC()->cart->tax_total );
$items = WC()->cart->get_cart();
$product_data = $this->get_required_product_data_for_fb( $items );
$params['content_ids'] = $product_data['content_ids'];
$params['currency'] = get_woocommerce_currency();
$params['value'] = $cart_total;
$params['content_type'] = 'product';
$params['contents'] = wp_json_encode( $product_data['cart_contents'] );
}
// Added filter for offer pages view content event compatibility.
$params = apply_filters( 'cartflows_view_content_offer', $params, $step_id );
}
return $params;
}
/**
* Get product data for FB.
*
* @param object $items products data.
*/
public function get_required_product_data_for_fb( $items ) {
$product_data = array();
$content_ids = array();
$category_names = '';
$product_names = '';
foreach ( $items as $item => $value ) {
$_product = wc_get_product( $value['product_id'] );
if ( $_product ) {
$product_obj = $_product;
if ( $_product->is_type( 'variable' ) && isset( $value['variation_id'] ) ) {
$product_obj = wc_get_product( $value['variation_id'] );
}
if ( $product_obj ) {
$content_ids[] = (string) $product_obj->get_id();
$product_names = $product_names . ', ' . $product_obj->get_name();
$category_names = $category_names . ', ' . wp_strip_all_tags( wc_get_product_category_list( $product_obj->get_id() ) );
$data = array(
'id' => $product_obj->get_id(),
'name' => $product_obj->get_name(),
'price' => self::format_number( $value['line_subtotal'] + $value['line_subtotal_tax'] ),
'quantity' => $value['quantity'],
);
array_push( $product_data, $data );
}
}
}
return array(
'cart_contents' => $product_data,
'content_ids' => $content_ids,
'product_names' => $product_names,
'category_names' => $category_names,
);
}
/**
* Render google tag framework.
*/
public function add_google_analytics_tracking_code() {
$ga_tracking_id = esc_attr( self::$ga_settings['google_analytics_id'] );
if ( 'enable' === self::$ga_settings['enable_google_analytics'] ) {
// phpcs:disable WordPress.WP.EnqueuedResources.NonEnqueuedScript
$ga_script =
'
';
//phpcs:enable WordPress.WP.EnqueuedResources.NonEnqueuedScript
if ( 'enable' === self::$ga_settings['enable_google_analytics_for_site'] ) {
echo $ga_script; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
} elseif ( wcf()->utils->is_step_post_type() ) {
echo $ga_script; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
// Trigger other events on CartFlows pages only.
if ( wcf()->is_woo_active && wcf()->utils->is_step_post_type() ) {
$this->trigger_other_ga_events();
}
}
}
/**
* Trigger the other events for facebook pixel.
*/
public function trigger_other_ga_events() {
$event_script = '';
if ( _is_wcf_checkout_type() ) {
$cart_data = $this->prepare_cart_data_ga_response();
$event_data = wp_json_encode( $cart_data );
if ( 'enable' === self::$ga_settings['enable_add_to_cart'] ) {
$event_script .= "
";
}
if ( 'enable' === self::$ga_settings['enable_begin_checkout'] ) {
$event_script .= "
";
}
}
if ( isset( $_GET['wcf-order'] ) && 'enable' === self::$ga_settings['enable_purchase_event'] ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
$order_id = intval( $_GET['wcf-order'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
$purchase_details = $this->get_ga_purchase_transactions_data( $order_id );
if ( ! empty( $purchase_details ) ) {
$purchase_data = wp_json_encode( $purchase_details );
$event_script .= "
";
}
}
do_action( 'cartflows_google_analytics_events' );
echo $event_script; //phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Prepare cart data for GA response.
*
* @param int $order_id order id.
* @return array
*/
public function get_ga_purchase_transactions_data( $order_id ) {
$purchase_data = array();
$order = wc_get_order( $order_id );
if ( ! $order ) {
return $purchase_data;
}
$is_checkout_tracked = $order->get_meta( '_wcf_ga_checkout_tracked' );
if ( $is_checkout_tracked ) {
return $purchase_data;
}
$purchase_data['items'] = array();
$cart_contents = array();
$purchase_data = array(
'send_to' => self::$ga_settings['google_analytics_id'],
'event_category' => 'Enhanced-Ecommerce',
'transaction_id' => $order_id,
'affiliation' => get_bloginfo( 'name' ),
'value' => self::format_number( $order->get_total() ),
'currency' => $order->get_currency(),
'tax' => self::format_number( $order->get_total_tax() ),
'shipping' => self::format_number( $order->get_shipping_total() + $order->get_shipping_tax() ),
'coupon' => $order->get_coupon_codes(),
'non_interaction' => true,
);
$items = $order->get_items();
$items_data = $this->get_required_product_data_for_ga( $items );
$purchase_data['items'] = $items_data;
$order->update_meta_data( '_wcf_ga_checkout_tracked', true );
$order->save();
return $purchase_data;
}
/**
* Prepare Ecommerce data for GA response.
*
* @return array
*/
public function prepare_cart_data_ga_response() {
$items_data = array();
$cart_data = array();
if ( ! wcf()->is_woo_active ) {
return $cart_data;
}
$items = WC()->cart->get_cart();
$items_data = $this->get_required_product_data_for_ga( $items );
$cart_data = array(
'send_to' => self::$ga_settings['google_analytics_id'],
'event_category' => 'Enhanced-Ecommerce',
'currency' => get_woocommerce_currency(),
'coupon' => WC()->cart->get_applied_coupons(),
'value' => self::format_number( WC()->cart->cart_contents_total + WC()->cart->tax_total ),
'items' => $items_data,
'non_interaction' => true,
);
return $cart_data;
}
/**
* Get product data.
*
* @param object $items products data.
*/
public function get_required_product_data_for_ga( $items ) {
$product_data = array();
foreach ( $items as $item => $value ) {
$_product = wc_get_product( $value['product_id'] );
if ( $_product ) {
$product_obj = $_product;
if ( $_product->is_type( 'variable' ) && isset( $value['variation_id'] ) ) {
$product_obj = wc_get_product( $value['variation_id'] );
}
if ( $product_obj ) {
$data = array(
'id' => $product_obj->get_id(),
'name' => $product_obj->get_name(),
'sku' => $product_obj->get_sku(),
'category' => wp_strip_all_tags( wc_get_product_category_list( $product_obj->get_id() ) ),
'price' => self::format_number( $value['line_subtotal'] + $value['line_subtotal_tax'] ),
'quantity' => $value['quantity'],
);
array_push( $product_data, $data );
}
}
}
return $product_data;
}
/**
* Get decimal of price.
*
* @param integer $price price.
*/
public static function format_number( $price ) {
return number_format( floatval( $price ), wc_get_price_decimals(), '.', '' );
}
}
/**
* Kicking this off by calling 'get_instance()' method
*/
Cartflows_Tracking::get_instance();