Back to Top

Adding additional variables in window.checkoutConfig on Magento 2 Checkout page

Updated 3 January 2023

We often need to add more variables that we need to use on the checkout page at the time of checkout. Here is how we can do that.

The first step is to add the following code in Vendor/Module/etc/frontend/di.xml of your custom module –

<?xml version="1.0"?>
<config xmlns:xsi=""
   <type name="Magento\Checkout\Model\CompositeConfigProvider">
           <argument name="configProviders" xsi:type="array">
               <item name="additional_provider" xsi:type="object">Webkul\Test\Model\AdditionalConfigVars</item>

After this, we will create AdditionalConfigVars.php in Vendor/Module/Model and add the following code to it –


namespace Webkul\Test\Model;

use \Magento\Checkout\Model\ConfigProviderInterface;

class AdditionalConfigVars implements ConfigProviderInterface
   public function getConfig()
       $additionalVariables['test_var'] = 'Test Var';
       return $additionalVariables;

Now all you need to do is flush Magento cache and check  ‘window.checkoutConfig.test_var’ in your js on the checkout page. It will return ‘Test Var’.

This is all for now.

Searching for an experienced
Magento 2 Company ?
Find out More

Suggestions and queries are welcome.

. . .

Leave a Comment

Your email address will not be published. Required fields are marked*


  • Sanne
    • Vinay Singh (Moderator)
  • Back to Top

    Message Sent!

    If you have more details or questions, you can reply to the received confirmation email.

    Back to Home