* WooCommerce Customer effort score tracks
* @package WooCommerce\Admin\Features
namespace Automattic\WooCommerce\Internal\Admin;
defined( 'ABSPATH' ) || exit;
* Triggers customer effort score on several different actions.
class CustomerEffortScoreTracks {
* Option name for the CES Tracks queue.
const CES_TRACKS_QUEUE_OPTION_NAME = 'woocommerce_ces_tracks_queue';
* Option name for the clear CES Tracks queue for page.
const CLEAR_CES_TRACKS_QUEUE_FOR_PAGE_OPTION_NAME =
'woocommerce_clear_ces_tracks_queue_for_page';
* Option name for the set of actions that have been shown.
const SHOWN_FOR_ACTIONS_OPTION_NAME = 'woocommerce_ces_shown_for_actions';
* Action name for product add/publish.
const PRODUCT_ADD_PUBLISH_ACTION_NAME = 'product_add_publish';
* Action name for product update.
const PRODUCT_UPDATE_ACTION_NAME = 'product_update';
* Action name for shop order update.
const SHOP_ORDER_UPDATE_ACTION_NAME = 'shop_order_update';
* Action name for settings change.
const SETTINGS_CHANGE_ACTION_NAME = 'settings_change';
* Action name for add product categories.
const ADD_PRODUCT_CATEGORIES_ACTION_NAME = 'add_product_categories';
* Action name for add product tags.
const ADD_PRODUCT_TAGS_ACTION_NAME = 'add_product_tags';
* Action name for add product attributes.
const ADD_PRODUCT_ATTRIBUTES_ACTION_NAME = 'add_product_attributes';
* Action name for import products.
const IMPORT_PRODUCTS_ACTION_NAME = 'import_products';
* Action name for search.
const SEARCH_ACTION_NAME = 'ces_search';
* Label for the snackbar that appears when a user submits the survey.
* Constructor. Sets up filters to hook into WooCommerce.
public function __construct() {
$this->enable_survey_enqueing_if_tracking_is_enabled();
* Add actions that require woocommerce_allow_tracking.
private function enable_survey_enqueing_if_tracking_is_enabled() {
// Only hook up the action handlers if in wp-admin.
// Do not hook up the action handlers if a mobile device is used.
// Only enqueue a survey if tracking is allowed.
$allow_tracking = 'yes' === get_option( 'woocommerce_allow_tracking', 'no' );
if ( ! $allow_tracking ) {
add_action( 'admin_init', array( $this, 'maybe_clear_ces_tracks_queue' ) );
add_action( 'woocommerce_update_options', array( $this, 'run_on_update_options' ), 10, 3 );
add_action( 'product_cat_add_form', array( $this, 'add_script_track_product_categories' ), 10, 3 );
add_action( 'product_tag_add_form', array( $this, 'add_script_track_product_tags' ), 10, 3 );
add_action( 'woocommerce_attribute_added', array( $this, 'run_on_add_product_attributes' ), 10, 3 );
add_action( 'load-edit.php', array( $this, 'run_on_load_edit_php' ), 10, 3 );
add_action( 'product_page_product_importer', array( $this, 'run_on_product_import' ), 10, 3 );
// Only hook up the transition_post_status action handler
if ( 'post.php' === $pagenow ) {
'transition_post_status',
'run_on_transition_post_status',
$this->onsubmit_label = __( 'Thank you for your feedback!', 'woocommerce' );
* Returns a generated script for tracking tags added on edit-tags.php page.
* CES survey is triggered via direct access to wc/customer-effort-score store
* via wp.data.dispatch method.
* Due to lack of options to directly hook ourselves into the ajax post request
* initiated by edit-tags.php page, we infer a successful request by observing
* an increase of the number of rows in tags table
* @param string $action Action name for the survey.
* @param string $title Title for the snackbar.
* @param string $first_question The text for the first question.
* @param string $second_question The text for the second question.
* @return string Generated JavaScript to append to page.
private function get_script_track_edit_php( $action, $title, $first_question, $second_question ) {
// Hook on submit button and sets a 500ms interval function
// to determine successful add tag or otherwise.
$('#addtag #submit').on( 'click', function() {
const initialCount = $('.tags tbody > tr').length;
const interval = setInterval( function() {
if ( $('.tags tbody > tr').length > initialCount ) {
clearInterval( interval );
wp.data.dispatch('wc/customer-effort-score').addCesSurvey({ action: '%s', title: '%s', firstQuestion: '%s', secondQuestion: '%s', onsubmitLabel: '%s' });
// Form is no longer loading, most likely failed.
if ( $( '#addtag .submit .spinner.is-active' ).length < 1 ) {
clearInterval( interval );
esc_js( $first_question ),
esc_js( $second_question ),
esc_js( $this->onsubmit_label )
* Get the current published product count.
* @return integer The current published product count.
private function get_product_count() {
$query = new \WC_Product_Query(
'status' => array( 'publish' ),
$products = $query->get_products();
$product_count = intval( $products->total );
* Get the current shop order count.
* @return integer The current shop order count.
private function get_shop_order_count() {
$query = new \WC_Order_Query(
$shop_orders = $query->get_orders();
$shop_order_count = intval( $shop_orders->total );
return $shop_order_count;
* Return whether the action has already been shown.
* @param string $action The action to check.
* @return bool Whether the action has already been shown.
private function has_been_shown( $action ) {
$shown_for_features = get_option( self::SHOWN_FOR_ACTIONS_OPTION_NAME, array() );
$has_been_shown = in_array( $action, $shown_for_features, true );
* Enqueue the item to the CES tracks queue.
* @param array $item The item to enqueue.
private function enqueue_to_ces_tracks( $item ) {
self::CES_TRACKS_QUEUE_OPTION_NAME,
$has_duplicate = array_filter(
function ( $queue_item ) use ( $item ) {
return $queue_item['action'] === $item['action'];
self::CES_TRACKS_QUEUE_OPTION_NAME,
* Enqueue the CES survey on using search dynamically.
* @param string $search_area Search area such as "product" or "shop_order".
* @param string $page_now Value of window.pagenow.
* @param string $admin_page Value of window.adminpage.
public function enqueue_ces_survey_for_search( $search_area, $page_now, $admin_page ) {
if ( $this->has_been_shown( self::SEARCH_ACTION_NAME ) ) {
$this->enqueue_to_ces_tracks(
'action' => self::SEARCH_ACTION_NAME,
'How easy was it to use search?',
'The search feature in WooCommerce is easy to use.',
'The search\'s functionality meets my needs.',
'onsubmit_label' => $this->onsubmit_label,
'adminpage' => $admin_page,
'props' => (object) array(
'search_area' => $search_area,
* Hook into the post status lifecycle, to detect relevant user actions
* that we want to survey about.
* @param string $new_status The new status.
* @param string $old_status The old status.
* @param Post $post The post.
public function run_on_transition_post_status(
if ( 'product' === $post->post_type ) {
$this->maybe_enqueue_ces_survey_for_product( $new_status, $old_status );
} elseif ( 'shop_order' === $post->post_type ) {
$this->enqueue_ces_survey_for_edited_shop_order();
* Maybe enqueue the CES survey, if product is being added or edited.
* @param string $new_status The new status.
* @param string $old_status The old status.
private function maybe_enqueue_ces_survey_for_product(
if ( 'publish' !== $new_status ) {
if ( 'publish' !== $old_status ) {
$this->enqueue_ces_survey_for_new_product();
$this->enqueue_ces_survey_for_edited_product();
* Enqueue the CES survey trigger for a new product.
private function enqueue_ces_survey_for_new_product() {
if ( $this->has_been_shown( self::PRODUCT_ADD_PUBLISH_ACTION_NAME ) ) {
$this->enqueue_to_ces_tracks(
'action' => self::PRODUCT_ADD_PUBLISH_ACTION_NAME,
'🎉 Congrats on adding your first product!',
'The product creation screen is easy to use.',
'The product creation screen\'s functionality meets my needs.',
'onsubmit_label' => $this->onsubmit_label,
'adminpage' => 'post-php',
'product_count' => $this->get_product_count(),
* Enqueue the CES survey trigger for an existing product.
private function enqueue_ces_survey_for_edited_product() {
if ( $this->has_been_shown( self::PRODUCT_UPDATE_ACTION_NAME ) ) {
$this->enqueue_to_ces_tracks(
'action' => self::PRODUCT_UPDATE_ACTION_NAME,
'How easy was it to edit your product?',
'The product update process is easy to complete.',
'The product update process meets my needs.',
'onsubmit_label' => $this->onsubmit_label,
'adminpage' => 'post-php',
'product_count' => $this->get_product_count(),
* Enqueue the CES survey trigger for an existing shop order.
private function enqueue_ces_survey_for_edited_shop_order() {
if ( $this->has_been_shown( self::SHOP_ORDER_UPDATE_ACTION_NAME ) ) {
$this->enqueue_to_ces_tracks(
'action' => self::SHOP_ORDER_UPDATE_ACTION_NAME,
'How easy was it to update an order?',
'The order details screen is easy to use.',
'The order details screen\'s functionality meets my needs.',
'onsubmit_label' => $this->onsubmit_label,
'pagenow' => 'shop_order',
'adminpage' => 'post-php',
'order_count' => $this->get_shop_order_count(),
* Maybe clear the CES tracks queue, executed on every page load. If the
* clear option is set it clears the queue. In practice, this executes a
* page load after the queued CES tracks are displayed on the client, which
public function maybe_clear_ces_tracks_queue() {
$clear_ces_tracks_queue_for_page = get_option(
self::CLEAR_CES_TRACKS_QUEUE_FOR_PAGE_OPTION_NAME,
if ( ! $clear_ces_tracks_queue_for_page ) {
self::CES_TRACKS_QUEUE_OPTION_NAME,
$queue = is_array( $queue ) ? $queue : array();
$remaining_items = array_filter(
function ( $item ) use ( $clear_ces_tracks_queue_for_page ) {
return $clear_ces_tracks_queue_for_page['pagenow'] !== $item['pagenow']
|| $clear_ces_tracks_queue_for_page['adminpage'] !== $item['adminpage'];
self::CES_TRACKS_QUEUE_OPTION_NAME,
array_values( $remaining_items )
update_option( self::CLEAR_CES_TRACKS_QUEUE_FOR_PAGE_OPTION_NAME, false );
* Appends a script to footer to trigger CES on adding product categories.
public function add_script_track_product_categories() {
if ( $this->has_been_shown( self::ADD_PRODUCT_CATEGORIES_ACTION_NAME ) ) {
$this->get_script_track_edit_php(
self::ADD_PRODUCT_CATEGORIES_ACTION_NAME,
__( 'How easy was it to add product category?', 'woocommerce' ),
__( 'The product category details screen is easy to use.', 'woocommerce' ),
__( "The product category details screen's functionality meets my needs.", 'woocommerce' )
* Appends a script to footer to trigger CES on adding product tags.
public function add_script_track_product_tags() {
if ( $this->has_been_shown( self::ADD_PRODUCT_TAGS_ACTION_NAME ) ) {
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
