WordPress.org

Viktor Szépe

Rogier Lankhorst

Mark

Aert Hulsebos

Konstantinos Xenos

pepe

Mathieu Paapst

mujuonly

Johan Holst Nielsen

Aurooba Ahmed

<p>WP Consent API is a plugin that standardizes the communication of accepted consent categories between plugins. It requires a cookie banner plugin and, at least, one other plugin that supports the WP Consent API.</p>
<p>With this plugin, all supporting plugins can use the same set of methods to read and register the current consent category, allowing consent management plugins and other plugins to work together, improving compliance with privacy laws.</p>
<p>WARNING: the plugin itself will not handle consent. It will show you how many plugins you have without Consent API support and will improve compliance on your site by ensuring smooth communication between cookie banner plugins and plugins that set cookies or track user data.</p>
<h4>What problem does this plugin solve?</h4>
<p>Currently, it is possible for a consent management plugin to block third-party services like Facebook, Google Maps, Twitter, etc. But if a WordPress plugin places a PHP cookie, a consent management plugin cannot prevent this.</p>
<p>Secondly, some plugins integrate the tracking code on the clientside in javascript files that, when blocked, break the site.</p>
<p>Or, if such a plugin’s javascript is minified, causing the URL to be unrecognizable and won’t get detected by an automatic blocking script.</p>
<p>Lastly, the blocking approach requires a list of all types of URL’s that tracks data. A generic API where plugins adhere to can greatly<br />
facilitate a webmaster in getting a site compliant.</p>
<h4>Does usage of this API prevent third-party services from tracking user data?</h4>
<p>Primary this API is aimed at compliant first-party cookies or tracking by WordPress plugins. If such a plugin triggers, for example, Facebook,<br />
usage of this API will be of help. If a user embeds a Facebook iframe, a blocking tool is needed that initially disables the iframe and or scripts.</p>
<p>Third-party scripts have to blocked by blocking functionality in a consent management plugin. To do this in core would be to intrusive, and is also not applicable to all users: only users with visitors from opt-in regions such as the European Union require such a feature. Such a feature also has a risk of breaking things. Additionally, blocking these and showing a nice placeholder requires even more sophisticated code, all of which should in my opinion not be part of WordPress core, for the same reasons.</p>
<h4>How does it work?</h4>
<p>There are two indicators that together tell if consent is given for a specific consent category, e.g., “marketing”:<br />
1) the region based consent_type, which<br />
can be opt-in, opt-out, or other possible consent_types;<br />
2) and the visitor’s choice: not set, allow, or deny.</p>
<p>The consent_type is a function that wraps a filter, “wp_get_consent_type”. If there’s no consent management plugin to set it, it will return false. This will cause all consent categories to return true, allowing cookies to be set on all categories.</p>
<p>If opt-in is set using this filter, a category will only return true if the value of the visitor’s choice is “allow”.</p>
<p>If the region based consent_type is opt-out, it will return true if the visitor’s choice is not set or is “allow”.</p>
<p>Clientside, a consent management plugin can dynamically manipulate the consent type and set several cookie categories.</p>
<p>A plugin can use a hook to listen for changes or check the value of a given category.</p>
<p>Categories and most other stuff can be extended with a filter.</p>
<h3>Existing integrations</h3>
<p>Categorized, and sorted alphabetically</p>
<h4>Example plugin</h4>
<ul>
<li><a href="https://github.com/rlankhorst/consent-api-example-plugin" rel="nofollow ugc">Example plugin</a>. The plugin basically consists of a shortcode, with a div that shows a tracking or not tracking message. No actual tracking is done 🙂</li>
</ul>
<h4>Consent Management Providers</h4>
<ul>
<li><a href="https://wordpress.org/plugins/sirdata-cmp/" rel="ugc">Abconsent Sirdata CMP</a>.</li>
<li><a href="https://wordpress.org/plugins/beautiful-and-responsive-cookie-consent/" rel="ugc">Beautiful Cookie Consent Banner</a>.</li>
<li><a href="https://wordpress.org/plugins/clickio-consent/" rel="ugc">Clickio Consent</a></li>
<li><a href="https://wordpress.org/plugins/complianz-gdpr/" rel="ugc">Complianz GDPR/CCPA</a>.</li>
<li><a href="https://consent.studio/" rel="nofollow ugc">Consent Studio</a>.</li>
<li><a href="https://wordpress.org/plugins/consent-manager/" rel="ugc">consentmanager</a>.</li>
<li><a href="https://conzent.net/" rel="nofollow ugc">Conzent</a>.</li>
<li><a href="https://wordpress.org/plugins/cookiebot/" rel="ugc">Cookiebot</a>.</li>
<li><a href="https://wordpress.org/plugins/cookiefirst-gdpr-cookie-consent-banner/" rel="ugc">CookieFirst</a>.</li>
<li><a href="https://wordpress.org/plugins/cookiehub/" rel="ugc">CookieHub</a>.</li>
<li><a href="https://wordpress.org/plugins/cookietractor/" rel="ugc">CookieTractor</a>.</li>
<li><a href="https://wordpress.org/plugins/cookie-law-info/" rel="ugc">CookieYes – Cookie Banner for Cookie Consent</a>.</li>
<li><a href="https://wordpress.org/plugins/gdpr-cookie-compliance/" rel="ugc">GDPR Cookie Compliance</a>.</li>
<li><a href="https://www.webtoffee.com/product/gdpr-cookie-consent/" rel="nofollow ugc">GDPR Cookie Consent Plugin – CCPA Ready</a>.</li>
<li><a href="https://getterms.io/consent-manager/" rel="nofollow ugc">GetTerms</a>.</li>
<li><a href="https://wordpress.org/plugins/iubenda-cookie-law-solution/" rel="ugc">iubenda | All-in-one Compliance</a>.</li>
<li><a href="https://wordpress.org/plugins/pressidium-cookie-consent/" rel="ugc">Pressidium Cookie Consent</a>.</li>
<li><a href="https://wordpress.org/plugins/trustarc-cookie-consent-manager/" rel="ugc">TrustArc Cookie Consent Manager</a></li>
</ul>
<h4>Consent Requiring Plugins</h4>
<ul>
<li><a href="https://wordpress.org/plugins/add-to-any/" rel="ugc">AddToAny</a>.</li>
<li><a href="https://www.appfromlab.com/product/woocommerce-utm-tracker-plugin/" rel="nofollow ugc">AFL UTM Tracker Plugin</a>.</li>
<li><a href="https://wordpress.org/plugins/burst-statistics/" rel="ugc">Burst Statistics</a>.</li>
<li><a href="https://wordpress.org/plugins/google-site-kit/" rel="ugc">Google Site Kit</a>.</li>
<li><a href="https://wordpress.org/plugins/woocommerce-google-adwords-conversion-tracking-tag/" rel="ugc">Pixel Manager for WooCommerce</a>.</li>
<li><a href="https://wordpress.org/plugins/woocommerce/" rel="ugc">Woo</a>.</li>
<li><a href="https://wordpress.org/plugins/wp-statistics/" rel="ugc">WP Statistics</a>.</li>
</ul>
<h3>Demo site</h3>
<p><a href="https://wpconsentapi.org/" rel="nofollow ugc">wpconsentapi.org</a><br />
Below are the plugins used to set up the demo site:</p>
<ul>
<li>Complianz</li>
<li><a href="https://github.com/rlankhorst/consent-api-example-plugin" rel="nofollow ugc">The example plugin</a></li>
</ul>
<h4>javascript, consent management plugin</h4>
<pre><code>//set consent type
window.wp_consent_type = 'optin'

//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 );

//consent management plugin sets cookie when consent category value changes
wp_set_consent('marketing', 'allow');
</code></pre>
<h4>javascript, tracking plugin</h4>
<pre><code>//listen to consent change event
document.addEventListener("wp_listen_for_consent_change", function (e) {
  var changedConsentCategory = e.detail;
  for (var key in changedConsentCategory) {
    if (changedConsentCategory.hasOwnProperty(key)) {
      if (key === 'marketing' && changedConsentCategory[key] === 'allow') {
        console.log("just given consent, track user")
      }
    }
  }
});

//basic implementation of consent check:
if (wp_has_consent('marketing')){
  activateMarketing();
  console.log("set marketing stuff now!");
} else {
  console.log("No marketing stuff please!");
}
</code></pre>
<h4>PHP</h4>
<pre><code>//declare compliance with consent level API
$plugin = plugin_basename( __FILE__ );
add_filter( "wp_consent_api_registered_{$plugin}", '__return_true' );

/**
* Example how a plugin can register cookies with the consent API
 * These cookies can then be shown on the front-end, to the user, with wp_get_cookie_info()
 */

function my_wordpress_register_cookies(){
    if ( function_exists( 'wp_add_cookie_info' ) ) {
        wp_add_cookie_info( 'AMP_token', 'AMP', 'marketing', __( 'Session' ), __( 'Store a unique User ID.' ) );
    }
}
add_action('plugins_loaded', 'my_wordpress_register_cookies');


if (wp_has_consent('marketing')){
//do marketing stuff
}
</code></pre>
<h4>Service-level consent</h4>
<p>In addition to category-based consent, the API supports service-level consent control. This allows consent management plugins to grant or deny consent for specific services (like ‘google-analytics’ or ‘facebook-pixel’) independently from their category. When checking service consent with wp_has_service_consent(), the API first checks if explicit consent exists for that service. If no explicit consent is set, it falls back to the consent status of the service’s category. This enables fine-grained control: a user might accept statistics cookies in general, but explicitly deny a specific analytics service.</p>
<p>Service consent can be checked and set both server-side (PHP) and client-side (JavaScript):</p>
<p>PHP:</p>
<pre><code>//check if a specific service has consent
if ( wp_has_service_consent( 'google-analytics' ) ) {
    //activate google analytics
}

//check if a service is explicitly denied
if ( wp_is_service_denied( 'facebook-pixel' ) ) {
    //service was explicitly denied by user
}

//set service consent
wp_set_service_consent( 'google-analytics', true ); //grant consent
wp_set_service_consent( 'facebook-pixel', false ); //deny consent

//listen for service consent changes
add_action( 'wp_consent_service_changed', function( $service, $consented ) {
    error_log( "Service {$service} consent changed to: " . ( $consented ? 'granted' : 'denied' ) );
}, 10, 2 );
</code></pre>
<p>JavaScript:</p>
<pre><code>//check service consent
if ( wp_has_service_consent( 'youtube' ) ) {
    //activate tracking
}

//check if explicitly denied
if ( wp_is_service_denied( 'facebook-pixel' ) ) {
    //service denied
}

//set service consent
wp_set_service_consent( 'youtube', true );

//listen for service consent changes
document.addEventListener( 'wp_consent_api_status_change_service', function( e ) {
    console.log( 'Service: ' + e.detail.service + ', consented: ' + e.detail.value );
});
</code></pre>
<p>Any code suggestions? We’re on <a href="https://github.com/WordPress/wp-consent-level-api" rel="nofollow ugc">GitHub</a> as well!</p>


WP Consent API


Louis was great helping me with an issue. Plugin works great and highly recommend!


Great Support Team

Simple Consent API to read and register the current consent category.

Syed Balkhi

WPBeginner

Mircea Sandu

WPCode

<h4>Customizable Cookie Banner + Website Compliance Scanner</h4>
<p>WPConsent is the easiest way to add a GDPR / CCPA cookie consent banner to your WordPress website. You can customize the banner to match your website’s branding and configure how it looks.</p>
<p>Our easy-to-use website cookie scanner will automatically detect and list popular services used on your website. Our built-in integration provides you with details and a list of cookies used by each service, so you can easily configure them to comply with GDPR, CCPA / CPRA, ePrivacy, DSGVO, TTDSG, LGPD, POPIA, APA, RGPD, PIPEDA, and other global privacy regulations.</p>
<p>With the automatic script blocking feature, WPConsent will detect and block common tracking scripts / cookies like Google Analytics, Facebook Pixel, and more until the user gives consent. This ensures that those services can’t add 3rd party cookies without user consent as required by GDPR and other privacy regulations.</p>
<p>All cookie consent data is self-hosted on your website like it should be, making WPConsent the most privacy conscious solution.</p>
<blockquote>
<p><strong>WPConsent Pro</strong><br />
  This plugin is the Lite version of WPConsent Pro, which comes with geolocation options, records of consent, multilanguage, IAB TCF v2.2 integration, and more plugins automatically detected. <a href="https://wpconsent.com/?utm_source=wprepo&utm_medium=link&utm_campaign=liteplugin" rel="nofollow ugc">Click here to purchase the best premium WordPress consent plugin now!</a></p>
</blockquote>
<p><iframe loading="lazy" title="Getting Started With WPConsent" width="750" height="422" src="https://www.youtube.com/embed/7fcP9QO8bKQ?feature=oembed" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe></p>
<h4>Fully Customizable Cookie Banner</h4>
<p>The cookie banner should match your website’s branding and be easy to use. We give you many options in order to improve the consent rates on your website while being in full compliance with GDPR, CCPA, and other privacy laws:</p>
<ul>
<li>Choose from multiple banner layouts and positions.</li>
<li>Customize all colors and text to match your website’s branding.</li>
<li>Add your logo for a professional look.</li>
<li>Multiple button styles to choose from.</li>
</ul>
<h4>Automatic Script Blocking</h4>
<p>WPConsent will automatically prevent many popular tracking scripts from adding cookies on your website to improve GDPR compliance. There’s no need to change the tracking solutions you use in order to use WPConsent. We are continuously adding new scripts to our block list, if you have a specific script you’d like us to block, please <a href="https://wpconsent.com/contact/?utm_source=wprepo&utm_medium=link&utm_campaign=liteplugin" rel="nofollow ugc">reach out</a>.</p>
<p>Automatically detected scripts:</p>
<ul>
<li>Google Analytics</li>
<li>Google Ads</li>
<li>Facebook Pixel</li>
<li>Microsoft Clarity</li>
<li>Pinterest Tag</li>
<li>and many more…</li>
</ul>
<p>Google Consent Mode v2 is now supported, allowing you to use Google Analytics and Google Ads without cookies until the user gives consent. Our integration automatically works whether you add the scripts using <a href="https://wordpress.org/plugins/insert-headers-and-footers/" rel="ugc">WPCode</a>, a plugin like <a href="https://wordpress.org/plugins/google-analytics-for-wordpress/" rel="ugc">MonsterInsights</a> or even if using Google Tag Manager.</p>
<h4>Website Compliance Scanner</h4>
<p>Our goal with WPConsent was to create a WordPress privacy compliance plugin that’s both EASY and POWERFUL.</p>
<p>That’s why we added a built-in website cookie scanner that detects many popular services used on your website.</p>
<p>But that’s not all, with our API integration you can get details about services and cookies used by each service automatically configured on your site.</p>
<p>These are the details included with each service:</p>
<ul>
<li>Service Name</li>
<li>Service Description</li>
<li>Service Category</li>
<li>Service Privacy/Data URL (if 3rd party)</li>
<li>List of Cookies with description and duration</li>
</ul>
<h4>Smart Content Blocking</h4>
<p>Prevent 3rd party content from being loaded before consent is given.</p>
<p>WPConsent can automatically block content like YouTube, Vimeo, DailyMotion, Google Maps, reCAPTCHA and more until the user gives consent.</p>
<p>Dynamic placeholders are displayed for YouTube, Vimeo and DailyMotion for a better user experience. The placeholder images are loaded from your website for improved privacy compliance with GDPR, CCPA, and more.</p>
<p>You can easily customize which content is blocked from the admin area.</p>
<h4>Supports Key Global Privacy Regulations</h4>
<p>The WPConsent plugin offers a high degree of flexibility, making it a valuable tool for addressing a wide array of cookie law, data protection, and privacy regulations. This includes, but is not limited to:</p>
<ul>
<li>GDPR: The General Data Protection Regulation, ePrivacy Directive, ePrivacy Regulation (European Union)</li>
<li>CCPA: The California Consumer Privacy Act (California, United States)</li>
<li>LGPD: The Brazilian General Data Protection Law (Brazil)</li>
<li>AAP: Australia’s Privacy Principles (Australia)</li>
<li>PECR: The Privacy and Electronic Communications Regulations (UK)</li>
<li>PIPEDA: The Personal Information Protection and Electronic Documents Act (Canada)</li>
<li>and many other international standards and laws.</li>
</ul>
<h4>Branding Guideline</h4>
<p>WPConsent™ is a trademark of WPConsent LLC. When writing about the WPConsent plugin, please make sure to uppercase the initial 3 letters.</p>
<p>WPConsent (correct)<br />
WP Consent (incorrect)<br />
wpconsent (incorrect)</p>
<h4>DISCLAIMER</h4>
<p>This plugin is not a guarantee of website compliance. It is your responsibility to ensure your website meets all applicable cookie law requirements with GDPR, CCPA, and other global privacy laws.</p>


WPConsent – Cookie Consent Banner for Privacy Compliance (GDPR / CCPA)


Just installed the free version to take a look. Blindingly fast, zero speed impact. Amazing plugin. Will try pro if I ever develop another website.


Zero effect on page speed


This is an extremely well thought out and designed plugin for important functionality most of us probably don't want to have to deal with. Easy to set up and flexible to make the cookie notice match your site design. I especially like how the plugin can analyze your site and determine which cookies are present.



I'm sure going forward this plugin is going to be on every site I build!


Excellent plugin

Improve WordPress privacy compliance. Custom GDPR / CCPA cookie consent banner, full site cookie scanner, automatic script blocking and cookie policy

WP Consent API vs WPConsent – Cookie Consent Banner for Privacy Compliance (GDPR / CCPA)