Magento 2 Cookie Consent v1.x Configuration

Getting Started

Please check our step-by-step guide to get started with the Cookie Consent extension in minutes.

We recommend the following steps to configure the Cookie Consent extension correctly:

  1. Determine which data protection laws (GDPR, CCPA, LGDP, or others) your store needs to comply with.
  2. Configure the Main Settings of the module.
  3. (Optional) View default Cookie Categories and edit them.
  4. Browse the provided list of Magento cookies and add your own cookie if necessary.
  5. Configure Cookie Consent Banner.
  6. Configure the Cookie Settings Panel.
  7. Enable the extension.
  8. (Optional) Add the “Cookies Settings” link.
  9. (Optional) Configure Google Tag Manager functionality.
  10. (Optional) To block custom scripts’ execution before a customer allows cookies, read our Developers’ Guide.

Configuration

General

Follow the steps below to learn how to configure Magento 2 Cookie Consent v1.x extension correctly.

In the main menu go to the “Plumrocket” tab > select “Cookie Consent” extension > navigate to the “Configuration” section.

Step-by-Step actions:

  1. Enable Extension”: this option allows you to enable or disable this Cookie Consent extension.
  2. “Serial Key”: enter the unique serial key provided to you after purchasing the extension. Note: In most cases, this field will be pre-filled with a serial key automatically, and the green checkmark will be displayed. To find and paste your serial key manually, read the Serial Key Activation article.
magento 2 cookie consent extension configuration 1.png

Main Settings

Step-by-Step actions:

  1. Geo Targeting“: select countries in order to show cookie notice only to visitors from the selected countries.
  2. U.S. States“: you can select one or multiple U.S. states. For example, select “California” to comply with the CCPA law.
  3. Enable Cookies Before Customer Opt-In“: when set to “Yes”, all cookies will be already enabled until the customer accepts or declines them. We recommend enabling this feature for CCPA law, where consent for collecting personal data is not required.
  4. Consent Expiration (days)“: set the number of days when the consent cookies expire. After the expiration date, a customer will be prompted again to accept or decline cookies.
  5. Block Unknown Cookies“: when set to “Yes”, all cookies not listed in the Manage Cookies grid will be blocked until a visitor accepts all cookies.
  6. Reload Page After Accept Button Click“: when set to “Yes”, the website page will reload after a user clicks the “Accept Cookies Button”. This option helps to enable certain javascript and third-party cookies. We recommend setting this option to “Yes” if the “Enable Cookies Before Customer Opt-In” option above is set to “No”.
  7. Reload Page After Decline Button Click“: when set to “Yes”, the website page will reload after a user clicks “Decline Cookies Button”. It helps to disable certain javascript and third-party cookies. We recommend setting this option to “Yes” if the “Enable Cookies Before Customer Opt-In” option above is set to “Yes”.
magento 2 cookie consent extension configuration 2.png

Cookie Consent Banner

Step-by-Step actions:

  1. Display Style“: select the way you want to show the cookie notice to visitors. Select from the Popup, Bottom Banner, or Full-screen Wall. Please note, the option “Full-Screen Cookie Wall,” unlike other options, prevents visitors from using the website until they agree to enable cookies.
  2. Hide On Urls“: you can disable the cookie consent banner on specific pages. Enter each URL in a new line. Both absolute or relative paths are allowed.
  3. Notice Text“: enter the text asking to agree with the cookies that will be displayed on the cookie consent banner.
  4. Title“: enter the title of the text if you selected the Full-Screen Cookie Wall as a cookie consent banner display style above.
magento 2 cookie consent extension configuration 3.png

Step-by-Step actions:

  1. Title Color“: click on the color picker or enter the hex color of the title (this option is available only for the Full-Screen Cookie Wall cookie consent banner style).
  2. Text Color“: select the text color displayed on the cookie consent banner.
  3. Background Color“: select the background color of the banner.
  4. Overlay Background Color“: select an overlay background color (this option is available only for the Full-Screen Cookie Wall cookie consent banner style). Users do not see the content of the website if you select an overlay color in this option.
  5. Overlay Background Blur“: when set to “Yes,” the background will be blurred (this option is available only for the Full-Screen Cookie Wall cookie consent banner style).
magento 2 cookie consent extension configuration 4.png

Accept Button

The cookie notice banner contains Accept, Decline, and Settings buttons. In this section, learn how to configure the appearence of the Accept Button.

Step-by-Step actions:

  1. Label“: enter the name of the accept button here: “Allow Cookies”, “Accept”, etc.
  2. Text Color“: select the Accept Button text color by clicking on the color picker or entering the hex color in the field.
  3. Text Color On Hover“: select the color in which the text changes when hovering the mouse cursor over the button.
  4. Background Color“: select the background color of the accept button.
  5. Background Color On Hover“: select the background color to which the background changes when hovering the mouse cursor over it.
magento 2 cookie consent extension configuration 5.png

Decline Button

In this section, learn how to configure the appearence of the Decline Button.

Step-by-Step actions:

  1. Show“: when set to “Yes”, the decline button is displayed on the cookie consent banner. You are also able to hide this button by setting this option to “No”. Therefore, users will not be able to decline cookies.
  2. Label“: enter the name of the decline button here.
  3. Text Color“: select the Decline Button text color by clicking on the color picker or entering the hex color in the field.
  4. Text Color On Hover“: select the color to which the text changes when hovering the mouse cursor over the button.
  5. Background Color“: select the background color text of the decline button.
  6. Background Color On Hover“: select the color to which the background changes when hovering the mouse cursor over it.
magento 2 cookie consent extension configuration 6.png

Settings Button

In this section, learn how to enable and configure the settings button appearance. The settings button is displayed next to the accept and decline button. By pressing it, users can go to settings, read cookie categories description, and manage their consent preferences.

Step-by-Step actions:

  1. Show“: when set to “Yes, Settings Button is enabled and displayed on the cookie consent banner.
  2. Label“: enter the name of the link.
  3. Type“: select whether the settings option should be displayed as a link or a button.
  4. Link color“: specify the link color if you selected the type above as a link.
  5. Link Color On Hover“: select the color to which the link changes when hovering the mouse cursor over it.
magento 2 cookie consent extension configuration 7.png

Cookie Settings Panel

Learn how to configure the Cookie Settings Panel. Users can go there by clicking the Settings Button.

Step-by-Step actions:

  1. Show Information About Each Cookie“: set to “Yes” to show information about a cookie (domain, type, duration, description, etc.) listed in the Manage Cookies grid. Users can find this information by clicking the Cookie Details button in the Cookie Settings Panel.
  2. Cookie Settings Header“: enter the header of the Cookie Settings Panel here.
  3. Cookie Settings Description“: enter the description text of the Cookie Settings.
  4. Text Color“: select the color of the text.
  5. Background Color“: select the background color of the Cookie Settings Panel.
magento 2 cookie consent extension configuration cookie settings panel.png

Cookie Settings Link

Step-by-Step actions:

  1. Add Footer Link“: set to “Yes” if you want to automatically add the “Cookie Settings” link in the website footer. By clicking on this link, your customers and guest visitors can manage their cookie settings at any time. If you want to add this link manually, please use the widget code below.
  2. Widget Code“: use this Magento Widget Code to insert the “Cookie Settings” link anywhere across your store. Widgets are useful when you need to manually display the Cookie Settings button in the website footer, Privacy Policy, Cookie Policy page, etc.
magento 2 cookie consent extension configuration cookie settings link.png

Additional Information:

If you have the Data Privacy extension installed (it comes bundled with GDPR, CCPA, and LGPD extensions), the Cookie Settings button is automatically displayed in the My Privacy Center Dashboard. By clicking on it, customers can access the Sookie Settings Panel and change their cookie preferences.

Google Tag Manager Settings

Step-by-Step actions:

  1. Enable“: set to “Yes” to enable Google Tag Manager.
  2. Associated Cookie Category“: assign Google Tag Manager Script to a specific Cookie Category that you can select in this field. This allows enabling/disabling Google Tag Manager when a visitor enables/disables the corresponding cookie category.
  3. Container Id“: enter your container ID formatted as “GTM-XXXXXX” in this field.
magento 2 cookie consent extension configuration google tag manager.png

Cooking Categories

In the main menu go to the “Plumrocket” tab > select “Cookie Consent” extension > navigate to the “Cookie Categories” section.

Manage Cookie Categories

In this section, learn how to manage and edit Cookie Categories. Four main categories are created in this module by default, and more than 30 cookies are already categorized for your convenience. These categories are displayed for customers on the Cookie Settings Panel.

Step-by-Step actions:

  1. Manage Cookie Categories Grid allows you to manage available cookie categories and add new ones:
    • Name“: the name of the category.
    • Description“: the full description of the category, namely what cookies are used, the reason, benefits, and more. Customers can read it on the Cookie Settings Panel and decide whether to agree with them or not.
    • Key“: it is a category identifier. The key is used when you need to block cookies manually in the code.
    • Status“: the category with the “Enabled” status is visible on your Magento store frontend.
    • Is Essential“: the cookie category with the “Yes” value is defined as “essential”. Users are not allowed to disable the essential categories in the frontend. An example of essential cookies would be session cookies, persistent cookies, shopping cart cookies, etc.
    • Action“: click on the “Edit” button to be able to enable/disable the category or change its options.
  2. Edit“: click the “Edit” button on the particular category line to change the category settings. Go to the Edit Cookie Category section to learn more.
  3. Click the “Add New Cookie Category” button to add a new category. Follow the Edit Cookie Category steps to get it right.
magento 2 cookie consent extension configuration 8.png

Edit Cookie Category

In this section, you can learn how to edit or add new cookie categories correctly.

Step-by-Step actions:

  1. Is Enabled?“: this option indicates whether the category is visible on the frontend.
  2. Is Essential?“: if the cookie category is defined as “essential”, then users are not allowed to disable it in the frontend. An example of essential cookies would be session cookies, persistent cookies, shopping cart cookies, etc.
  3. Is Pre-checked?“: this option indicates whether the category switcher is “ON” by default in the Cookie Settings Panel. Please note, the cookies from this category will be accepted only after a visitor confirms the choices.
  4. Name“: enter the name of the category here.
  5. Category Identifier“: enter the category identifier in this field. It is useful when you need to block cookies manually in the code. We recommend using the following identifiers for default Cookie Categories: “necessary”, “preference”, “statistic”, and “marketing”. See our Developer’s Guide for more info.
  6. Description“: enter the full description of the category, namely what cookies are used, the reason, benefits, and more. Customers can read it on the Cookie Settings Panel and decide whether to agree with them or not.
magento 2 cookie consent extension configuration 9.png

Step-by-Step actions:

  1. Sort Order“: enter a category position in the “Cookie Settings Panel”. The category with a value of 0 will be displayed in the first position.
  2. Head Scripts“: in this field, enter scripts and HTML that will be included right after the opening <body> tag. They will be executed if a customer enables the corresponding cookie category.
  3. Footer Miscellaneous HTML“: in this field, enter scripts and HTML that will be included right before the closing </body> tag. They will be executed if a customer enables the corresponding cookie category.
  4. Save“: press the Save button to save your changes.
magento 2 cookie consent extension configuration 10.png

Cookies

Learn how to manage, edit and add new cookies in this section.

In the main menu go to the “Plumrocket” tab > select “Cookie Consent” extension > navigate to the “Cookies” section.

Manage Cookies

Step-by-Step actions:

  1. Manage Cookies Grid allows you to keep track of all used cookies, manage and edit them:
    • Name“: the name of the cookie.
    • Domain“: the domain for which the cookie is valid.
    • Duration“: the period when the cookie expires. When set to 0 or omitted, the cookie will expire at the end of the session.
    • Type“: the type of cookie determines whether it is set by Magento store or a third-party service.
    • Category“: displays the name of the category to which this cookie belongs to.
    • Action“: the “edit” button is clickable and allows you to edit a cookie.
  2. Edit“: see the Edit Cookie section to learn more about how to edit a cookie.
  3. Add Cookie“: click on this button to add a new cookie. Follow the Edit Cookie instructions to get it right.
magento 2 cookie consent extension configuration 11.png

Edit Cookie

Follow the steps below to edit or add cookies corectly.

Step-by-Step actions:

  1. Name“: enter the name of the cookie in this field.
  2. Type“: specify the type of the cookie here. The first-party cookie is set by your Magento store. A third-party cookie is set by a third-party service via code loaded on your website. If you selected the third-party cookie type, you need to enter the domain for which the cookie is valid in the latter field. If this attribute is not specified, the Magento base URL is used as the default value.
  3. Duration“: set the period when the cookie should expire. If set to 0 or omitted, the cookie will expire at the end of the session (when the browser closes).
  4. Description“: enter the description of the cookie on this field.
  5. Cookie Category“: select the category of the cookie you created earlier.
  6. Save“: press on the Save button to save the changes.
magento 2 cookie consent extension configuration 12.png

Cookie Consent Log

Some of the data protection laws require storing collected cookie consent data. Whenever a user gives consent or declines it, the extension records it in the log.

In the main menu go to the “Plumrocket” tab > select “Cookie Consent” extension > navigate to the “Cookie Consent Log” section.

Step-by-Step actions:

  1. Cookie Consent Log Grid allows you to view all collected information about users’ cookie consents:
    • Customer ID“:
    • Customer Name“: the customer name. Click on it to see the customer information.
    • Email“: a customer email.
    • Website“: the website collected cookies.
    • Settings“: the information about a user’s declined or accepted cookies in Cookie Settings Panel.
    • Date of Consent“: the date when a user gave consent.
    • IP Address“: a user’s IP Address.
magento 2 cookie consent extension configuration 13.png

Important Information:

This Cookie Consent Extension is based on a GeoIP Lookup Extension. The GeoIP plugin is free and included in this package. Please, click here to learn how to configure it correctly.

Was this article helpful?