DEV Community

Elightwalk Technology
Elightwalk Technology

Posted on

How to Create Custom Product Tours in WooCommerce

Giving users a simple and enjoyable experience is crucial in the cutthroat e-commerce market of today. Developers can personalise the product tour with WooCommerce, a well-liked WordPress plugin which improves the user experience when creating products. Using the experimental woocommerce admin product tour steps JavaScript filter. This guest post will walk you through adding a custom product tour to your WooCommerce store.

Before you start customizing, ensure you have a basic understanding of JavaScript and PHP. Your WordPress website must have WooCommerce 8.8 or later installed.

Adding a JavaScript Filter

We will use the @wordpress/hooks package, particularly the addFilter function, to create a customized product tour. With this package, you can add or modify features within the WordPress and WooCommerce ecosystems without having to change the core code.

Step 1: Install @wordpress/hooks
Ensure you have the @wordpress/hooks package installed. You can add it to your project using npm or yarn:

npm install @wordpress/hooks

Enter fullscreen mode Exit fullscreen mode

Step 2: Add Custom JavaScript Code

Add the following JavaScript code to your project. This snippet shows you how to replace the product tour with a customized one:

/**
 * External dependencies
 */
import { addFilter } from '@wordpress/hooks';
import { __ } from '@wordpress/i18n';

addFilter(
   'experimental_woocommerce_admin_product_tour_steps',
   'custom-product',
   (tourSteps, tourType) => {
      if ('custom-product' !== tourType) {
         return tourSteps;
      }

      return [
         {
            referenceElements: {
               desktop: '#title', // The element to highlight
            },
            focusElement: {
               desktop: '#title', // A form element to be focused
            },
            meta: {
               name: 'product-name', // Step name
               heading: __( 'Product name', 'custom-product' ),
               descriptions: {
                  desktop: __(
                     'Start typing your new product name here. This will be what your customers will see in your store.',
                     'custom-product'
                  ),
               },
            },
         },
      ];
   }
);

Enter fullscreen mode Exit fullscreen mode

This filter replaces the entire product tour for a custom-product product. You can use JavaScript array manipulation functions to modify, add, or remove steps from the default tour. The tutorial_type GET parameter specifies the tour type.

Step 3: Customise the Tour Steps

You can modify the tour steps to meet your specific requirements. Here's an example of adding an extra step to the tour:

{
   referenceElements: {
      desktop: '#price', // The element to highlight for the price
   },
   focusElement: {
      desktop: '#price', // A form element to be focused for the price
   },
   meta: {
      name: 'product-price', // Step name
      heading: __( 'Product Price', 'custom-product' ),
      descriptions: {
         desktop: __(
            'Enter the price of your product here. This is the amount your customers will pay.',
            'custom-product'
         ),
      },
   },
},

Enter fullscreen mode Exit fullscreen mode

Repeating this structure will allow you to create a comprehensive and engaging product tour tailored to your store's needs.

In-short

WooCommerce provides a flexible and powerful framework for extending and customizing the product tour, allowing you to provide a more personalized and engaging onboarding experience. You can improve the Add Products tour's relevance and usefulness to your particular requirements by implementing the steps described in this tutorial, which will improve the user experience on your WooCommerce store.

Top comments (0)