Blog

Custom Data in WooCommerce Order

I work with WooCommerce plugin and I work on customizing it. The one thing I have observed on various discussions forums and Q&A forums repeatedly is that adding custom data to the WooCommerce order is always a point of contention.

However, these discussions are so specific to a certain step in the process that the entire picture is never made clear to the readers.

So, I am writing this post to help you accomplish your goal in 6 simple steps and believe me the task is not as daunting as it seems. I am confident that by the end of the post adding custom data to WooCommerce session should not be a hassle for you ever again.

(Heads up: Here I shall be talking about how to add custom data to WooCommerce order prior to WooCommerce v3.0. For version 3.0 and above, find the solution here!)

To make it easy for you to understand, I will be using a use case scenario. Nevertheless, you can apply the solution for whatever your requirement may be. So here’s what I had to do.

‘User input was required in a custom video template design site. The user adds this data and then clicks ‘Add to Cart’. This user input should then be displayed in the cart and checkout page. To achieve this objective I had to add the user’s custom data to a WooCommerce session.’

Product Page

Adding Custom Data to a WooCommerce Order

Step 1: Add Data in a Custom Session, on ‘Add to Cart’ Button Click

For those of you who have worked with WooCommerce might know that on the click of the ‘Add to Cart’ button the product page gets refreshed and the user data is lost. Hence, we should add the custom data from our product page to a custom session created using Ajax. This code is invoked before the WooCommerce session is created.

<?php
add_action('wp_ajax_wdm_add_user_custom_data_options', 'wdm_add_user_custom_data_options_callback');
add_action('wp_ajax_nopriv_wdm_add_user_custom_data_options', 'wdm_add_user_custom_data_options_callback');

function wdm_add_user_custom_data_options_callback()
{
      //Custom data - Sent Via AJAX post method
      $product_id = $_POST['id']; //This is product ID
      $user_custom_data_values =  $_POST['user_data']; //This is User custom value sent via AJAX
      session_start();
      $_SESSION['wdm_user_custom_data'] = $user_custom_data_values;
      die();
}

Step 2: Add Custom Data in WooCommerce Session

At this step, the WooCommerce session has been created and is now available for us to add our custom data. We use the following code to add the custom data from the session we have created into the WooCommerce session. At this step, our session is also unset since the data in it has been captured and it is not needed anymore.

add_filter('woocommerce_add_cart_item_data','wdm_add_item_data',1,2);
 
if(!function_exists('wdm_add_item_data'))
{
    function wdm_add_item_data($cart_item_data,$product_id)
    {
        /*Here, We are adding item in WooCommerce session with, wdm_user_custom_data_value name*/
        global $woocommerce;
        session_start();    
        if (isset($_SESSION['wdm_user_custom_data'])) {
            $option = $_SESSION['wdm_user_custom_data'];       
            $new_value = array('wdm_user_custom_data_value' => $option);
        }
        if(empty($option))
            return $cart_item_data;
        else
        {    
            if(empty($cart_item_data))
                return $new_value;
            else
                return array_merge($cart_item_data,$new_value);
        }
        unset($_SESSION['wdm_user_custom_data']); 
        //Unset our custom session variable, as it is no longer needed.
    }
}

Step 3: Extract Custom Data from WooCommerce Session and Insert it into Cart Object

At this stage, we have default product details along with the custom data in the WooCommerce session. The default data gets added to the cart object owing to the functionality provided by the plugin. However, we need to explicitly extract the custom data from the WooCommerce session and insert it into the cart object. This can be implemented with the following code.

add_filter('woocommerce_get_cart_item_from_session', 'wdm_get_cart_items_from_session', 1, 3 );
if(!function_exists('wdm_get_cart_items_from_session'))
{
    function wdm_get_cart_items_from_session($item,$values,$key)
    {
        if (array_key_exists( 'wdm_user_custom_data_value', $values ) )
        {
        $item['wdm_user_custom_data_value'] = $values['wdm_user_custom_data_value'];
        }       
        return $item;
    }
}

Step 4: Display User Custom Data on Cart and Checkout page

Now that we have our custom data in the cart object all we need to do now is to display this data in the Cart and the Checkout page. This is how your cart page should look after the custom data has been added from the WooCommerce session to your Cart.

Cart Page

add_filter('woocommerce_checkout_cart_item_quantity','wdm_add_user_custom_option_from_session_into_cart',1,3);  
add_filter('woocommerce_cart_item_price','wdm_add_user_custom_option_from_session_into_cart',1,3);
if(!function_exists('wdm_add_user_custom_option_from_session_into_cart'))
{
 function wdm_add_user_custom_option_from_session_into_cart($product_name, $values, $cart_item_key )
    {
        /*code to add custom data on Cart & checkout Page*/    
        if(count($values['wdm_user_custom_data_value']) > 0)
        {
            $return_string = $product_name . "</a><dl class='variation'>";
            $return_string .= "<table class='wdm_options_table' id='" . $values['product_id'] . "'>";
            $return_string .= "<tr><td>" . $values['wdm_user_custom_data_value'] . "</td></tr>";
            $return_string .= "</table></dl>"; 
            return $return_string;
        }
        else
        {
            return $product_name;
        }
    }
}

Step 5: Add Custom Data as Metadata to the Order Items

One more additional step that needs to be done is to add the custom data as metadata to the order items. This metadata will then be displayed in the orders section of WooCommerce for your reference. It will also be used in the confirmation email that is sent to the user after a payment is made. This metadata can be incorporated into the order using the following code.

add_action('woocommerce_add_order_item_meta','wdm_add_values_to_order_item_meta',1,2);
if(!function_exists('wdm_add_values_to_order_item_meta'))
{
  function wdm_add_values_to_order_item_meta($item_id, $values)
  {
        global $woocommerce,$wpdb;
        $user_custom_values = $values['wdm_user_custom_data_value'];
        if(!empty($user_custom_values))
        {
            wc_add_order_item_meta($item_id,'wdm_user_custom_data',$user_custom_values);  
        }
  }
}

Step 6: Remove User Custom Data, if Product is Removed from Cart

Beware though! Your work does not end here. Let us assume now that instead of proceeding to the payment section the user deletes an item from the cart…then what? You don’t want the custom data lingering around in your WooCommerce session. So to avoid such a scenario we’ll write some code below to remove the custom data from the WooCommerce session.

add_action('woocommerce_before_cart_item_quantity_zero','wdm_remove_user_custom_data_options_from_cart',1,1);
if(!function_exists('wdm_remove_user_custom_data_options_from_cart'))
{
    function wdm_remove_user_custom_data_options_from_cart($cart_item_key)
    {
        global $woocommerce;
        // Get cart
        $cart = $woocommerce->cart->get_cart();
        // For each item in cart, if item is upsell of deleted product, delete it
        foreach( $cart as $key => $values)
        {
        if ( $values['wdm_user_custom_data_value'] == $cart_item_key )
            unset( $woocommerce->cart->cart_contents[ $key ] );
        }
    }
}
?>

With that last piece of code, we are now good to go! If you follow all the above steps properly you should be able to add the custom data to the WooCommerce with ease. However, if you are still having difficulties you can revert to me with your queries. And, let me know your views on the post in the comment section.

Note:  This code is compatible only with the versions of WooCommerce prior to 3.0.

Copyright :  wisdmlabs