Cookie Consent¶

Introduction¶

The Cookie Consent Module prevents ExpressionEngine cookies from being set unless the user has explicitly granted permission as indicated by the presence of a ‘cookies_allowed’ cookie. In the absence of such permission, any existing ExpressionEngine cookies will be automatically deleted and no further cookies set until permission is granted. In addition, member registration and member login will require cookie consent.

The module makes two means of granting consent available: a direct link that can be used anywhere and form field that can be included on login and registration pages. Removing permission to set cookies is also provided for via a link.

To access the Cookie Consent control panel, go to Add-Ons ‣ Modules ‣ Cookie Consent in your Control Panel. There you will be able control settings related to control panel login and cookie clearing behavior. See Cookie Consent control panel for more information.

Installation¶

The Cookie Consent Module is available as a separate download on GitHub. The module folder (which should be cookie_consent and must be renamed to that if it’s something different) should be placed in your third_party folder (typically system/expressionengine/third_party/).

Message tag¶

This tag allows you to conditionally display messages based on whether the user has the cookies_allowed cookie set, thus indicating consent to set cookies. Typically you will show a link to grant cookie permission only to those who have not already granted consent. You may also use the module to display a link to revoke cookie consent.

{exp:cookie_consent:message}

        {if cookies_allowed == 'yes'}
                Thanks for allowing cookies!<br>
                Delete cookies: {clear_ee_cookies_link}
        {if:else}
                Please allow cookies:<br>
                {cookies_allowed_link}
        {/if}

{/exp:cookie_consent:message}

{clear_all_cookies_link}

{clear_ee_cookies_link}

{cookies_allowed}

{cookies_allowed_link}

Login and Registration Forms¶

Cookie consent is required in order to login or register. If consent has not been granted, an error message will be shown when a login or registration form is submitted. In order to provide flexibility in how you gain consent, posting a form field named ‘cookie_consent’ with a value of ‘y’ will allow the consent cookie and all subsequent cookies to be set.

<input type='checkbox' name='cookie_consent' value='y'/>&nbsp;&nbsp;<span  class="alert">Allow Cookies</span>

Typically this form field will be used inside the Cookie Consent Message tag and only shown if cookie consent has not been granted. This applies to both regular ExpressionEngine templates and the Member Profile templates.

Cookie Consent and the Forum Module¶

As with other login and registration forms, a ‘cookie_consent’ field with a value of ‘y’ can be used in the forum login and registration pages to indicate consent. The Cookie Consent Message tag can be used in the forum_member/login_form.html and forum_member/registration_form.html to conditionally display the field.

You may also create a new forum theme page that may be included in other templates as needed to display cookie consent variables. To add the new page, you must create a folder called ‘forum_cookie_consent’ inside your forum theme folder. The theme page itself must be named ‘cookie_consent.html’.

The following single variables are available in this theme page:

{clear_all_cookies_link}
{clear_ee_cookies_link}
{cookies_allowed_link}

The following conditional variables are available in this theme page:

{if cookies_allowed}{/if}
{if cookies_not_allowed}{/if}

The new template can be included in any other template using {include:cookie_consent}.

Standard ExpressionEngine Cookies¶