Documentation
Docs

Cookie consent notice

From ska-theme -> General -> Cookie notice option it’s possible to enable displaying a dialog that notifies users about cookies.

The contents of the notice can be changed by editing the Appearance -> Editor -> Patterns -> General -> Consent dialog template part.

By default the notice integrates with WP Consent API and Google Site Kit in “Consent mode”:

An Alpine.js store is used to manage the consent dialog.

Module argumentsTypeScript
interface ConsentConfig {
	/** Toggle consent with WP Consent API according to Google Site Kit consent map. */
	gsk?: boolean
}

Consent with JavaScript:

window.ska_theme.Alpine.store('skaConsent').consent()

Retrieve consent status:

window.ska_theme.Alpine.store('skaConsent').hasConsent // true / false

Revoke consent and show consent dialog again:

window.ska_theme.Alpine.store('skaConsent').revokeConsent()

Note: using Alpine.js in HTML attributes you can access the store via the $store magic shorthand:

<button 
	type="button"
	x-data 
	x-on:click="$store.skaConsent.consent({gsk:true})"
>Consent</button>

Google Site Kit

Consent mode should be enabled on your site if at least one of the following applies:

  • The Analytics module is connected in Site Kit
  • Google Ads is in use
Google Site Kit consent mode

In order for consent mode to work, the WP Consent API plugin must be installed as well.

Using WP Consent API

Once you have installed and activated the WP Consent API plugin the Consent dialog‘s “Accept” button will be granting consent to all properties in Google Site Kit consent category map.

When WP Consent API plugin is detected and the Cookie notice option is enabled ska-theme automatically sets wp_consent_type to optin by enqueuing the following JavaScript:

window.wp_consent_type = 'optin'
document.dispatchEvent(new CustomEvent('wp_consent_type_defined'))

The following filter can be used to disable that behavior:

Prevent ska-theme from automatically entering into optin modePHP
add_filter('ska_theme_define_wp_consent_type', '__return_false');

By default the cookie notice “Accept” button grants consent to all properties in GSK consent map (statistics, marketing, functional, preferences):

$store.skaConsent.consent({gsk:true})

For a custom implementation, that setting can be removed (in which case calling $store.skaConsent.consent() will simply hide the consent dialog but not grant any consent) and consent can be granted manually with the WP Consent API JS function:

Granting only statistics permissions
$store.skaConsent.consent() && wp_set_consent('statistics', 'allow')

Consent can be rejected by calling reject() which will hide the consent notice.

$store.skaConsent.reject()

By default WP Consent API consent cookies persist for 30 days, this can be modified with the following filter:

WP Consent API cookie expirationPHP
add_filter('wp_cookie_expiration', function($expiration) {
	return 90;
});

The ska-theme’s cookie notice will automatically use the same value.

Testing if the consent is working with Google Tag

When using Google Site Kit with Consent mode enabled and WP Consent API, you can test if your cookie banner is correctly granting permissions by checking the dataLayer array (which Google Tag uses) in your browser dev tools JavaScript console.

Open your website in an incognito window and open the browser dev tools (F12) -> Console tab and type in dataLayer to inspect the initial state of the array:

dataLayer array in dev tools

By default the “consent” has been set to “denied” for all categories.

Now press the “Accept” button on your cookie notice, then type dataLayer in the console again to see the changes:

Updated dataLayer array in dev tools with analytics_storage permissions

You should see that the dataLayer array length is now longer and the last call was to update the consent – for this example the Consent button called wp_set_consent('statistics', 'allow') and that’s what triggered GSK to grant analytics_storage permissions.