add_step_save_events(); add_action( 'woocommerce_setup_footer', array( $this, 'add_footer_scripts' ) ); } /** * Get the name of the current step. * * @return string */ public function get_current_step() { return isset( $_GET['step'] ) ? sanitize_key( $_GET['step'] ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Recommended } /** * Add footer scripts to OBW via woocommerce_setup_footer */ public function add_footer_scripts() { wp_print_scripts(); WC_Site_Tracking::add_tracking_function(); wc_print_js(); } /** * Dequeue unwanted scripts from OBW footer. */ public function dequeue_non_allowed_scripts() { global $wp_scripts; $allowed = array( 'woo-tracks' ); foreach ( $wp_scripts->queue as $script ) { if ( in_array( $script, $allowed, true ) ) { continue; } wp_dequeue_script( $script ); } } /** * Track when tracking is opted into and OBW has started. * * @param string $option Option name. * @param string $value Option value. * @return void */ public function track_start( $option, $value ) { if ( 'yes' !== $value || empty( $_GET['page'] ) || 'wc-setup' !== $_GET['page'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended return; } WC_Tracks::record_event( 'obw_start' ); } /** * Track the marketing form on submit. */ public function track_ready_next_steps() { if ( 'next_steps' !== $this->get_current_step() ) { return; } wc_enqueue_js( " jQuery( '#mc-embedded-subscribe' ).click( function() { window.wcTracks.recordEvent( 'obw_marketing_signup' ); } ); jQuery( '.wc-setup-content a' ).click( function trackNextScreen( e ) { var properties = { next_url: e.target.href, button: e.target.textContent && e.target.textContent.trim() }; window.wcTracks.recordEvent( 'obw_ready_next_step', properties ); } ); " ); } /** * Track various events when a step is saved. */ public function add_step_save_events() { // Always record a track on this page view. if ( 'next_steps' === $this->get_current_step() ) { add_action( 'admin_init', array( $this, 'track_next_steps' ), 1 ); } if ( empty( $_POST['save_step'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing return; } update_option( 'woocommerce_obw_last_completed_step', $this->get_current_step() ); switch ( $this->get_current_step() ) { case '': case 'store_setup': add_action( 'admin_init', array( $this, 'track_store_setup' ), 1 ); break; case 'payment': add_action( 'admin_init', array( $this, 'track_payments' ), 1 ); break; case 'shipping': add_action( 'admin_init', array( $this, 'track_shipping' ), 1 ); break; case 'recommended': add_action( 'admin_init', array( $this, 'track_recommended' ), 1 ); break; case 'activate': add_action( 'admin_init', array( $this, 'track_jetpack_activate' ), 1 ); break; } } /** * Track store setup and store properties on save. * * @return void */ public function track_store_setup() { // phpcs:disable WordPress.Security.NonceVerification.Missing, WordPress.Security.ValidatedSanitizedInput $properties = array( 'country' => isset( $_POST['store_country'] ) ? sanitize_text_field( $_POST['store_country'] ) : '', 'currency_code' => isset( $_POST['currency_code'] ) ? sanitize_text_field( $_POST['currency_code'] ) : '', 'product_type' => isset( $_POST['product_type'] ) ? sanitize_text_field( $_POST['product_type'] ) : '', 'sell_in_person' => isset( $_POST['sell_in_person'] ) && ( 'yes' === sanitize_text_field( $_POST['sell_in_person'] ) ), ); // phpcs:enable WC_Tracks::record_event( 'obw_store_setup', $properties ); } /** * Track payment gateways selected. * * @return void */ public function track_payments() { $selected_gateways = array(); $created_accounts = array(); $wc_admin_setup_wizard = new WC_Admin_Setup_Wizard(); $gateways = array_merge( $wc_admin_setup_wizard->get_wizard_in_cart_payment_gateways(), $wc_admin_setup_wizard->get_wizard_manual_payment_gateways() ); foreach ( $gateways as $gateway_id => $gateway ) { if ( ! empty( $_POST[ 'wc-wizard-service-' . $gateway_id . '-enabled' ] ) ) { // WPCS: CSRF ok, input var ok. $selected_gateways[] = $gateway_id; } } // Stripe account being created. if ( ! empty( $_POST['wc-wizard-service-stripe-enabled'] ) && // WPCS: CSRF ok, input var ok. ! empty( $_POST['stripe_create_account'] ) // WPCS: CSRF ok, input var ok. ) { $created_accounts[] = 'stripe'; } // PayPal account being created. if ( ! empty( $_POST['wc-wizard-service-ppec_paypal-enabled'] ) && // WPCS: CSRF ok, input var ok. ! empty( $_POST['ppec_paypal_reroute_requests'] ) // WPCS: CSRF ok, input var ok. ) { $created_accounts[] = 'ppec_paypal'; } $properties = array( 'selected_gateways' => implode( ', ', $selected_gateways ), 'created_accounts' => implode( ', ', $created_accounts ), ); WC_Tracks::record_event( 'obw_payments', $properties ); } /** * Track shipping units and whether or not labels are set. * * @return void */ public function track_shipping() { // phpcs:disable WordPress.Security.NonceVerification.Missing, WordPress.Security.ValidatedSanitizedInput $properties = array( 'weight_unit' => isset( $_POST['weight_unit'] ) ? sanitize_text_field( wp_unslash( $_POST['weight_unit'] ) ) : '', 'dimension_unit' => isset( $_POST['dimension_unit'] ) ? sanitize_text_field( wp_unslash( $_POST['dimension_unit'] ) ) : '', 'setup_wcs_labels' => isset( $_POST['setup_woocommerce_services'] ) && 'yes' === $_POST['setup_woocommerce_services'], 'setup_shipstation' => isset( $_POST['setup_shipstation'] ) && 'yes' === $_POST['setup_shipstation'], ); // phpcs:enable WC_Tracks::record_event( 'obw_shipping', $properties ); } /** * Track recommended plugins selected for install. * * @return void */ public function track_recommended() { // phpcs:disable WordPress.Security.NonceVerification.Missing $properties = array( 'setup_storefront' => isset( $_POST['setup_storefront_theme'] ) && 'yes' === $_POST['setup_storefront_theme'], 'setup_automated_tax' => isset( $_POST['setup_automated_taxes'] ) && 'yes' === $_POST['setup_automated_taxes'], 'setup_mailchimp' => isset( $_POST['setup_mailchimp'] ) && 'yes' === $_POST['setup_mailchimp'], 'setup_facebook' => isset( $_POST['setup_facebook'] ) && 'yes' === $_POST['setup_facebook'], 'setup_wc_admin' => isset( $_POST['setup_wc_admin'] ) && 'yes' === $_POST['setup_wc_admin'], ); // phpcs:enable WC_Tracks::record_event( 'obw_recommended', $properties ); } /** * Tracks when Jetpack is activated through the OBW. * * @return void */ public function track_jetpack_activate() { WC_Tracks::record_event( 'obw_activate' ); } /** * Tracks when last next_steps screen is viewed in the OBW. * * @return void */ public function track_next_steps() { WC_Tracks::record_event( 'obw_ready_view' ); } /** * Track skipped steps. * * @return void */ public function track_skip_step() { $previous_step = get_option( 'woocommerce_obw_last_completed_step' ); $current_step = $this->get_current_step(); if ( ! $previous_step || ! $current_step ) { return; } $steps = array_keys( $this->steps ); $current_step_index = array_search( $current_step, $steps, true ); $previous_step_index = array_search( $previous_step, $steps, true ); // If we're going forward more than 1 completed step. if ( $current_step_index > $previous_step_index + 1 ) { $properties = array( 'step' => $steps[ $current_step_index - 1 ], ); WC_Tracks::record_event( 'obw_skip_step', $properties ); } } /** * Set the OBW steps inside this class instance. * * @param array $steps Array of OBW steps. */ public function set_obw_steps( $steps ) { $this->steps = $steps; return $steps; } }