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.

sharanusb1234

<p>The Cookie Banner Integration for Neokred plugin automatically adds cookie consent and management scripts to your WordPress website. It provides an easy-to-use admin interface for managing your cookie compliance without requiring any coding knowledge.</p>
<p>This plugin integrates with the Neokred cookie management service to display cookie consent banners and manage user preferences in compliance with GDPR, CCPA, and other privacy regulations.</p>
<h4>Features</h4>
<ul>
<li>Easy Integration: Simply enter your Domain ID from Neokred dashboard</li>
<li>Admin Dashboard: User-friendly settings page in WordPress admin</li>
<li>DPDP Ready: Helps ensure compliance with privacy regulations</li>
<li>Local File Loading: Scripts are included locally in the plugin for better performance and security</li>
<li>Automatic Loading: Scripts are loaded properly using WordPress standards</li>
<li>Visual Status: See if your integration is active or needs configuration</li>
<li>Settings Link: Quick access to settings directly from the plugins page</li>
<li>Secure: Implements nonces, capability checks, and proper escaping</li>
<li>Debug Mode: Built-in debugging for administrators to troubleshoot issues</li>
<li>File Validation: Automatic checks to ensure SDK file is present</li>
<li>Cache Busting: Automatic version control for script updates</li>
<li>Async Loading: Optimized script loading for better performance</li>
</ul>
<h4>How It Works</h4>
<ol>
<li>Sign up for a Neokred cookie management account</li>
<li>Get your unique Domain ID from the Neokred dashboard</li>
<li>Enter the Domain ID in the plugin settings</li>
<li>Click “Save Changes”</li>
<li>The cookie banner appears automatically on your website</li>
</ol>
<p>The plugin uses WordPress best practices to properly enqueue the Neokred banner SDK script from local files, ensuring optimal performance and security.</p>
<h4>Third-Party Service Notice</h4>
<p>This plugin connects to the Neokred cookie management service. When you use this plugin:<br />
– The banner SDK script is loaded locally from the plugin files<br />
– User consent choices may be transmitted to Neokred servers for management<br />
– The service may store cookies to remember user preferences</p>
<p>By using this plugin, you acknowledge that you have reviewed and agree to:<br />
– Neokred’s terms of service<br />
– Neokred’s privacy policy<br />
– The use of this third-party service on your website</p>
<p>No user data is sent to third parties without explicit consent action by the website visitor.</p>
<h3>Configuration</h3>
<p>After activation:</p>
<ol>
<li>Go to Settings > Cookie Banner in your WordPress admin</li>
<li>Enter your Domain ID (get this from your Neokred dashboard)</li>
<li>Click “Save Changes”</li>
<li>Check the “Integration Status” section to verify the SDK file is found</li>
</ol>
<p>Example Domain ID format:<br />
    add7342a-d335-407f-a570-01eafdcd1c19</p>
<p><strong>Note</strong>: You must have a Neokred account to get your Domain ID. Visit neokred.tech to sign up.</p>
<h3>Privacy Policy</h3>
<p>This plugin integrates with the Neokred cookie management service, which is a third-party service.</p>
<p><strong>What This Plugin Does:</strong><br />
– Loads the Neokred banner SDK locally from the plugin directory<br />
– Stores your Domain ID in your WordPress database<br />
– Does not collect any user data itself<br />
– Does not make external calls except for Neokred service functionality</p>
<p><strong>What the Neokred Service Does:</strong><br />
– Displays cookie consent banners to your website visitors<br />
– May store cookies to remember user consent preferences<br />
– May transmit consent choices to Neokred servers<br />
– Collects data according to Neokred’s privacy policy</p>
<p><strong>Your Responsibilities:</strong><br />
– Review Neokred’s privacy policy and terms of service<br />
– Ensure your use complies with applicable privacy laws (GDPR, CCPA, etc.)<br />
– Configure your Neokred settings appropriately for your jurisdiction<br />
– Update your website’s privacy policy to mention the use of this service</p>
<p>For more information about how Neokred handles data, please visit their website and review their privacy documentation.</p>
<h3>Support</h3>
<p>For plugin-related questions:<br />
– Review the FAQ section above<br />
– Check the detailed instructions in Settings > Cookie Banner<br />
– Use the built-in debug mode (visible to administrators in page source)<br />
– Check the troubleshooting section in the admin dashboard</p>
<p>For Neokred service support:<br />
– Visit the Neokred website<br />
– Contact Neokred support through their official channels</p>
<h3>External Services</h3>
<p>This plugin relies on the following external service:</p>
<p><strong>Neokred Cookie Management Service</strong><br />
– Purpose: Provides cookie consent banner and preference management<br />
– Data Handling: User consent preferences may be transmitted and stored<br />
– Required: Yes, a Neokred account is required to use this plugin</p>
<p>The banner SDK is included locally in the plugin and does not require external CDN services.</p>
<p>By using this plugin, you acknowledge and agree to the use of the Neokred service.</p>
<h3>Troubleshooting</h3>
<h4>Script Not Loading</h4>
<ol>
<li>Check Settings > Cookie Banner in your WordPress admin</li>
<li>Verify the “SDK File Status” shows “✓ Found”</li>
<li>If file is missing, re-upload the plugin with the complete assets folder</li>
<li>View your website’s page source and look for debug comments at the bottom</li>
<li>Check browser console (F12) for JavaScript errors</li>
</ol>
<h4>File Permission Issues</h4>
<p>Ensure proper file permissions:<br />
– Folders: 755<br />
– Files: 644</p>
<h4>WordPress.com Staging Issues</h4>
<p>WordPress.com staging sites have additional security restrictions. The debug mode will help identify specific issues. Contact WordPress.com support if security policies are blocking the script.</p>
<h4>Cache Issues</h4>
<p>Clear your cache after:<br />
– Installing or updating the plugin<br />
– Changing the Domain ID<br />
– Updating the banner-sdk.js file</p>
<p>Compatible caching plugins will automatically handle cache invalidation due to version control.</p>
<h3>License</h3>
<p>This plugin is licensed under the GPLv2 or later.</p>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>


Cookie Banner Integration for Neokred

Integrates Neokred cookie management scripts into WordPress websites for DPDP compliance with easy admin configuration.

WP Consent API vs Cookie Banner Integration for Neokred