Filter Reference

`altis.consent.banner_options`

The available banner options to display on the options page.

Parameters

$options (array) An array of cookie banner options in the following format:

$options = [
    [
        'value' => 'none',
        'label' => __( 'Allow/Deny All Cookies', 'altis-consent' ),
    ],
];

Source

`altis.consent.privacy_policy_message`

The actual text that displays above the Privacy Policy Page setting on the Privacy page. This language can be altered or removed entirely using this filter. The original text that displays duplicates the text that existed on the original WordPress core Privacy page.

Parameters

$privacy_message (string) The message to display above the Privacy Policy Page setting.

Source

`altis.consent.validate_privacy_options`

The Altis Privacy page saved options. If you create new options for the Privacy page, you must use this filter to add and validate that new option data.

Parameters

$validated (array) An array of validated data.

$dirty (array) An array of data not yet validated.

Source

`altis.consent.default_banner_message`

The default cookie consent banner message. This is the text that appears in the WordPress WYSIWYG editor on the Altis Privacy page by default, before it's been saved.

Parameters

$default_message (string) The default cookie consent banner message.

Source

`altis.consent.allowed_policy_page_values`

An array of allowed policy pages we can create. Used by render_secondary_button function. The default pages that can be created are privacy_policy and cookie_policy.

If new policy pages should be created on a settings page using render_secondary_button, this filter must be used to allow those pages.

Parameters

$allowed_policy_page_values (array) An array of allowed policy page values.

Source

`altis.consent.use_block_editor`

Whether we are using the block editor.

This defaults to true, but if false, we omit the Gutenberg block support in the policy content.

Parameters

$block_editor (bool) True/false whether the site is using the block editor.

Source

`altis.consent.consent_banner_path`

The path to the consent banner template. Within the Altis Consent module, this template loads all the other templates. Overriding this setting allows you to create your own custom banner templates

Parameters

$template_path The path to the consent banner template.

Source

File: inc/functions.php

Example

// Override the default consent banner templates.
add_filter( 'altis.consent.consent_banner_path', __DIR__ . '/path/to/your/template.php' );

`altis.consent.should_display_banner`

Whether to display the banner. This filter defaults to the value of the display_banner setting, or false if that's not set. Using this filter allows you to hijack the display of the banner based on external logic.

Parameters

$display_banner (bool) Whether to display the banner. Defaults to the stored display_banner value, or false if unset.

Source

File: inc/functions.php

Example

add_filter( 'altis.consent.should_display_banner', function ( bool $display_banner ) : bool {
    // Don't display if the page ID is 10.
    if ( is_page( 10 ) ) {
        return false;
    }

    // Don't display on 404 pages.
    if ( is_404() ) {
        return false;
    }

    // Return whatever the expected, global result should be.
    return $display_banner;
} );

`altis.consent.cookie_prefix`

The consent cookie prefix.

Note: The actual consent cookies will add an underscore (_) automatically between the prefix and the consent category.

Parameters

$cookie_prefix (string) The consent cookie prefix. Default is altis_consent.

Example

add_filter( 'altis.consent.cookie_prefix', function() {
    return 'some_other_prefix';
} );

`altis.consent.types`

The allowed consent types.

Parameters

$types (array) The list of consent types. Defaults are optin and optout.

Example

add_filter( 'altis.consent.types', function( $types ) {
    $types[] = 'none';
    return $types;
} );

`altis.consent.categories`

The allowed consent categories.

Parameters

$categories (array) The list of consent categories. Defaults are functional, preferences, statistics, statistics-anonymous, marketing.

Example

add_filter( 'altis.consent.categories', function( $categories ) {
    $categories[] = 'personalization';
    return $categories;
} );

`altis.consent.category_labels`

The consent categories with labels for end user display.

Parameters

$categories (array) The list of consent categories with labels. Defaults are "Functional", "Preferences", "Statistics", " Anonymous statistics" and "Marketing".

Example

// Changing the 'preferences' category label to 'Settings'.
add_filter( 'altis.consent.category_labels', function( $categories ) {
    $categories['preferences'] = __( 'Settings' );
    return $categories;
} );

`altis.consent.values`

The possible consent values.

Parameters

$values (array) The list of consent values. Defaults are allow, deny.

Example

add_filter( 'altis.consent.values', function( $values ) {
    $values[] = 'other';
    return $values;
} );

`altis.consent.cookie_policy_url`

The cookie policy page URL. Attempts to fetch from the saved option.

Parameters

$cookie_policy_page_url (string) The cookie policy page URL.

Source

File: inc/functions.php

`altis.consent.default_cookie_policy_content`

Filters the default content suggested for inclusion in a cookie policy.

Parameters

$content (string) The default policy content.

$strings (array) An array of cookie policy content strings.

$blocks (bool) Whether the content should be formatted for the block editor.

Source

File: inc/cookie-policy.php

`altis.consent.consent_updated_template_path`

The template that displays the "preferences updated" messaging after it's been saved.

Parameters

$consent_updated_template_path (string) The path to the consent updated template.

Source

`altis.consent.no_option_saved_message`

The message that displays in the consent-banner.php template if no consent options have been saved in the admin. This message can potentially be overridden if using your own templates (see altis.consent.consent_banner_path).

Parameters

$no_option_saved_message (string) The message to output when no consent option has been saved.

Source

`altis.consent.cookie_preferences_template_path`

The path to the cookie preferences template. Only displayed if banner options have been saved and the setting is not set to none.

Parameters

$cookie_preferences_template_path (string) The path to the cookie preferences template.

Source

`altis.consent.button_row_template_path`

The path to the template that includes the buttons and messaging of the banner.

Source

Parameters

$button_row_template_path (string) The path to the button row template.

`altis.consent.preferences_updated_message`

The message that displays when a user saves their cookie consent preference. This message can potentially be overridden if using your own templates (see altis.consent.consent_banner_path).

Parameters

$preferences_updated_message The message to display when cookie preferences have been saved.

Source

File: tmpl/consent-updated.php

`altis.consent.apply_cookie_preferences_button_text`

The button text for the Apply Changes button, when cookie category preferences are displayed. This message can potentially be overridden if using your own templates (see altis.consent.consent_banner_path) or if categories are not displayed as part of the cookie consent banner.

Parameters

$apply_changes_button_text (string) The button text to apply cookie preference changes.

Source

File: tmpl/cookie-preferences.php

`altis.consent.cookie_consent_policy_link_text`

The hyperlinked message that links to the Cookie Policy page. Defaults to "Read our cookie policy". This message can potentially be overridden if using your own templates (see altis.consent.consent_banner_path).

Parameters

$cookie_policy_link_text (string) The text to link to the cookie policy page.

Source

File: tmpl/cookie-consent-policy.php

`altis.consent.cookie_consent_policy_template_path`

The path to the cookie consent policy template. This template displays the link to the cookie policy page if a cookie policy page has been set in the Altis Privacy options.

Parameters

$cookie_consent_policy_path (string) The path to the cookie consent policy template.

Source

`altis.consent.accept_all_cookies_button_text`

The text to display in the "accept all cookies" button. This message can potentially be overridden if using your own templates ( see altis.consent.consent_banner_path).

Parameters

$accept_all_cookies_text (string) The "accept all cookies" button text.

Source

`altis.consent.accept_only_functional_cookies_button_text`

The text to display in the "accept only functional cookies" button. This message can potentially be overridden if using your own templates (see altis.consent.consent_banner_path).

Parameters

$accept_functional_cookies (string) The "accept only functional cookies" button text.

Source

`altis.consent.cookie_preferences_button_text`

The text to display in the "cookie preferences" button. This message can potentially be overridden if using your own templates ( see altis.consent.consent_banner_path) or if cookie consent categories are not displayed.

Parameters

$cookie_preferences_button_text (string) The "cookie preferences" button text.

Source