Consent for WordPress: Documentation

Software: Consent

Platform: WordPress
Consent is a WordPress plugin designed to ensure website compliance with EU GDPR and other international user consent regulations. It enables websites to inform users about cookie usage and policies and obtain their consent, ensuring alignment with legal requirements. It offers extensive customization options including themes, for optimal user experience. Learn More.
The documentation is also available within the application by using the Documentation button, or by hovering the mouse over help points.


Quick Start


Welcome to Eorisis Consent! For initial installation, install the plugin through the Plugins > Add Plugins > Upload Plugin section in WordPress. Set the banner position in the Banner options and customize any text as needed. Add links to your policies in the Link options. Enable the services you need in the Services section, such as Analytics, Advertising and Meta Pixel, and customize the text to reflect your site's policies.
Save your settings and enjoy!


Installation & Updates


The downloadable package zip file can be used as an initial install or as an update without the need to uninstall the previous version. Once you have downloaded the zip file, login to your WordPress backend Dashboard area and navigate to the Plugins > Add Plugins > Upload Plugin section from the left menu. Then click the Browse button, select the zip file and click Install Now.

IMPORTANT:
The zip file is intended to be used as-is at the WordPress installer.
1. DO NOT unzip/extract or upload separate files that are included in the package in order to perform an install or update.
2. DO NOT rename the zip file, or the destination directory of the plugin in the WordPress /wp-content/plugins/ directory.
Doing so may lead to errors.

Always take a backup of your website before you install any plugin.



Uninstall


To uninstall the plugin, always use your WordPress Plugins area from the left menu. Find the plugin in the list, click Deactivate and then Delete. This will remove the plugin properly.



Adblock Notice


Users employing browser plugins, such as Adblock, may encounter issues, such as an empty advertising sections or buttons. It is important to note that this occurrence is not a flaw in the application but rather an outcome of browser plugins identifying keywords associated with ads/advertising on pages. In such instances, it is recommended to whitelist your domain within Adblock or deactivate the respective browser plugins. You are also encouraged to report any such case to our support so that we can provide solutions with updates.


Updates


Authorization Code
The Authorization Code is required for the Pro edition in order to get live updates. To install updates using the Eorisis Setup plugin for WordPress, insert your Authorization Code in the corresponding field in the Updates section of the plugin. Get your Authorization Code from your Eorisis account - Subscriptions & Renewals - page on eorisis.com.


Banners

Global options for Banners.

General


Enabled:
(On / Off)

Position:
(Top / Center / Bottom)
Select the position of the banner on the page.


Page Overlay:
(On / Off)
Place an overlay behind the banner on the page.


Scroll Lock:
(On / Off)
Prevent the page from scrolling.


Banner Switch:
(On / Off)
Add an icon to reopen the banner after it is hidden.


Ajax Timeout (ms):
Specifies the time limit in milliseconds for the Ajax request to complete when the Accept/Reject and other buttons are clicked. If the site is unreachable from the browser, the request will timeout after this duration.


z-index:
z-index is a CSS property that sets the stack order of specific elements. An element with greater stack order is always in front of another element with lower stack order.

Due to the fact that the Consent banner must be above any other element of the page, it may be necessary to be set to a different custom value.


Powered by:
(On / Off)
Toggle the display of the 'Powered by Eorisis' text/link. We appreciate your support in keeping this enabled, as it helps us a lot.


Behavior


On Click:
(Slide & Fade / Slide / Fade / Hide)
You can set a Slide and/or Fade visual effect when the button is clicked. Otherwise it can simply hide.


Slide Speed (ms):
The value for the Slide effect in milliseconds.


Slide Direction:
(Top / Bottom / Left / Right)
Choose in what direction you want the the Consent banner to slide.


Fade (ms):
The value for the Fade effect in milliseconds.

Tip: Set a small number.


Main Banner Text


Title:
(Use Preset / Use Custom Text / Off)
Use a preset, set your custom text, or turn it off if you do not want the title to be displayed.

Text:
(Use Preset / Use Custom Text / Off)
Use a preset, set your custom text, or turn it off if you do not want the title to be displayed.

Options Banner Text


Title:
(Use Preset / Use Custom Text / Off)
Use a preset, set your custom text, or turn it off if you do not want the title to be displayed.

Text:
(Use Preset / Use Custom Text / Off)
Use a preset, set your custom text, or turn it off if you do not want the title to be displayed.


Traffic Filters


Filters
Control the application of traffic filters created within the Traffic Filters section.


Links

Global options for Links.
Enabled:
(On / Off)


Text:
(Use Preset / Use Custom Text / Off)
Use a preset, set your custom text, or turn it off if you do not want the title to be displayed.


Preset:
Select a preset that suits your needs.


URL:
Set the URL that points to your policy page. The URL can be relative (starting with /), or absolute (starting with https://.


Target:
(Open in same window / Open in new window) Set the target for the link. It can open on the same window/tab or an external window or tab.


Relation:
(No Follow / Off)
If you don't want search engines or other bots to visit the page that the link points to, set to No Follow.


Services

Global options for Services.

Integration


Integrate with Eorisis Analytics:
(On / Off)
Enables full communication between Eorisis Consent and Eorisis Analytics. Note that when this is enabled, the Initial State for Analytics and Advertising is controlled by the Eorisis Analytics application.


Integrate with Eorisis Pixels:
(On / Off)
Enables full communication between Eorisis Consent and Eorisis Pixels.


Essential


Enabled:
(On / Off)


Initial State:
(On / Off)
Whether it is enabled or disabled by default. Note that when 'Integrate with Eorisis Analytics' is enabled, the Initial State for Analytics and Advertising is controlled by the Eorisis Analytics application.


Locked:
(On / Off)
When locked, it cannot be changed by the visitor.


Title:
(Use Preset / Use Custom Text)
Use a preset or set your custom text.

Text:
(Use Preset / Use Custom Text / Off)
Use a preset, set your custom text, or turn it off if you do not want the title to be displayed.

Analytics


Enabled:
(On / Off)


Initial State:
(On / Off)
Whether it is enabled or disabled by default. Note that when 'Integrate with Eorisis Analytics' is enabled, the Initial State for Analytics and Advertising is controlled by the Eorisis Analytics application.


Title:
(Use Preset / Use Custom Text)
Use a preset or set your custom text.

Text:
(Use Preset / Use Custom Text / Off)
Use a preset, set your custom text, or turn it off if you do not want the title to be displayed.

Advertising


Enabled:
(On / Off)


Initial State:
(On / Off)
Whether it is enabled or disabled by default. Note that when 'Integrate with Eorisis Analytics' is enabled, the Initial State for Analytics and Advertising is controlled by the Eorisis Analytics application.


Title:
(Use Preset / Use Custom Text)
Use a preset or set your custom text.

Text:
(Use Preset / Use Custom Text / Off)
Use a preset, set your custom text, or turn it off if you do not want the title to be displayed.

Meta Pixel


Enabled:
(On / Off)


Initial State:
(On / Off)
Whether it is enabled or disabled by default. Note that when 'Integrate with Eorisis Analytics' is enabled, the Initial State for Analytics and Advertising is controlled by the Eorisis Analytics application.


Title:
(Use Preset / Use Custom Text)
Use a preset or set your custom text.

Text:
(Use Preset / Use Custom Text / Off)
Use a preset, set your custom text, or turn it off if you do not want the title to be displayed.


Buttons

Global options for Buttons.

Accept Button


Enabled:
(On / Off)


Text:
(Use Preset / Use Custom Text)
Use a preset or set your custom text.


Reject Button


Enabled:
(On / Off)


Text:
(Use Preset / Use Custom Text)
Use a preset or set your custom text.


Options Button


Enabled:
(On / Off)


Text:
(Use Preset / Use Custom Text)
Use a preset or set your custom text.


Confirm Button


Text:
(Use Preset / Use Custom Text)
Use a preset or set your custom text.


Cancel Button


Text:
(Use Preset / Use Custom Text)
Use a preset or set your custom text.


Themes

Global options for Themes.

Banner Theme


Colors:
(Preset / Custom)
Choose the color theme that suits your site using predefined or custom color palette.


Preset:
(White / Light / Light Grey / Grey / Dark Grey)
Select a preset that suits your needs.


Background Color:
Set a custom color value.


Border Color:
Set a custom color value.


Text Color:
Set a custom color value.


Link Color:
Set a custom color value.


Link Color (Hover):
Set a custom color value.


Shadow:
(On / Off)
Display a shadow that will smoothly separate the banner with the rest of the page.


Buttons Theme


Colors:
(Preset / Custom)
Choose the color theme that suits your site using predefined or custom color palette.


Preset:
(Blue / White)
Select a preset that suits your needs.


Background Color:
Set a custom color value.


Background Color - Hover:
Set a custom color value.


Border Color:
Set a custom color value.


Border Color - Hover:
Set a custom color value.


Text Color:
Set a custom color value.


Text Color - Hover:
Set a custom color value.


Radius:
Default: 50
Set the radius of the button. It produces rounded corners. The greater the value the more rounded the button will be.


Font Weight:
(Normal / Bold)
Choose between bold or normal text for the button.


Font Size:
Default: 15
Set a custom size for the button.


Storage

Global options for Storage.

Cookie


Name:
Default: eorisis_consent
Name of the value to set. Only Alphanumeric, Underscore and Dash characters allowed.


Duration in days:
Default: 365
Set the cookie expiration time in days.


Domain:
The domain that the cookie is available to. To make the cookie available on all subdomains of example.com (including example.com itself) then you'd set it to .example.com. Although some browsers will accept cookies without the initial dot ., RFC 2109 requires it to be included.

Setting the domain to www.example.com or .www.example.com will make the cookie only available in the www subdomain. If you don't know what to set, leave this field to Default (blank).


Path:
Default: /
The path on the server in which the cookie will be available on. If set to /, the cookie will be available within the entire domain. If set to /foo/, the cookie will only be available within the /foo/ directory and all sub-directories such as /foo/bar/ of domain. If you have multiple WordPress setups in subdirectories, example /site1/, /site2/, you should set the path here in order to use separate cookies for each one.


Secure:
(On / Off)
Indicates that the cookie should only be transmitted over a secure HTTPS connection from the client. When set On, the cookie will only be set if a secure connection exists.


HTTP Only:
(On / Off)
When set On, the cookie will be made accessible only through the HTTP protocol.

This means that the cookie won't be accessible by scripting languages, such as JavaScript. This setting can effectively help to reduce identity theft through XSS attacks (although it is not supported by all browsers).


SameSite:
(Lax / Strict / None)
Default: Lax.

The SameSite attribute only allows the cookie to be sent to the application if the request originated from the same domain. In 2016 Google Chrome version 51 introduced a new kind of cookie, the same-site cookie, which can only be sent in requests originating from the same origin as the target domain. This restriction mitigates attacks such as cross-site request forgery (XSRF). SameSite=Lax is available as of Chrome 76. The Stable version of Chrome 80 is targeted for enabling SameSite=Lax by default.


Traffic Filters

Create, manage, and add filters to be used in banners.

General


Enabled
(On / Off)
Enable or disable this filter.


Title
Set a title for the list in the backend. It will not be used in the generated HTML.


Category
The category that this item is assigned to.


Active On
(Everyone / Logged out users / Logged in users)
Choose which types of users this item will be active on.


Filter


Filter Action
(Exclude / Include Only)
Choose the action for this filter. Remember that when a filter is set to 'Include Only', the item will display only if all the filter settings qualify.


Filter Type
Choose the type of incoming traffic for this filter.

IP Address: You can specify an IPv4 or IPv6 IP address.
CIDR: You can specify a CIDR (Classless Inter-Domain Routing) in both IPv4 or IPv6.
Hostname: Specify a hostname. Remember that a hostname lookup could impact performance.
User Agent: Specify a User-Agent string.
Referrer: Specify a referrer URL.
Country: Specify a country. (Requires Cloudflare)
Local Server: Exclude or include only traffic from the local server.
LAN: Exclude or include only traffic from the local area network.
Cloudflare: Exclude or include only traffic from the Cloudflare CDN. Note that this specifically applies to traffic originating from visitors whose IP addresses are associated with Cloudflare.
TOR: Exclude or include only traffic from the TOR network. This applies to traffic originating from visitors using TOR. It uses the official bulk exit list with local caching.


Filter Condition
Determine the criteria for this filter's decision process.

Equals: Apply this filter on pages where the Filter Type is the same as the given string.
Contains: Apply this filter on pages where the Filter Type contains the given string.
Starts with: Apply this filter on pages where the Filter Type starts with the given string.
Ends with: Apply this filter on pages where the Filter Type ends with the given string.
Does not equal: Apply this filter on pages where the Filter Type is not the same as the given string.
Does not contain: Apply this filter on pages where the Filter Type does not contain the given string.
Does not start with: Apply this filter on pages where the Filter Type does not start with the given string.
Does not end with: Apply this filter on pages where the Filter Type does not end with the given string.


Case Sensitive
(On / Off)
Enable or disable sensitivity to letter case in comparisons.


IP Address
You can specify an IPv4 or IPv6 IP address.


CIDR
You can specify a CIDR (Classless Inter-Domain Routing) in both IPv4 or IPv6.


Hostname
Specify a hostname. Remember that a hostname lookup could impact performance.


User Agent
Specify a User-Agent string.


Referrer
Specify a referrer URL.


Country
Specify a country. (Requires Cloudflare)


Local Server
Exclude or include only traffic from the local server.


LAN
Exclude or include only traffic from the local area network.


Cloudflare
Exclude or include only traffic from the Cloudflare CDN. Note that this specifically applies to traffic originating from visitors whose IP addresses are associated with Cloudflare.


TOR
Exclude or include only traffic from the TOR network. This applies to traffic originating from visitors using TOR. It uses the official bulk exit list with local caching.


Traffic Filter Categories

Items can be organized in categories.
Enabled
(On / Off)
Enable or disable this category.


Title
Set a title for the list in the backend. It will not be used in the generated HTML.


Active On
(Everyone / Logged out users / Logged in users)
Choose which types of users this item will be active on.


Preferences

Global Preferences.

General


HTML5
Default: On
Enable HTML5 to support modern elements and functionality, or disable it to revert to older HTML standards in case your WordPress template is old.


jQuery
(Auto / Off)
Default: Auto
Load the jQuery library. If your template or other plugins already load it, you can turn this off.


Notifications

Display notifications in the administration area.
If the application detects any kind of misconfiguration, it will display a notification in the Dashboard or a specific section of the application.


Quick Start
(On / Off)

Adblock
(On / Off)

Secure Cookie
(On / Off)

Setup Plugin
(On / Off)

cURL
(On / Off)

ZipArchive
(On / Off)