Documentation

Table of Contents

Cookie Solution – PrestaShop Plugin Installation Guide

The PrestaShop plugin by iubenda allows you to automate the implementation of the cookie law rules, drastically reducing the necessity for direct interventions in the site’s code.

Caution
  • The module is currently compatible with all versions of Prestashop starting from 1.7
  • You also need to have overrides enabled (enabled by default)
iubenda Cookie Solution for PrestaShop

Functionality

  • The plugin automatically adds the iubenda code to all the pages of a site (to the HEAD section);
  • Manages the visualization of the banner and of the cookie policy, as well as the saving of user’s consent preferences as per cookie installation;
  • Simplifies the management of the iubenda Cookie Solution for multilingual sites.
  • AdRoll
  • AddThis widgets
  • Bing
  • CodePen
  • Criteo
  • Disqus
  • Elevio
  • Facebook Comments
  • Facebook widgets
  • Freshchat
  • Google AdSense
  • Google Analytics
  • Google Maps
  • Google ReCaptcha
  • Google Site Search
  • Google Tag Manager
  • Google oAuth
  • Google+ widgets
  • Headway
  • Instagram widgets
  • Kissmetrics
  • LinkedIn widgets
  • Mixpanel
  • Neodata
  • Olark
  • Optimizely
  • Outbrain
  • PayPal widgets
  • Pingdom
  • Pinterest widgets
  • Segment
  • ShareThis widgets
  • Twitter widgets
  • UserVoice
  • Vimeo
  • YouTube

Instructions

Installation and activation

  • Log in and open the admin section to get to your main PrestaShop dashboard;
  • Click on Modules > Modules & Services in the sidebar menu;
  • Click on Upload a module in the header section;
  • To install the module upload the “iubenda_cookie_prestashop_plugin.zip” file (click here to download) – you must point to the module’s zip archive, and not its folder or any of its unpacked files.

If the installation is successful, you’ll get this message:

PrestaShop plugin by iubenda

The module will then appear in your list of modules under “Modules & Services”.

Now it’s time to go configure the settings of the module.

How to add the cookie banner and modify settings

Now that the module is ready, we need to feed it the necessary information from your iubenda account.

  • If you haven’t clicked on the Configure button inside the “Module installed!” pop-up message, navigate to the Modules & Services page and find the iubenda module: PrestaShop plugin by iubenda
  • Click on Configure to go to the module configuration settings.
  • Add the code from your iubenda account to the extension (this is what the embedding code looks like in your iubenda dashboard): Embed Cookie Solution (If you haven’t already generated your cookie banner and code, you can do so here or for in-depth information, you can read the introduction to the iubenda Cookie Solution guide. )
  • Paste that code into the plugin form and save: PrestaShop plugin by iubenda (Being PHP native, we recommend the primary, faster option for the parsing engine. If you’re experiencing some issues, try with the alternative based on a custom HTML DOM class)

Use

Once configured, the plugin will begin to show the banner on which your cookie policy will be shown/linked to users that visit your site for the first time without the need for any other further configurations. The plugin will also recognize and automatically detect and block the cookies indicated in the above block-list, that are present on your site.

Important

Our PrestaShop extension automatically blocks scripts that are generated on the server side (therefore returned by PHP by PrestaShop). Scripts that are inserted into the page via JavaScript after the loading process of that page are not and cannot be blocked automatically.

These scripts can be blocked by entering the source into the Custom Script boxes in the plugin console or by using the manual wrapping method illustrated in the example below and (in more detail) in this help post

Blocking custom scripts from within the console

The Custom Scripts field makes it easy for you to block scripts inserted into the page directly from within the plugin console. This greatly reduces the need for direct edits to the site’s code.

Here’s how to do it:

  • On the left menu in your admin panel, go to the Improve section and click Extensions > Plugins.
  • Next, search “iubenda”, and when the plugin appears, click on the Configure button.
  • Scroll down to find the Custom scripts and Custom iframes fields at the bottom of the page.PrestaShop custom and iframe scripts fields
  • Enter your script or iframe sources as needed, and click the Save button at the bottom-right of the page.

Usage Examples

Using these fields are pretty straightforward. Simply enter the script or iframe src attribute you’d like to block.

Script

If you wanted to block a social button (which inserts scripts into the page via JavaScript), you’d simply need to enter the script source, e.g. connect.socialwebsite.net/en_US/track.js into the scripts field.

iframe

Let’s say you wanted to block scripts inserted into the page via the following iframe

<iframe width="1280" height="720" src="https://www.videowebsite.com/embed/xxFhMChxx" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> 

What you’ll need to enter into the iframe field would be videowebsite.com/embed/ as this is the actual source of the scripts. Be careful NOT to enter the component id (videowebsite.com/embed/xxFhMChxx) to ensure that all scripts coming from the actual source are blocked.

Manual Use (wrapping method)

This method requires you to directly modify your site’s code. You’ll need to go into the relevant section of your site’s code and add the scripts to be blocked as explained below.

Here’s an example of how to make the plugin manually work for a Social button (which inserts scripts into the page via JavaScript).

<!--IUB-COOKIE-BLOCK-START-->
<script>
    (function(d, s, id) {
        var js, fjs = d.getElementsByTagName(s)[0];
        if (d.getElementById(id)) return;
        js = d.createElement(s);
        js.id = id;
        js.src = "//connect.socialwebsite.net/en_US/sdk.js#xfbml=1&version=v2.3&appId=808061959224601";
        fjs.parentNode.insertBefore(js, fjs);
    }(document, 'script', 'socialwebsite-jssdk'));
</script>
<!--IUB-COOKIE-BLOCK-END-->

If there are HTML / IMG / IFRAME elements, you will need to do it this way:

<!--IUB-COOKIE-BLOCK-START-->
      <iframe src="...
      <img src="...
<!--IUB-COOKIE-BLOCK-END-->

Further information

For API calls and xmlrpc we suggest the parameter ?iub_no_parse=1.

1.0.7

Tweak: Adjust the iubenda PHP class handling
Tweak: Update iubenda logo

1.0.6

New: Option to block custom scripts and iframes
Tweak: Update and extend the list of blocked scripts including Google Site Search, Google oAuth, LinkedIn widgets, PayPal widgets, Freshchat, UserVoice, AdRoll, Olark, Segment, Kissmetrics, Mixpanel, Pingdom, Bing and Elevio

1.0.5

Tweak: Update and extend the list of blocked scripts including Pinterest, AddThis, Disqus, Optimizely, Neodata, Criteo, Outbrain, Headway and CodePen
Tweak: Interface improvements

1.0.4

Fix: Invalid iubenda parser implementation

1.0.3

Tweak: Update and unify iubenda parsing engine

1.0.2

Fix: Eage output empty if script blocking disabled

1.0.1

Tweak: iubenda faster class regex update

1.0

Initial release

See also

Still have questions?

Visit our support forum Email us