WC_Tracks::record_event( string $event_name, array $properties = array() )

Record an event in Tracks – this is the preferred way to record events from PHP.

Contents

Description Description

Parameters Parameters

$event_name

(Required) The name of the event.

$properties

(Optional) Custom properties to send with the event.

Default value: array()

Top ↑

Return Return

(bool|WP_Error) True for success or WP_Error if the event pixel could not be fired.

Top ↑

Source Source

File: includes/tracks/class-wc-tracks.php 

	public static function record_event( $event_name, $properties = array() ) {
		/**
		 * Don't track users who don't have tracking enabled.
		 */
		if ( ! WC_Site_Tracking::is_tracking_enabled() ) {
			return false;
		}

		$user = wp_get_current_user();

		// We don't want to track user events during unit tests/CI runs.
		if ( $user instanceof WP_User && 'wptests_capabilities' === $user->cap_key ) {
			return false;
		}
		$prefixed_event_name = self::PREFIX . $event_name;

		$data = array(
			'_en' => $prefixed_event_name,
			'_ts' => WC_Tracks_Client::build_timestamp(),
		);

		$server_details = self::get_server_details();
		$identity       = WC_Tracks_Client::get_identity( $user->ID );
		$blog_details   = self::get_blog_details( $user->ID );

		// Allow event props to be filtered to enable adding site-wide props.
		$filtered_properties = apply_filters( 'woocommerce_tracks_event_properties', $properties, $prefixed_event_name );

		// Delete _ui and _ut protected properties.
		unset( $filtered_properties['_ui'] );
		unset( $filtered_properties['_ut'] );

		$event_obj = new WC_Tracks_Event( array_merge( $data, $server_details, $identity, $blog_details, $filtered_properties ) );

		if ( is_wp_error( $event_obj->error ) ) {
			return $event_obj->error;
		}

		return $event_obj->record();
	}

Expand full source code Collapse full source code

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
includes/tracks/class-wc-tracks-event.php: WC_Tracks_Event::__construct()

WC_Tracks_Event constructor.
includes/tracks/class-wc-site-tracking.php: WC_Site_Tracking::is_tracking_enabled()

Check if tracking is enabled.
includes/tracks/class-wc-tracks-client.php: WC_Tracks_Client::build_timestamp()

Create a timestap representing milliseconds since 1970-01-01
includes/tracks/class-wc-tracks-client.php: WC_Tracks_Client::get_identity()

Get a user’s identity to send to Tracks. If Jetpack exists, default to its implementation.
includes/tracks/class-wc-tracks.php: woocommerce_tracks_event_properties

Don’t track users who don’t have tracking enabled.
includes/tracks/class-wc-tracks.php: WC_Tracks::get_server_details()

Gather details from the request to the server.
includes/tracks/class-wc-tracks.php: WC_Tracks::get_blog_details()

Gather blog related properties.
Show 2 more uses Hide more uses

Top ↑

Used By Used By

Used By
Used By Description
includes/tracks/events/class-wc-extensions-tracking.php: WC_Extensions_Tracking::track_addon_install()

Send a Tracks event when addon is installed via the Extensions page.
includes/tracks/events/class-wc-coupon-tracking.php: WC_Coupon_Tracking::track_coupon_updated()

Send a Tracks event when a coupon is updated.
includes/tracks/events/class-wc-products-tracking.php: WC_Products_Tracking::track_categories_and_tags_view()

Send a Tracks event when the Products Categories and Tags page is viewed.
includes/tracks/events/class-wc-products-tracking.php: WC_Products_Tracking::track_product_updated()

Send a Tracks event when a product is updated.
includes/tracks/events/class-wc-products-tracking.php: WC_Products_Tracking::track_product_published()

Send a Tracks event when a product is published.
includes/tracks/events/class-wc-products-tracking.php: WC_Products_Tracking::track_product_category_created()

Send a Tracks event when a product category is created.
includes/tracks/events/class-wc-extensions-tracking.php: WC_Extensions_Tracking::track_helper_disconnected()

Send a Tracks even when a Helper has been disconnected.
includes/tracks/events/class-wc-extensions-tracking.php: WC_Extensions_Tracking::track_helper_subscriptions_refresh()

Send a Tracks even when Helper subscriptions are refreshed.
includes/tracks/events/class-wc-products-tracking.php: WC_Products_Tracking::track_products_view()

Send a Tracks event when the Products page is viewed.
includes/tracks/events/class-wc-extensions-tracking.php: WC_Extensions_Tracking::track_helper_connection_start()

Send a Tracks even when a Helper connection process is initiated.
includes/tracks/events/class-wc-extensions-tracking.php: WC_Extensions_Tracking::track_helper_connection_cancelled()

Send a Tracks even when a Helper connection process is cancelled.
includes/tracks/events/class-wc-extensions-tracking.php: WC_Extensions_Tracking::track_helper_connection_complete()

Send a Tracks even when a Helper connection process completed successfully.
includes/tracks/events/class-wc-status-tracking.php: WC_Status_Tracking::track_status_view()

Add Tracks events to the status page.
includes/tracks/events/class-wc-extensions-tracking.php: WC_Extensions_Tracking::track_extensions_page()

Send a Tracks event when an Extensions page is viewed.
includes/tracks/events/class-wc-settings-tracking.php: WC_Settings_Tracking::send_settings_change_event()

Send a Tracks event for WooCommerce options that changed values.
includes/tracks/events/class-wc-settings-tracking.php: WC_Settings_Tracking::track_settings_page_view()

Send a Tracks event for WooCommerce settings page views.
includes/tracks/events/class-wc-order-tracking.php: WC_Order_Tracking::track_order_viewed()

Send a Tracks event when an order is viewed.
includes/tracks/events/class-wc-orders-tracking.php: WC_Orders_Tracking::track_order_action()

Track order actions taken.
includes/tracks/events/class-wc-orders-tracking.php: WC_Orders_Tracking::track_add_order_from_edit()

Track “add order” button on the Edit Order screen.
includes/tracks/events/class-wc-coupons-tracking.php: WC_Coupons_Tracking::tracks_coupons_events()

Track page view events.
includes/tracks/events/class-wc-importer-tracking.php: WC_Importer_Tracking::track_product_importer_complete()

Send a Tracks event when the product importer has finished.
includes/tracks/events/class-wc-orders-tracking.php: WC_Orders_Tracking::track_order_search()

Send a track event when on the Order Listing page, and search results are being displayed.
includes/tracks/events/class-wc-orders-tracking.php: WC_Orders_Tracking::track_orders_view()

Send a Tracks event when the Orders page is viewed.
includes/tracks/events/class-wc-orders-tracking.php: WC_Orders_Tracking::track_order_status_change()

Send a Tracks event when an order status is changed.
includes/tracks/events/class-wc-orders-tracking.php: WC_Orders_Tracking::track_created_date_change()

Send a Tracks event when an order date is changed.
includes/tracks/events/class-wc-importer-tracking.php: WC_Importer_Tracking::track_product_importer_start()

Send a Tracks event when the product importer is started.
packages/woocommerce-admin/includes/core-functions.php: wc_admin_record_tracks_event()

Record an event using Tracks.
Show 22 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.