JavaScript Reference

Event to listen for consent changes.

Example

// Listen for changes in consent statuses.
document.addEventListener( 'wp_listen_for_consent_change', function ( e ) {
  // Check if marketing cookies are allowed.
  if ( e.detail.marketing && e.detail.marketing === 'allow' ) {
    console.log( 'just given consent, track user data' )
  }
});

Note: All Altis Consent JavaScript functions are in the Altis.Consent namespace.

Altis.Consent.has( category )

Check if a user has given consent for a specific category.

Parameters

  • category string: The category to check consent against.

Return

bool Whether the user has given consent for the selected category.

Altis.Consent.set( category, value )

Set a new consent category value.

Parameters

  • category string: The consent category to update. Must be a valid consent category.
  • value string: The value to update the consent category to. Must be a valid value.

Altis.Consent.setCookie( name, value )

Set a cookie by consent type.

Parameters

  • name The cookie name to set.
  • value The cookie value to set.

Altis.Consent.getCookie( name )

Retrieve a cookie by name.

Parameters

  • name The name of the cookie to get data from.

Return

string)The cookie data or an empty string.

Altis.Consent.cookieSaved

Check if a consent cookie has been saved on the client machine.

Return

bool True if consent has been given previously, false if consent has not yet been given.

Altis.Consent.getCategories

Retrieve an array of all the categories that a user has consented to.

Return

array An array of allowed cookie categories.