ExpressionEngine Docs

Getting Started

The Fundamentals

Advanced Usage

Best Practices

Community

Consent

The Consent module allows you to build tools to allow visitors to manage their consent. In conjunction with Consent Variables and Custom Consent Requests, you can build rich sites that respect activity that a visitor has consented to.

For example, consenting to use of certain cookies, of using their information for marketing purposes, and so on. These tags enable you to ensure that a visitor is freely giving their consent, for specific granular purposes, to inform them of the nature of what they are consenting to, to actively and unambiguously indicate their consent, and to see and manage (grant or withdraw) their consent to individual items.

Note: Require user consent to set cookies must be enabled before any restrictions on will take effect.

Consent Form

Consent Forms allow the visitor to grant or withdraw consent to one or more Consent Requests:

{exp:consent:form consent='ee:cookies_functionality'}
  {consents}
      <h2>{consent_title}</h2>

      {consent_request}

      Accepted: <input type="checkbox" name="{consent_short_name}" value="y" {if consent_granted}checked{/if}>
  {/consents}

  <input type="submit" name="submit" value="Submit">

{/exp:consent:form}

Consent Form Parameters

consent= 

consent='ee:cookies_functionality'

You can specify consent requests by their short name. You may specify multiple requests by separating them with the pipe character:

consent='ee:cookies_functionality|terms_of_service'

Or use “not” to exclude entries:

consent='not twitter_app'

form_class= 

form_class='consent_form'

Specify the HTML class= attribute.

form_id= 

form_id='consent_form'

Specify the HTML id= attribute.

return= 

return='site/consent'

Specify a path to redirect the user to after submission. If not specified, they will be returned to the current page. Unused for Ajax-submitted forms.

user_created= 

user_created='only'

Filter the consent requests based on whether or not they are user-created (as opposed to app / add-on created).

value result
y (default) Include user-created consents
n Exclude user-created consents
only Show only user-created consents

Consent Form Variables

{consents}{/consents}

A pair variable used to loop through all of the consent requests you are displaying with this form. It has the following variables:

{consent_creation_date}

The date the consent was created.

{consent_creation_date format='%Y %m %d'}

The date the request was created. See Date Variable Formatting for more information.

{consent_given_via}

The method that consent was provided, can be useful for conditionals. Typically online_form:

{if consent_given_via == 'online_form'}
  Consent was granted via an online form.
{/if}

{consent_grant_url}

A URL that when clicked will grant the user’s consent for this request.

<a href="{consent_grant_url}">Grant</a>

Optionally accepts a return= parameter if the action should redirect somewhere other than the current page:

<a href="{consent_grant_url return='preferences/saved'}">Grant</a>

{consent_granted}

A boolean variable for conditionals that returns TRUE or FALSE. Returns TRUE if the user has granted permission to the consent request, FALSE otherwise.

{if consent_granted}
    Set that cookie!
{/if}

{consent_id}

The ID number of the consent.

{consent_request}

The description of the consent request.

{consent_response_date} 
{consent_response_date format='%Y %m %d'}

The date that consent was granted or withdrawn. See Date Variable Formatting for more information.

{consent_short_name}

The short name of the consent.

{consent_title}

The title of the consent request.

{consent_user_created}

A boolean variable for conditionals that returns TRUE or FALSE. Returns TRUE if this consent request was user-created or not (by a site admin in the control panel). Returns FALSE otherwise (app or add-on created consent requests).

{if consent_user_created}
    This consent request is a custom request created by a site administrator.
{/if}

{consent_version_id}

The version_id of the consent request.

{version_id}

{consent_withdraw_url}

A URL that when clicked will withdraw the user’s consent for this request.

<a href="{consent_withdraw_url}">Withdraw</a>

Optionally accepts a return= parameter if the action should redirect somewhere other than the current page:

<a href="{consent_grant_url return='preferences/saved'}">Grant</a>

{if no_results}

If this tag would not output any consent requests due to your filters, the contents of this conditional will be displayed instead.

{if no_results}
  No Consent Requests Available
{/if}

Consent Form Examples

Simple Bulk Consent Form 

{exp:consent:alert}
  <div class="alert {alert_type}">
    <p>{alert_message}</p>
  </div>
{/exp:consent:alert}

{exp:consent:form}
  {if no_results}
    <h1>No Consent Requests to Display</h1>
  {/if}

  {consents}
    <fieldset>
      <dl>
        <dt>{consent_title}</dt>
        <dd>{consent_request}</dd>
      </dl>
      <label>
        <input type="radio" name="{consent_short_name}" value="y" {if consent_granted}checked{/if}>
        Accept
      </label>
      <label>
        <input type="radio" name="{consent_short_name}" value="n" {if ! consent_granted}checked{/if}>
        Decline
      </label>
    </fieldset>
  {/consents}

  <fieldset>
    <input type="submit" name="submit" value="Save">
  </fieldset>
{/exp:consent:form}

AJAX-Driven Consent Form 

<html>
  <head>
    <link rel="stylesheet" href="//code.jquery.com/ui/1.12.1/themes/base/jquery-ui.css">
  </head>
  <body>
    {exp:consent:form
      consent='ee:cookies_functionality|ee:cookies_performance|ee:cookies_targeting'
      form_id='cookieConsentForm'
    }
    <p>This website uses a variety of cookies, which you consent to if you continue to use this site. You can read our <a href="{path='privacy'}">Privacy Policy</a> for details about how these cookies are used, and to grant or withdraw your consent for certain types of cookies.</p>

    {consents}
      <label>
        <input type="checkbox" name="{consent_short_name}" value="y" {if consent_granted}checked{if:elseif ! consent_response_date}checked{/if}>
        {consent_title}
      </label>
    {/consents}

    <input type="submit" name="submit" value="Ok">
    {/exp:consent:form}

    <script src="//code.jquery.com/jquery-3.2.1.min.js"></script>

    <!--using the jQuery Form plugin https://jquery.malsup.com/form/-->
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.form/4.2.2/jquery.form.js" type="text/javascript"></script>

    <script type="text/javascript">
      $(document).ready(function(){
        $('#cookieConsentForm').ajaxForm({
          dataType: 'json',
          success: function(data) {
            if (data.success) {
              alert(data.success);
            } else {
              alert('Failed with the following errors: '+data.errors.join(', '));
            }
          }
        });
      });
    </script>
  </body>
</html>

Alert Tag

The Alert tag works in concert with standard POSTed forms, as one way to let users know that their consent preferences were saved, and which ones.

{exp:consent:alert}
  <div class="alert {alert_type}">
    <p>{alert_message}</p>
  </div>
{/exp:consent:alert}

If you want to provide custom classes and response text, you can do that here as well. The Alert tag will only render when there is something to be displayed. For instance, for a completely bespoke success message that will only display after the user submits a consent form:

{exp:consent:alert}
  {if alert_type == 'success'}
    <div class="alert alert-success" role="alert">
      We've saved your consent preferences, thank you!
    </div>
  {/if}
{/exp:consent:alert}

Alert Tag Variables

{alert_message}

The alert message. “Your consent preferences have been saved for:” followed by a list of the Consent Request titles the user submitted.

{alert_message}
{!-- Your consent preferences have been saved for: Functionality Cookies, Performance Cookies, Targeting Cookies --}

{alert_type}

One of issue, success, or warn. Can be useful to set CSS classes.

<div class="{alert_type}">

Requests Tag

The Requests tag lets you list or loop through available Consent Requests, without automatically wrapping them in a form tag. This can be useful for dynamically outputting information about your site’s Consents in a Terms of Service or Privacy Policy page. It can also be used to output links that let a user grant/withdraw consent to individual consents.

Tip: Link-based Grant & Withdraw actions are fully compatible with the Alert Tag.

{exp:consent:requests}
  {if no_results}
    <h1>No Consent Requests to Display</h1>
  {/if}

  <h1>{consent_title}</h1>
  <div>{consent_request}</div>

  <ul>
    <li><a href="{consent_grant_url}">Grant</a></li>
    <li><a href="{consent_withdraw_url}">Withdraw</a></li>
  </ul>
{/exp:consent:requests}

Requests Tag Parameters

consent= 

consent='ee:cookies_functionality'

You can specify consent requests by their short name. You may specify multiple requests by separating them with the pipe character:

consent='ee:cookies_functionality|terms_of_service'

Or use “not” to exclude entries:

consent='not twitter_app'

Specify a path to redirect the user to after submission. If not specified, they will be returned to the current page. Unused for Ajax-submitted forms.

user_created= 

user_created='only'

Filter the consent requests based on whether or not they are user-created (as opposed to app / add-on created).

|value| result| |y (default) |Include user-created consents| |n |Exclude user-created consents| |only | Show only user-created consents|

Requests Tag Variables

The Requests tag has the same variables available to the Consents Form, but without the need to wrap them in a {consents}{/consents} tag pair.

{consent_creation_date}

The date the consent was created.

{consent_creation_date format='%Y %m %d'}

The date the request was created. See Date Variable Formatting for more information.

{consent_given_via}

The method that consent was provided, can be useful for conditionals. Typically online_form:

{if consent_given_via == 'online_form'}
  Consent was granted via an online form.
{/if}

{consent_grant_url}

A URL that when clicked will grant the user’s consent for this request.

<a href="{consent_grant_url}">Grant</a>

Optionally accepts a return= parameter if the action should redirect somewhere other than the current page:

<a href="{consent_grant_url return='preferences/saved'}">Grant</a>

{consent_granted}

A boolean variable for conditionals that returns TRUE or FALSE. Returns TRUE if the user has granted permission to the consent request, FALSE otherwise.

{if consent_granted}
    Set that cookie!
{/if}

{consent_id}

The ID number of the consent.

{consent_request}

The description of the consent request.

{consent_response_date} 

{consent_response_date format='%Y %m %d'}

The date that consent was granted or withdrawn. See Date Variable Formatting for more information.

{consent_short_name}

The short name of the consent.

{consent_title}

The title of the consent request.

{consent_user_created}

A boolean variable for conditionals that returns TRUE or FALSE. Returns TRUE if this consent request was user-created or not (by a site admin in the control panel). Returns FALSE otherwise (app or add-on created consent requests).

{if consent_user_created}
    This consent request is a custom request created by a site administrator.
{/if}

{consent_version_id}

The version_id of the consent request.

{version_id}

{consent_withdraw_url}

A URL that when clicked will withdraw the user’s consent for this request.

<a href="{consent_withdraw_url}">Withdraw</a>

Optionally accepts a return= parameter if the action should redirect somewhere other than the current page:

<a href="{consent_grant_url return='preferences/saved'}">Grant</a>

{if no_results}

If this tag would not output any consent requests due to your filters, the contents of this conditional will be displayed instead.

{if no_results}
  No Consent Requests Available
{/if}

Cookie List Tag 

{exp:consent:cookies type="necessary"}
    Cookie name: {cookie_name}<br />
    Title: {cookie_title}<br />
    Description: {cookie_description}<br />
    Is set by: {cookie_provider}<br />
    Lifetime: {cookie_lifetime}<hr />
{/exp:consent:cookies}

Cookie List Tag Parameters

type= 

type='necessary'

Type of cookies to display. Possible options are necessary, functionality, performance and targeting. If omitted, all cookies will be displayed.

It is also possible to combine several types, e.g. type="performance|targeting".

If you need to exclude one or several types from display, use not before the values:

type='not performance|targeting'

provider= 

provider='ee'

Limits display of cookies by cookie provider. If the cookie is provided by an add-on, the provider matches the add-ons short name, e.g. comment or forum The core ExpressionEngine cookies are identified by ee as provider. If cookie is only being used in Control Panel, the provider is set to cp. Possible options are necessary, functionality, performance and targeting. If omitted, all cookies will be displayed.

It is also possible to combine several providers, e.g. type="ee|cp".

If you need to exclude one or several providers from display, use not before the values

provider='not forum|cp'

Cookie List Tag Variables

{cookie_name}

Cookie name

{cookie_title}

Cookie title

{cookie_description}

Cookie description

{cookie_provider}

Cookie provider (ee or add-on short name)

{cookie_lifetime}

Cookie lifetime in seconds. 0 represents session cookies (killed after browsing session ends).

ExpressionEngine 7 Docs
©2002–2024 Packet Tide,LLC. Edit this page