Customizing PrestaShop v1.7 for use with LSCWP

PrestaShop v1.7 introduces {widget} and {widget_block} elements that can be used in Smarty templates directly.

If the widget is to be cached differently than the page on which it appears, it will need to be defined as an ESI block. Currently, this can not be automated. You will have to manually place LSCache hooks to mark the beginning and the end of each ESI block in the template. LSCache relies on these hooks to trigger the ESI injection.

Note: The Cart (ps_shoppingcart) and Login (ps_customersignin) blocks already have hooks defined in the default “classic” template so there is no need to change template files for those particular blocks in that particular template. If ps_shoppingcart and ps_customersignin are not triggered through hooks, but through {widget} or {widget_block}, you will have to manually update the template file.

Surround {widget name=“ps_customersignin”} with ESI hooks like so:

{hook h="litespeedEsiBegin" m="ps_customersignin" field="widget"}{widget name="ps_customersignin"}{hook h="litespeedEsiEnd"}

If the widget also includes a hook parameter, you need to include that in litespeedEsiBegin as well. For example, {widget name=“module_name” hook=”specific_hook”}

will change to

{hook h="litespeedEsiBegin" m="module_name" field="widget" hook=”specific_hook”}{widget name="module_name"}{hook h="litespeedEsiEnd"}

For {widget_block}, if there’s any html code, that will need to be put aside into a template file:

{widget_block name=”module_name”}
Smarty / html
{/widget_block}

----LEFT OFF HERE----

If we want to hole punch this part, and later on to regenerate the content through ESI request, we need to place ESI beginning and ending markers around and put all the smarty/html in a template file. So it will look like {hook h=“litespeedEsiBegin” m=“module_name” field=“widget_block” tpl=“template_path.tpl”}{widget_block name=”module_name”} Smarty / html {/widget_block}{hook h=“litespeedEsiEnd”}

The content in “template_path.tpl” needs to be exactly same as Smarty/html part.

Let’s take “wholesale” template as an example. Let’s say the header.tpl use varient 1, the actual header template is {include file='_partials/_variants/header-1.tpl'} For this part

          <div class="col {if $iqitTheme.h_logo_position == 'left'}col-auto{/if} col-header-right text-right">
              {widget_block name="ps_shoppingcart"}
                  {include 'module:ps_shoppingcart/ps_shoppingcart-default.tpl'}
              {/widget_block}
              {widget name="ps_customersignin"}
              {hook h='displayHeaderRight'}
          </div>

Needs to be replaced to

          <div class="col {if $iqitTheme.h_logo_position == 'left'}col-auto{/if} col-header-right text-right">
             {hook h="litespeedEsiBegin" m="ps_shoppingcart" field="widget_block" tpl="module:ps_shoppingcart/ps_shoppingcart-default.tpl"} {widget_block name="ps_shoppingcart"}
                  {include 'module:ps_shoppingcart/ps_shoppingcart-default.tpl'}
              {/widget_block}{hook h="litespeedEsiEnd"}
              {hook h="litespeedEsiBegin" m="ps_customersignin" field="widget"}{widget name="ps_customersignin"}{hook h="litespeedEsiEnd"}
              {hook h='displayHeaderRight'}
          </div>