Developer Documentation

PHP Function Reference

Note: All the functions in the Altis Consent plugin use the Altis\Consent namespace except where noted.

load_consent_banner

Loads the templates used to display the cookie consent banner. The path to the banner can be customized using the altis.consent.consent_banner_path filter.

Example

function render_consent_banner() : string {
    ob_start();
    load_consent_banner();
    return ob_get_clean();
}

should_display_banner

Determines whether the banner should be displayed. Uses the display_banner setting defined in the admin but can be filtered by using the altis.consent.should_display_banner filter.

Return

(bool) Whether the banner should be displayed.

Example

function load_consent_banner() {
    // Check if we need to load the banner.
    if ( should_display_banner() ) {
            load_template( plugin_dir_path( __DIR__ ) . 'tmpl/consent-banner.php' );
    }
}

cookie_prefix

Returns the default consent cookie prefix.

Return

(string) The consent cookie prefix. Defaults to altis_consent.

Example

wp_localize_script( 'altis-consent', 'altisConsent', [
    'cookiePrefix' => cookie_prefix(),
] );

consent_types

Returns the active consent types.

Return

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

Example

wp_localize_script( 'altis-consent', 'altisConsent', [
    'consentTypes' => consent_types(),
] );

consent_categories

Returns a list of active consent categories.

Return

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

Example

wp_localize_script( 'altis-consent', 'altisConsent', [
    'categories' => consent_categories(),
] );

consent_values

Returns a list of active possible consent values.

Return

(array) A list of possible consent values. Defaults are allow and deny.

Example

wp_localize_script( 'altis-consent', 'altisConsent', [
    'values' => consent_values(),
] );

validate_consent_item

Validates a consent item (either a consent type, category or value).

Parameters

$item (string) The value to validate. $item_type (string) The type of value to validate. Possible options are types (consent types, see consent_types), categories (consent categories, see consent_categories), or values (consent values, see consent_values).

Return

(string|bool) The validated string or false if unable to validate. Triggers a warning if either the $item_type or the $item is invalid.

Example

if ( ! Consent\validate_consent_item( $category, 'category' ) ) {
    // Do something.
}

get_cookie_policy_url

Retrieves the URL to the cookie policy page. Can be filtered by the altis.consent.cookie_policy_url filter.

Return

(string) The cookie policy page URL.

Example

<div class="cookie-consent-policy">
    <a href="<?php echo esc_url( Altis\Consent\get_cookie_policy_url() ); ?>">
        <?php esc_html__( 'Read our cookie policy', 'altis-consent' ) ); ?>
    </a>
</div>

Settings\get_consent_option

Note: Defined in the Altis\Consent\Settings namespace.

Get a specific consent option, if one exists. If no parameters are passed, returns all the saved consent option values.

Parameters

$option (mixed) (Optional) A consent option name. The option must exist in the cookie_consent_options group. Default is an empty string. If no value is passed, all the saved cookie_consent_options option values will be returned.

$default (mixed) (Optional) A default value to return if no option for that value has been set. Default is an empty string. Requires an $option parameter to be passed.

Return

(mixed) The value for the requested option, or an array of all cookie_consent_options if nothing was passed.

Example

$cookie_expiration = Altis\Consent\Settings\get_consent_option( 'cookie_expiration', 30 );

Settings\get_default_banner_message

Note: Defined in the Altis\Consent\Settings namespace.

Gets the default banner message. Filterable with the altis.consent.default_banner_message filter.

Return

(string) The default cookie consent banner message.

Example

use Altis\Consent\Settings;

if ( ! Settings\get_consent_option( 'banner_message' ) ) {
    echo wp_kses_post( Settings\get_default_banner_message() );
}

Settings\render_secondary_button

Note: Defined in the Altis\Consent\Settings namespace.

Display a secondary button.

Used to create the Create Policy Page buttons, but can be filtered and used for other things.

Parameters

$button_text (string) The text to display in the button.

$value (string) The button value. On the settings page, this is used to determine the type of policy page the buttons create.

$type (string) The html button type. The default value is 'submit', and valid values are 'submit', 'reset', and 'button'. Invalid values revert to 'submit'.

Example

Settings\render_secondary_button( __( 'Create Cookie Policy Page', 'altis-consent' ), 'cookie_policy' );