Documentation for consent management-side

[enkelmedia]

Hi!

Thanks for a great initiative!

I'm looking to implement support for WP Consent API in my cookie banner.

I've looked around for resources and guidance on how to do this, but could not really find anything "official" but I think I've managed to get something to work.

I'm basically:

• Adding the wp_get_consent_type filter and return optin based on configuration.
• Adding a client-side script that listens for events from the cookie banner and calls wp_set_consent for the relevant categories.

I can see new cookies (wp_consent_functional, wp_consent_marketing...) that get the correct value (allow or deny) based on the choices in the banner.

Is that it?

As the "consent providing" part of this, am I missing something? Or does someone know if there are any resources/documentation around the part I'm trying to implement?

Cheers!

[rlankhorst]

Hi @enkelmedia, Great to hear you're implementing WP Consent API.

Most of it is described in the readme, but wiki would be better. Will look at that. But you got it basically right. It is a very simple api.

set consent type, you already did this.
window.wp_consent_type = 'optin'

Some plugins might wait for this event, so best to fire it.

//dispatch event when consent type is defined. This is useful if the region is detected server side, so the consent type is defined later during the pageload
let event = new CustomEvent('wp_consent_type_defined');
document.dispatchEvent( event );

you already did this:

//consent management plugin sets cookie when consent category value changes
wp_set_consent('marketing', 'allow');

All integrating plugins can simply listen to the consent changes:
document.addEventListener("wp_listen_for_consent_change", function (e) {....

Depending on if your banner also allows to give consent on a single service, you can also use

wp_set_service_consent( 'google-analytics', true ); 
wp_set_service_consent( 'facebook-pixel', false );

So for example a website can show just the youtube embed and nothing else.

[enkelmedia]

Hi!

Thanks for getting back so fast @rlankhorst!

I did see the snippet in the readme, but it was hard to understand the context for how to use it - but after your answer it make a lot more sense.

I just have one follow-up question,

You mentioned window.wp_consent_type = 'optin', I currently don't call this method on the client side, I only do this in my PHP-plugin:

add_filter( 'wp_get_consent_type', array( $this, 'wp_consent_api_get_consent_type' ) );

Do I have to add window.wp_consent_type = 'optin' as well or does add_filter take care of this?

[rlankhorst]

If the consenttype is not dynamic, and will only be set server side, your configuration is fine, as it will pass it to the clientside with wp_localize_script()

[enkelmedia]

Thank you very much @rlankhorst!

Feel free to close this if you want to or keep it open if you're planning on a wiki - let me know if you want some feedback from someone new to the project :)

Have a great evening!

// Markus