Page Cache Ultimate

These fake users are created by Page Cache Ultimate to anonymize the cache (new method). You must not delete them (they will be created again).

There will not have a lot of these fake users, probably less than 5, it depends on the number of groups and the differences in display between them.

They are not active so they will not disturb your statistics.

If you have an Anvato theme, here is what to do to avoid the cart to open each time it is refreshed.

Copy the file /modules/an_theme/views/js/sidebarcart.js in your theme so you can continue to update it without loosing modifications, in /themes/<your_theme>/modules/an_theme/views/js (create folders if needed)

In this file, replace the ligne:

if (prestashop.page.page_name != 'cart' && prestashop.page.page_name != 'checkout') {

By

if (prestashop.page.page_name != 'cart' && prestashop.page.page_name != 'checkout' && requestData.action!='refresh') {

Then clear the cache in Performances page and the cache of your browser so you can test.

If your theme uses the tag "widgetblock" as Warehouse theme does, then you need to clear the cache in Performances page after you enable Page Cache so the template is compiled again.

All our modules can run on LiteSpeed Web Server since it supports the Apache .htaccess file.

However, the HTML cache feature (Page Cache Ultimate) is not compatible with the LiteSpeed Cache Plugin since they are both working on the same layer of cache.

Which one should you choose?

LiteSpeed Cache is a generic cache which does not handle all different contexts of Prestashop. Which taxes are applied? Is there a flash sale comming up? Should I display a different content for this user because he belongs to a specific user group? Did this visitor accept cookies? etc.

Page Cache Ultimate has been created for Prestashop and it is only dedicated to this platform, it handles all different contexts and can also upgrade fast if a new Prestashop feature is out.

If you are using the PageSpeed Apache module developped by Google (x-mod-pagespeed) then you must disable the following option so it does not override the browser cache directives added by Page Cache:

<IfModule pagespeed_module>
ModPagespeedModifyCachingHeaders off
</IfModule>

No, it is highly recommended to keep the Smarty cache enabled. This will speed up pages that are not cached and also pages where the cache is not yet generated.

To get your styles back you just need to clear the cache of "Page Cache Ultimate".

To avoid this issue you can go in "Advanced mode", in the configuration of "Page Cache Ultimate", then in "Cache key" enable "Insert CSS and JS version in cache key".

To avoid the cookie notice to appear 1 second, then disappear, you must override the javascript file of the iqitcookielaw module.

To do it, create a file with the following content:

$(document).ready(function () {
 if (getCookie('cookielaw_module') != 1) {
  $("#iqitcookielaw").addClass('iqitcookielaw-showed');
 }
 $("#iqitcookielaw-accept").click(function (event) {
  event.preventDefault();
  $("#iqitcookielaw").removeClass('iqitcookielaw-showed');
  setcook();
 });
});

function setcook() {
 var name = 'cookielaw_module';
 var value = '1';
 var today = new Date();
 var expire = new Date();
 expire.setTime(today.getTime() + 3600000 * 24 * 14);
 document.cookie = name + "=" + escape(value) + ";path=/;" + ((expire == null) ? "" : ("; expires=" + expire.toGMTString()))
}

function getCookie(cname) {
 var name = cname + "=";
 var ca = document.cookie.split(';');
 for (var i = 0; i != ca.length; i++) {
  var c = ca[i];
  while (c.charAt(0) == ' ') c = c.substring(1);
  if (c.indexOf(name) != -1) return c.substring(name.length, c.length);
 }
 return "";
}

And place it in the theme (or child theme if you have one): /themes/warehouse/modules/iqitcookielaw/views/js/front.js

Then clear the cache in the Performances page.

When the cache is created, the page is anonymized, that means it is displayed without any information about the visitor displaying the page.

Modules that display content relative to the current visitor can be marked as dynamic, that means the content will be refreshed (replaced) by a background request (Ajax) in the browser that will carry the context of the current visitor.

If you check the option "Display nothing in cache" then the module will not be called to display its content in this hook during the creation of the cache. However, the content will be displayed as other dynamic modules (with a background request (Ajax)).

If the products list is reloaded each time you display a page with a products list then you can fix this by modifying the file /warehouse/modules/ps_shoppingcart/ps_shoppingcart.js as follow:

Replace this line:

prestashop.emit('updateFacets', window.location.href);

By:

if (event.reason && event.reason.linkAction != 'refresh') {
    prestashop.emit('updateFacets', window.location.href);
}

Update your "Cookies - GDPR Cookie law (block before consent)" module to version 1.5.6 minimum.

Update "Page Cache Ultimate" to version 7.9.39 minimum for full compatibility with the cookiesplus module.

For Prestashop 1.7

1. Disable the 2 modules (this also works if they are not yet installed)
2. In the file /modules/cookiesplus/override_17/classes/Hook.php rename the coreCallHook function to coreCallHook_off and the coreRenderWidget function to coreRenderWidget_off (in fact, Page Cache Ultimate will execute the appropriate processing if the cookiesplus module is activated).
3. You can reactivate (or install) the 2 modules.

In the configuration of the shopping cart, in section "Add to Cart Action", disable the option "Open the cart".

This is normal, when the cache is not available the display is as slow as without the cache.

You should only empty the cache when necessary (CSS or Javascript modification, for templates choose the option "Recompile template files if they have been updated" in the "Performance" page).

If the currency selection list does not work anymore, check these 2 options:

The option "Ignore URLs matching this regex" must include ".*SubmitCurrency=1.*", e.g. ".*[\?&]q=.*|.*SubmitCurrency=1.*"

The option "Ignored URL parameters" should not include "submitcurrency,id_currency"

You may also want to disable the browser cache, because if the visitor changes the currency after displaying several pages, if they return to these pages, the original currency will be displayed.

Don't forget to clear the module and browser cache after these changes.

When you modify a product, a category, a CMS page, a price, the stock, etc. the cache is automatically refreshed.

When you add, delete or modify a module, then you need to clear the cache manually because this cannot be automatically detected. For exemple, when you modify the slider of the home page.

When you modify the CSS or a template of your theme, then you need to clear the cache manually because this cannot be automatically detected.

When you synchronize or modify your catalog, your prices and/or your stocks using an external application, you will probably need to clear the cache manually or with a script because hooks of Prestashop are not executed.

To clear the cache of specific pages, you can use the CRON/API URLs that you will find in the "API" menu in the configuration of Page Cache Ultimate. You can also use the statistics table to filter pages that you want to refresh, then click on button "Clear cache (only files)".

Also be aware that the browser cache cannot be cleared, this is why it is limited in time.

This happens because the sign in link is loaded dynamically and so the "back" parameter which referers to the current URL is set with the URL of the dynamic modules.

To avoid this problem, go in the configuration of Page Cache Ultimate, in menu "Dynamic modules and widgets", at the bottom add the following javascript code to the field "Javascript to execute":

if (!prestashop_pc.customer.is_logged) {
  $('header a').each(function() {
    $(this).attr('href').replace('ajax%3Dtrue', '').replace('page_cache_dynamics_mods%3D=1', '')
  });
}

Clear the cache and it should fix the problem.

​These directories are created when the cache cannot be fully deleted in PHP because it's too long and will failed with a timed out error. So instead of deleting the cache directory, it is simply renamed with this suffix.

You can delete all these directories with suffix please_delete_me but I recommend to do it directly in a server console because it will be too long to do it by FTP.

These hooks are for developers of modules, contact the support if you need help.

Here is an exemple of how to implement the hooks' functions:

    /**
     * Called each time a page is displayed so this must remain very fast!
     * @param $params Empty array
     * @return mixed The datas you will need in hookActionJPrestaRestoreSpecificCacheKeyInfos()
     */
    public function hookActionJPrestaGetSpecificCacheKeyInfos($params) {
        // Let's say that the cookie 'test' modify the content of the page, we indicates to the cache manager
        // to generate a cache key that depends on the value of this cookie
        return $_COOKIE['test'];
    }

    /**
     * This function is called by Page Cache Ultimate when the cache-warmer service want to generate the cache of a
     * specific context. In this case we must restore the context so the content is the good one.
     * @param $params $params['specifics'] contains the datas returned by the hook 'ActionJPrestaGetSpecificCacheKeyInfos'
     */
    public function hookActionJPrestaRestoreSpecificCacheKeyInfos($params)
    {
        // Here we will just modify the $_COOKIE value, we don't need to send the cookie to the browser with function
        // setcookie, we just want the remaining PHP code to execute to get the correct value of the cookie.
        $_COOKIE['test'] = $params['specifics'];
    }

The Creative Elements module allows you to edit parts of your store with links/buttons displayed directly on your shop when you are logged into your Prestashop admin. To preserve this functionality, the cache is deactivated with the reason "editing-with-creative-element". Rest assured, your visitors do benefit from the cache, it's only users connected to the admin who have no cache. To get the cache, simply display the store in a private tab of your browser.

The first thing to do is to make sure you have the latest version of the module, as I'm constantly improving it to reduce memory consumption, both on the database side and on the hard disk.

The second thing is to run a purge periodically (every 2 or 3 days). A purge removes the cache of pages that no longer exist or whose context no longer exists. This does not affect cache performance. You can perform a purge manually via a button under the cache statistics table, or by scheduling a CRON task with the URL displayed in the "API (CRON URLs)" menu of the module configuration.

Finally, if there are directories in /var/cache/pagecache ending in "please_delete_me", you can delete them. These are old caches that PHP was unable to delete completely (too long).

When you try to install Page Cache Ultimate you get the error message "This file does not appear to be a valid module .zip file"? This is normal, as the zip file contains several zips that allow you to install this module depending on your Prestashop version: PS-1.5/1.6, PS1.7/8 and Thirtybees.

You'll need to extract and install the appropriate zip for your store.

Static caching can only be used if the visitor's context is known. The context contains a great deal of information that cannot be deduced from the URL alone: currency, user groups, choice of cookies, taxes to be applied, etc. This context is stored in a cookie called "jpresta_cache_context".

This context is stored in a cookie named "jpresta_cache_context", which is added when the user displays a 1st page. Once the cookie is present, the static cache can be used.

Go in the configuration of the module, in menu "Caching system" make sure "Prestashop Static!" is selected. If it is already selected, then select "Standard file system" and save, after that select "Prestashop Static!" and save again. This will reactivate the static cache.

The "customer-specific-prices" message means that you're connected to a user who has specific pricing rules, so there's no need to create a cache as only he will be able to benefit from them. It's better to create groups of users and create pricing rules for these groups.

Perhaps you're simulating a phone screen using the console of your browser, which explains why you're seeing this mobile view despite having a desktop screen.

This occurs because a cookie called 'jpresta_cache_context' stores the visitor's context in the browser. This context includes information about whether the view is 'mobile' or 'desktop'. Therefore, if you initially view pages in desktop mode and then switch to mobile mode, the cache will continue to deliver the desktop view.

If you wish to test the mobile view using the console of your browser, ensure you delete the 'jpresta_cache_context' cookie beforehand.

If you are using the module "Google Tag Manager Enhanced Ecommerce" created by "Comptoir du code" then make sure to get the latest version of the module and enable the specific option for use with full page cache modules.

In any case you don't need to mark Google Tag Manager modules as dynamic.

When you validate the configuration steps, make sure to run the auto-configuration at step 4. This configures the Page Cache Ultimate module for all known modules like the shopping cart. You should rely on this auto-configuration and only do manual modifications when something does not work as usual when the cache is enabled.

The score calculated by Pagespeed and GTMetrix include a very large number of parameters whose importance varies depending on whether you are on a mobile phone or a computer.

The Prestashop Speed Pack module allows you to correct the following points reported by Pagespeed Insight or GT Metrix:

• Reduce server response times/TTFB  (Page Cache Ultimate)
• Serving images in next-generation formats (WEBP compression of images)
• Defer off-screen images (lazy loading of images)

Other parameters like the LCP cannot be corrected by a module. For example, this LCP indicates the display delay of the largest element displayed first; it is often degraded by the use of a carousel which displays images using a lazy-loading system or because the javascript code which initializes it is too slow. This kind of problem can only be fixed manually.

Also, to be sure that the score calculation was done with an available cache, run it twice.

I invite you to read my article Understand and improve the Pagespeed score of your Prestashop store  

A page can have multiple cache versions depending on the context of the visitor. This context includes information such as the selected currency, the user's group, the visitor's preferences concerning cookies, applicable tax rules for the visitor, the visitor's country if relevant, and more. Therefore, you might not receive a cached page when you display a page because your context is different.

Modules like "Creative Slider" use short codes to make it easy to display contents. This is usually done in the hook "actionOutputHTMLBefore" so just make sure that the cache module is placed after all modules in this hook. Go in "Design" > "Positions", check the option "Display non-positionable hooks", search for the hook "actionOutputHTMLBefore" and move Page Cache Ultimate or Speed Pack module to the end.

​Once done you need to clear the cache.

This error is due to a new security restriction implemented by my hosting provider (OVH) on all their servers.

To resolve it, you need to upgrade my modules to the latest version.

You won’t be able to do this using the JPresta Easy Upgrade module, as it also requires an update.

To perform the upgrade, go through the Addons or download the zip file from your JPresta account. For Page Cache Ultimate and Speed Pack, you’ll need to extract the zip to find the one that matches your PrestaShop version. Once you have the correct zip file, install it as a new module to upgrade your current version while preserving the configuration.

Don’t worry, after this, you’ll be able to continue upgrading with JPresta Easy Upgrade as usual.

To avoid caching certain pages in your store, you can use a regular expression.

Go to the module configuration, click on "Advanced mode" and then on "Options". You'll find a "Ignore URLs by regular expression" field. This field is pre-filled by default with the following regular expression:

.*[\?&]q=.*|.*SubmitCurrency=1.*

With this regular expression, the module will exclude all searches from the cache (using the "q" parameter) as this is not efficient, since the number of identical searches is very low. It will also deactivate the cache when a currency change occurs.

To add a page to exclude, you can add another expression with a "|" character after it. For example, if you want to exclude the page https://shop.com/85-foo :

.*[\?&]q=.*|.*SubmitCurrency=1.*|.*85-foo.*

For more information on regular expressions, please consult this documentation: https://www.php.net/manual/en/reference.pcre.pattern.syntax.php

To test your regular expression, use this tool: https://regex101.com/

When the cache is enabled, the JavaScript (JS) variable "prestashop" does not contain information about the current visitor/customer. Indeed, the cache is anonymized.

You need to wait until the dynamic modules are refreshed for this information to become available.

Here is a script that will allow you to access the information as soon as it is available:

if (typeof jprestaGetCacheType == 'function') {
    // jprestaDynamicContentLoaded will be triggered
    prestashop.on('jprestaDynamicContentLoaded', function() {
        // Here, the variable 'prestashop_pc' can be used like the variable 'prestashop'
        // Everything defined in Media::addJsDef is also updated
        console.log('The jprestaDynamicContentLoaded event has been triggered and received');
        if (prestashop_pc.customer.is_logged) {
            console.log('Customer ' + prestashop_pc.customer.email + ' is logged in.');
        } else {
            console.log('No customer is logged in.');
        }
    });
} else {
    // Normal processing, no cache
    // jprestaDynamicContentLoaded will not be triggered
    console.log('This page is not cached');
    if (prestashop.customer.is_logged) {
        console.log('Customer ' + prestashop.customer.email + ' is logged in.');
    } else {
        console.log('No customer is logged in.');
    }
}

This warning occurs when the module detects that the shop has been duplicated, typically for testing purposes. While this is perfectly allowed, it can interfere with the cache warmer service. To prevent any issues, you need to confirm whether this PrestaShop instance is a clone. This allows the module to correctly apply the license and cache warmer subscription.  

Go in the configuration of the module, in the "License" menu

• If this is a copy of another PrestaShop instance, click "Yes, it is a clone"
• If it is the same PrestaShop instance, click "No, it is the same PrestaShop"

For your information, the detection is primarily based on database information.

Technically yes, but in practice you need an "Enterprise" subscription — the one without a listed price, so probably over €2400/month at the time of writing.

Indeed, you need to be able to configure the cache key, and that’s only possible with an "Enterprise" plan. If you have one, feel free to contact me — I can help you set up the cache rules.