FileMaster

Edit File: class-wc-orders-tracking.php

<?php
/**
 * WooCommerce Orders Tracking
 *
 * @package WooCommerce\Tracks
 */

use Automattic\WooCommerce\Enums\OrderStatus;
use Automattic\WooCommerce\Utilities\OrderUtil;
use Automattic\WooCommerce\Internal\Admin\WCAdminAssets;

defined( 'ABSPATH' ) || exit;

/**
 * This class adds actions to track usage of WooCommerce Orders.
 */
class WC_Orders_Tracking {
	/**
	 * Init tracking.
	 */
	public function init() {
		add_action( 'woocommerce_order_status_changed', array( $this, 'track_order_status_change' ), 10, 3 );
		// WC_Meta_Box_Order_Actions::save() hooks in at priority 50.
		add_action( 'woocommerce_process_shop_order_meta', array( $this, 'track_order_action' ), 51 );

add_action( 'load-edit.php', array( $this, 'track_orders_view' ), 10 );
		add_action( 'load-woocommerce_page_wc-orders', array( $this, 'track_orders_view' ), 999 ); // HPOS.

add_action( 'load-post-new.php', array( $this, 'track_add_order_from_edit' ), 10 );
		add_action( 'load-woocommerce_page_wc-orders', array( $this, 'track_add_order_from_edit' ), 999 ); // HPOS.

add_action( 'woocommerce_process_shop_order_meta', array( $this, 'track_created_date_change' ), 10 );

add_action( 'load-edit.php', array( $this, 'track_search_in_orders_list' ) );
		add_action( 'load-woocommerce_page_wc-orders', array( $this, 'track_search_in_orders_list' ), 999 ); // HPOS.

add_action( 'admin_enqueue_scripts', array( $this, 'possibly_add_order_tracking_scripts' ) );
	}

/**
	 * Send a track event when on the Order Listing page, and search results are being displayed.
	 *
	 * @deprecated 8.6.0
	 *
	 * @param array  $order_ids Array of order_ids that are matches for the search.
	 * @param string $term The string that was used in the search.
	 * @param array  $search_fields Fields that were used in the original search.
	 */
	public function track_order_search( $order_ids, $term, $search_fields ) {
		wc_deprecated_function( __METHOD__, '8.6.0', 'WC_Orders_Tracking::track_search_in_orders_list' );

// Since `woocommerce_shop_order_search_results` can run in the front-end context, exit if get_current_screen isn't defined.
		if ( ! function_exists( 'get_current_screen' ) ) {
			return $order_ids;
		}

$screen = get_current_screen();

// We only want to record this track when the filter is executed on the order listing page.
		if ( 'edit-shop_order' === $screen->id ) {
			// we are on the order listing page, and query results are being shown.
			WC_Tracks::record_event( 'orders_view_search' );
		}

return $order_ids;
	}

/**
	 * Send a track event when on the Order Listing page, and search results are being displayed.
	 *
	 * @since 8.6.0
	 */
	public function track_search_in_orders_list() {
		if ( ! OrderUtil::is_order_list_table_screen() || empty( $_REQUEST['s'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
			return;
		}

WC_Tracks::record_event( 'orders_view_search' );
	}

/**
	 * Send a Tracks event when the Orders page is viewed.
	 */
	public function track_orders_view() {
		if ( ! OrderUtil::is_order_list_table_screen() ) {
			return;
		}

// phpcs:disable WordPress.Security.NonceVerification, WordPress.Security.ValidatedSanitizedInput
		$properties = array(
			'status' => sanitize_text_field( $_GET['post_status'] ?? ( $_GET['status'] ?? 'all' ) ),
		);
		// phpcs:enable

WC_Tracks::record_event( 'orders_view', $properties );
	}

/**
	 * Send a Tracks event when an order status is changed.
	 *
	 * @param int    $id Order id.
	 * @param string $previous_status the old WooCommerce order status.
	 * @param string $next_status the new WooCommerce order status.
	 */
	public function track_order_status_change( $id, $previous_status, $next_status ) {
		$order = wc_get_order( $id );

$properties = array(
			'order_id'        => $id,
			'next_status'     => $next_status,
			'previous_status' => $previous_status,
			'date_created'    => $order->get_date_created() ? $order->get_date_created()->date( 'Y-m-d' ) : '',
			'payment_method'  => $order->get_payment_method(),
			'order_total'     => $order->get_total(),
		);

WC_Tracks::record_event( 'orders_edit_status_change', $properties );
	}

/**
	 * Send a Tracks event when an order date is changed.
	 *
	 * @param int $id Order id.
	 */
	public function track_created_date_change( $id ) {
		if ( ! OrderUtil::is_order( $id ) ) {
			return;
		}

$order = wc_get_order( $id );
		if ( ! $order || OrderStatus::AUTO_DRAFT === $order->get_status() ) {
			return;
		}

$date_created = $order->get_date_created() ? $order->get_date_created()->date( 'Y-m-d H:i:s' ) : '';
		// phpcs:disable WordPress.Security.NonceVerification
		$new_date = sprintf(
			'%s %2d:%02d:%02d',
			isset( $_POST['order_date'] ) ? wc_clean( wp_unslash( $_POST['order_date'] ) ) : '',
			isset( $_POST['order_date_hour'] ) ? wc_clean( wp_unslash( $_POST['order_date_hour'] ) ) : '',
			isset( $_POST['order_date_minute'] ) ? wc_clean( wp_unslash( $_POST['order_date_minute'] ) ) : '',
			isset( $_POST['order_date_second'] ) ? wc_clean( wp_unslash( $_POST['order_date_second'] ) ) : ''
		);
		// phpcs:enable

if ( $new_date !== $date_created ) {
			$properties = array(
				'order_id' => $id,
				'status'   => $order->get_status(),
			);

WC_Tracks::record_event( 'order_edit_date_created', $properties );
		}
	}

/**
	 * Track order actions taken.
	 *
	 * @param int $order_id Order ID.
	 */
	public function track_order_action( $order_id ) {
		// phpcs:disable WordPress.Security.NonceVerification
		if ( ! empty( $_POST['wc_order_action'] ) ) {
			$order      = wc_get_order( $order_id );
			$action     = wc_clean( wp_unslash( $_POST['wc_order_action'] ) );
			$properties = array(
				'order_id' => $order_id,
				'status'   => $order->get_status(),
				'action'   => $action,
			);

WC_Tracks::record_event( 'order_edit_order_action', $properties );
		}
		// phpcs:enable
	}

/**
	 * Track "add order" button on the Edit Order screen.
	 */
	public function track_add_order_from_edit() {
		if ( ! OrderUtil::is_new_order_screen() ) {
			return;
		}

$referer = wp_get_referer();
		if ( ! $referer ) {
			return;
		}

$referring_page = wp_parse_url( $referer );

if ( empty( $referring_page['query'] ) ) {
			// Edit Order screen has query args.
			return;
		}
		parse_str( $referring_page['query'], $referring_args );

if ( OrderUtil::custom_orders_table_usage_is_enabled() ) {
			$post_edit_page = admin_url( 'admin.php?page=wc-orders' );
			$order_id       = $referring_args['id'] ?? 0;
		} else {
			$post_edit_page = admin_url( 'post.php' );
			$order_id       = $referring_args['post'] ?? 0;
		}
		$post_edit_page = wp_parse_url( $post_edit_page );

if (
			( $post_edit_page['path'] === $referring_page['path'] ) &&
			( ! isset( $post_edit_page['query'] ) || false !== strpos( $referring_page['query'], $post_edit_page['query'] ) ) &&
			( isset( $referring_args['action'] ) && 'edit' === $referring_args['action'] ) &&
			'shop_order' === OrderUtil::get_order_type( $order_id )
		) {
			WC_Tracks::record_event( 'order_edit_add_order' );
		}
	}

/**
	 * Adds the tracking scripts for product setting pages.
	 */
	public function possibly_add_order_tracking_scripts() {
		if ( ! OrderUtil::is_new_order_screen() && ! OrderUtil::is_order_edit_screen() && ! OrderUtil::is_order_list_table_screen() ) {
			return;
		}

WCAdminAssets::register_script( 'wp-admin-scripts', 'order-tracking', false );
	}
}

Back