Developer Documentation

Warning: This version of Altis is no longer supported

Template Architecture

The Altis Consent module comes with a default banner that can be customized via the filters provided for the messaging and button text. However, those templates can be replaced entirely or only specific templates can be replaced by your own in a theme or plugin.

The default banner templates are located in the /tmpl directory.

Overriding the default templates

Overriding the default templates is easy. You can either override all of them using the altis.consent.consent_banner_path filter and defining the path to your main consent banner template file. Or you can override individual templates, keeping the others, by using the filters for the given template path (see below).

Example

// Override all the built-in templates.
add_filter( 'altis.consent.consent_banner_path', get_template_directory() . 'path/to/your/template.php' );

// Override an individual template.
add_filter( 'altis.consent.cookie_preferences_template_path', get_template_directory() . 'path/to/your/template.php' );

Template files

The main template file is tmpl/consent-banner.php. This file path can be customized with the altis.consent.consent_banner_path filter and is loaded with the load_consent_banner function.

This template loads the consent-updated, cookie-preferences (if applicable), and button-row templates.

This template displays the "preferences updated" messaging which can be filtered independently with the altis.consent.preferences_updated_message filter. It is located at tmpl/consent-updated.php but the template can be overridden with the altis.consent.consent_updated_template_path filter.

This template pulls in the cookie consent categories from WP_CONSENT_API::$config, loops through them, and displays options for users to customize the types of cookie tracking they would like to allow. It uses the altis.consent.apply_cookie_preferences_button_text filter for the "apply changes" button.

The built-in CSS is designed to display the cookie preferences panel when the cookie preferences button is clicked. When the panel is displayed, the "allow only functional cookies" and "allow all cookies" buttons are hidden in favor of the more granular controls the preferences panel offers.

The template is located at tmpl/cookie-preferences.php /Filter-Reference#altisconsentcookie_preferences_template_path).

button-row.php

This template pulls in the banner message from the options saved on the Altis Privacy page (or displays the default banner message), loads the cookie-consent-policy.php template, and displays buttons to "accept all cookies" or "accept only functional cookies". If more granular controls are set in the admin to allow users to select which categories of cookies they want to accept, it will also display a "cookie preferences" button.

The template is located at tmpl/button-row.php but the template can be overridden with the altis.consent.button_row_template_path filter.

This template displays a link to the cookie consent policy. The link is generated by pulling the saved option from the Altis Privacy page. If no cookie policy page has been defined, the template isn't loaded in button-row.php. The link text is filterable using the altis.consent.cookie_consent_policy_link_text filter.

The template is located at tmpl/cookie-consent-policy.php, but the template can be overridden with the altis.consent.cookie_consent_policy_template_path filter.

Edit this page on GitHub