Changeset 3392903

Timestamp:

11/10/2025 11:30:24 AM (5 weeks ago)

Author:

RogierLankhorst

Message:

prepare for 2.0

Location:

wp-consent-api/trunk

Files:

• assets/css/wp-consent-api.css (modified) (2 diffs)
• assets/js/wp-consent-api.js (modified) (6 diffs)
• assets/js/wp-consent-api.min.js (modified) (1 diff)
• readme.md (modified) (1 diff)
• readme.txt (modified) (5 diffs)
• wp-consent-api.php (modified) (13 diffs)

wp-consent-api/trunk/assets/css/wp-consent-api.css

@@ -1 @@
-
-#health-check-accordion-block-wp-consent-api .title{
+#health-check-accordion-block-wp-consent-api .title {
     pointer-events: none;
     font-weight: 600;
@@ -6 +5 @@
     padding-top: 10px;
 }
-#health-check-accordion-block-wp-consent-api .actions{
+
+#health-check-accordion-block-wp-consent-api .actions {
     padding: 20px 0px;
 }
-#health-check-accordion-block-wp-consent-api p{
 
+#health-check-accordion-block-wp-consent-api p {
     background: #fff;
     border-left: 4px solid #fff;
-    box-shadow: 0 1px 1px 0 rgba(0,0,0,.1);
+    box-shadow: 0 1px 1px 0 rgba(0, 0, 0, 0.1);
     margin: 5px 15px 2px;
     padding: 1px 12px;
     border-left-color: #ffb900;
     margin: 5px 20px 15px 0px;
-
 }

wp-consent-api/trunk/assets/js/wp-consent-api.js

@@ -6 +6 @@
  *
  * Edit: chronologically it seems difficult to create a sort of filter for the consent type.
- * Let's change it so cookiebanners are just required to set it, it it's not available, we use a default, as defined here.
+ * Let's change it so cookiebanners are just required to set it, if it's not available, we use a default, as defined here.
  *
  * This way, if a consent management plugin does not define a consenttype, the one passed here will be used, and it will still work.
@@ -17 +17 @@
 
 /**
+ * Check if a specific service has consent
+ * @param {string} service
+ */
+function wp_has_service_consent(service) {
+    //Check if it's in the consented services cookie
+    let consented_services_json = consent_api_get_cookie(consent_api.cookie_prefix + '_' + 'consented_services');
+    let consented_services;
+    try {
+        consented_services = JSON.parse(consented_services_json);
+    } catch (e) {
+        consented_services = {};
+    }
+
+    if ( !consented_services.hasOwnProperty( service ) ){
+        //default to the category
+        const category = wp_get_service_category(service);
+        return wp_has_consent( category );
+    } else {
+        return consented_services[service];
+    }
+}
+/**
+ * Check if a specific service is denied
+ * @param {string} service
+ */
+function wp_is_service_denied( service ) {
+    //Check if it's in the consented services cookie
+    let consented_services_json = consent_api_get_cookie(consent_api.cookie_prefix + '_' + 'consented_services');
+    let consented_services;
+    try {
+        consented_services = JSON.parse(consented_services_json);
+    } catch (e) {
+        consented_services = {};
+    }
+
+    if ( !consented_services.hasOwnProperty( service ) ){
+        return false;
+    } else {
+        return !consented_services[service];
+    }
+}
+
+/**
+ * Set consent for a specific service
+ * @param {string} service
+ * @param {boolean} consented
+ */
+function wp_set_service_consent( service, consented ){
+    let consented_services_json = consent_api_get_cookie(consent_api.cookie_prefix + '_' + 'consented_services');
+    let consented_services;
+    try {
+        consented_services = JSON.parse(consented_services_json);
+    } catch (e) {
+        consented_services = {};
+    }
+    consented_services[service] = consented;
+    consent_api_set_cookie(consent_api.cookie_prefix + '_consented_services', JSON.stringify(consented_services));
+
+    let details = {};
+    details.service = service;
+    details.value = consented;
+    let event = new CustomEvent('wp_consent_api_status_change_service', { detail: details });
+    document.dispatchEvent(event);
+}
+
+
+/**
  * Check if a user has given consent for a specific category.
  *
- * @param {string} category The category to check consent against.
+ * @param {string} category The item to check consent against.
  */
 function wp_has_consent(category) {
-    var consent_type;
-    if (typeof (window.wp_consent_type) !== "undefined"){
+    let has_consent = false;
+    let consent_type;
+    if ( typeof (window.wp_consent_type) !== "undefined" ){
         consent_type = window.wp_consent_type;
     }  else {
@@ -29 +97 @@
     }
 
-    var has_consent_level = false;
-    var cookie_value = consent_api_get_cookie(consent_api.cookie_prefix + '_' + category);
-
-    if (!consent_type) {
+    let cookie_value = consent_api_get_cookie(consent_api.cookie_prefix + '_' + category);
+    if ( !consent_type ) {
         //if consent_type is not set, there's no consent management, we should return true to activate all cookies
-        has_consent_level = true;
-
+        has_consent = true;
     } else if (consent_type.indexOf('optout') !== -1 && cookie_value === '') {
         //if it's opt out and no cookie is set we should also return true
-        has_consent_level = true;
-
+        has_consent = true;
     } else {
         //all other situations, return only true if value is allow
-        has_consent_level = (cookie_value === 'allow');
+        has_consent = (cookie_value === 'allow');
     }
 
-    return has_consent_level;
+    return has_consent;
+}
+
+/**
+ * Retrieve the category of a registered service
+ *
+ * @param {string} service
+ * @returns {string}
+ */
+function wp_get_service_category( service ) {
+    // Check if services array exists and is valid
+    if (!consent_api.services || !Array.isArray(consent_api.services)) {
+        return 'marketing';
+    }
+
+    let services = consent_api.services;
+    for (let i = 0; i < services.length; i++) {
+        if (services[i] &&
+            services[i].name === service &&
+            services[i].category) {
+            return services[i].category;
+        }
+    }
+    return 'marketing';
 }
 
@@ -55 +142 @@
  */
 function consent_api_set_cookie(name, value) {
-    var secure = ";secure";
-    var days = consent_api.cookie_expiration;
-    var date = new Date();
+    let secure = ";secure";
+    let days = consent_api.cookie_expiration;
+    let date = new Date();
     date.setTime(date.getTime() + (days * 24 * 60 * 60 * 1000));
-    var expires = ";expires=" + date.toGMTString();
+    let expires = ";expires=" + date.toGMTString();
 
     if (window.location.protocol !== "https:") secure = '';
@@ -77 +164 @@
     for (var i = 0; i < cookies.length; i++) {
         var cookie = cookies[i].trim();
-        if (cookie.indexOf(name) == 0)
+        if ( cookie.indexOf(name) === 0 )
             return cookie.substring(name.length, cookie.length);
     }
@@ -92 +179 @@
  */
 function wp_set_consent(category, value) {
-    var event;
-    if (value !== 'allow' && value !== 'deny') return;
+    let event;
+    if (value !== 'allow' && value !== 'deny') return;
     var previous_value = consent_api_get_cookie(consent_api.cookie_prefix + '_' + category);
-    consent_api_set_cookie(consent_api.cookie_prefix + '_' + category, value);
-
-    //do not trigger a change event if nothing has changed.
-    if ( previous_value === value ) return;
-
-    var changedConsentCategory = [];
-    changedConsentCategory[category] = value;
-    try {
-        // For modern browsers except IE:
-        event = new CustomEvent('wp_listen_for_consent_change', {detail: changedConsentCategory});
-    } catch (err) {
-        // If IE 11 (or 10 or 9...?)
-        event = document.createEvent('Event');
-        event.initEvent('wp_listen_for_consent_change', true, true);
-        event.detail = changedConsentCategory;
-    }
-    // Dispatch/Trigger/Fire the event
-    document.dispatchEvent(event);
-}
-
-
-
-
-
-
-
-
+    consent_api_set_cookie(consent_api.cookie_prefix + '_' + category, value);
+
+    //do not trigger a change event if nothing has changed.
+    if ( previous_value === value ) return;
+
+    var changedConsentCategory = [];
+    changedConsentCategory[category] = value;
+    try {
+        // For modern browsers except IE:
+        event = new CustomEvent('wp_listen_for_consent_change', {detail: changedConsentCategory});
+    } catch (err) {
+        // If IE 11 (or 10 or 9...?)
+        event = document.createEvent('Event');
+        event.initEvent('wp_listen_for_consent_change', true, true);
+        event.detail = changedConsentCategory;
+    }
+    // Dispatch/Trigger/Fire the event
+    document.dispatchEvent(event);
+}
+
+
+

wp-consent-api/trunk/assets/js/wp-consent-api.min.js

@@ -1 @@
-"use strict";window.wp_fallback_consent_type=consent_api.consent_type;window.waitfor_consent_hook=consent_api.waitfor_consent_hook;function wp_has_consent(category){var consent_type;if(typeof window.wp_consent_type!=="undefined"){consent_type=window.wp_consent_type}else{consent_type=window.wp_fallback_consent_type}var has_consent_level=false;var cookie_value=consent_api_get_cookie(consent_api.cookie_prefix+"_"+category);if(!consent_type){has_consent_level=true}else if(consent_type.indexOf("optout")!==-1&&cookie_value===""){has_consent_level=true}else{has_consent_level=cookie_value==="allow"}return has_consent_level}function consent_api_set_cookie(name,value){var secure=";secure";var days=consent_api.cookie_expiration;var date=new Date;date.setTime(date.getTime()+days*24*60*60*1e3);var expires=";expires="+date.toGMTString();if(window.location.protocol!=="https:")secure="";document.cookie=name+"="+value+secure+expires+";path=/"}function consent_api_get_cookie(name){name=name+"=";var cookies=window.document.cookie.split(";");for(var i=0;i<cookies.length;i++){var cookie=cookies[i].trim();if(cookie.indexOf(name)==0)return cookie.substring(name.length,cookie.length)}return""}function wp_set_consent(category,value){var event;if(value!=="allow"&&value!=="deny")return;var previous_value=consent_api_get_cookie(consent_api.cookie_prefix+"_"+category);consent_api_set_cookie(consent_api.cookie_prefix+"_"+category,value);if(previous_value===value)return;var changedConsentCategory=[];changedConsentCategory[category]=value;try{event=new CustomEvent("wp_listen_for_consent_change",{detail:changedConsentCategory})}catch(err){event=document.createEvent("Event");event.initEvent("wp_listen_for_consent_change",true,true);event.detail=changedConsentCategory}document.dispatchEvent(event)}
+"use strict";function wp_has_service_consent(e){var n=consent_api_get_cookie(consent_api.cookie_prefix+"_consented_services");let t;try{t=JSON.parse(n)}catch(e){t={}}return t.hasOwnProperty(e)?t[e]:wp_has_consent(wp_get_service_category(e))}function wp_is_service_denied(e){var n=consent_api_get_cookie(consent_api.cookie_prefix+"_consented_services");let t;try{t=JSON.parse(n)}catch(e){t={}}return!!t.hasOwnProperty(e)&&!t[e]}function wp_set_service_consent(e,n){var t=consent_api_get_cookie(consent_api.cookie_prefix+"_consented_services");let o;try{o=JSON.parse(t)}catch(e){o={}}o[e]=n,consent_api_set_cookie(consent_api.cookie_prefix+"_consented_services",JSON.stringify(o));t={},t.service=e,t.value=n,e=new CustomEvent("wp_consent_api_status_change_service",{detail:t});document.dispatchEvent(e)}function wp_has_consent(e){let n=!1,t;t=void 0!==window.wp_consent_type?window.wp_consent_type:window.wp_fallback_consent_type;e=consent_api_get_cookie(consent_api.cookie_prefix+"_"+e);return n=!t||-1!==t.indexOf("optout")&&""===e||"allow"===e}function wp_get_service_category(n){if(consent_api.services&&Array.isArray(consent_api.services)){var t=consent_api.services;for(let e=0;e<t.length;e++)if(t[e]&&t[e].name===n&&t[e].category)return t[e].category}return"marketing"}function consent_api_set_cookie(e,n){let t=";secure";var o=consent_api.cookie_expiration,i=new Date,o=(i.setTime(i.getTime()+24*o*60*60*1e3),";expires="+i.toGMTString());"https:"!==window.location.protocol&&(t=""),document.cookie=e+"="+n+t+o+";path=/"}function consent_api_get_cookie(e){e+="=";for(var n=window.document.cookie.split(";"),t=0;t<n.length;t++){var o=n[t].trim();if(0===o.indexOf(e))return o.substring(e.length,o.length)}return""}function wp_set_consent(e,n){let t;if("allow"===n||"deny"===n){var o=consent_api_get_cookie(consent_api.cookie_prefix+"_"+e);if(consent_api_set_cookie(consent_api.cookie_prefix+"_"+e,n),o!==n){o=[];o[e]=n;try{t=new CustomEvent("wp_listen_for_consent_change",{detail:o})}catch(e){(t=document.createEvent("Event")).initEvent("wp_listen_for_consent_change",!0,!0),t.detail=o}document.dispatchEvent(t)}}}window.wp_fallback_consent_type=consent_api.consent_type,window.waitfor_consent_hook=consent_api.waitfor_consent_hook;

wp-consent-api/trunk/readme.md

@@ -9 +9 @@
 **License**: GPL2
 
-**Tested up to**: 5.3
-
-**Requires PHP**: 5.6
+**Tested up to**: 6.8
+
+**Requires PHP**: 7.4
 
 **Stable tag**: 1.0.0

wp-consent-api/trunk/readme.txt

@@ -6 +6 @@
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
 Tested up to: 6.8
-Requires PHP: 7.2
+Requires PHP: 7.4
 Stable tag: 1.0.8
 
@@ -52 +52 @@
 
 Categories and most other stuff can be extended with a filter.
+
+= Service-level consent =
+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.
+
+Service consent can be checked and set both server-side (PHP) and client-side (JavaScript):
+
+PHP:
+`
+//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 );
+`
+
+JavaScript:
+`
+//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 );
+});
 
 ## Existing integrations
@@ -103 +150 @@
 document.dispatchEvent( event );
 
+//dispatch event when consent type is defined
+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');
@@ -151 +202 @@
 }
 `
-Any code suggestions? We're on [GitHub](https://github.com/rlankhorst/wp-consent-level-api) as well!
+Any code suggestions? We're on [GitHub](https://github.com/WordPress/wp-consent-level-api) as well!
 
 == Installation ==
@@ -191 +242 @@
 
 == Changelog ==
+= 2.0.0 =
+* New: Service-level consent API - allows granular consent control per service in addition to category-based consent
+* New: `wp_has_service_consent()` function to check if a specific service has consent
+* New: `wp_is_service_denied()` function to check if a specific service is explicitly denied
+* New: `wp_set_service_consent()` function to set consent for a specific service
+* New: `wp_consent_service_changed` action hook fires when service consent changes
+* New: JavaScript functions `wp_has_service_consent()`, `wp_is_service_denied()`, and `wp_set_service_consent()`
+* New: JavaScript event `wp_consent_api_status_change_service` for service consent changes
+* Improvement: Added type hints throughout codebase for better code quality and IDE support
+* Improvement: Added `init()` method for cleaner plugin initialization
+
 = 1.0.8 =
 * Updated tested up to
 * Dropped loading of translations, and loading of plugin_data, to prevent translation loading notices by WordPress 6.7, props @mujuonly
 * Dropped obsolete function wp_has_cookie_info, props @szepeviktor
-
-= 1.0.7 =
-* Tested up to
 
 = 1.0.7 =

wp-consent-api/trunk/wp-consent-api.php

@@ -2 +2 @@
 /**
  * This file is part of WP Consent API.
- *
- * Copyright 2020 Rogier Lankhorst and the WordPress Core Privacy team.
  *
  * This program is free software: you can redistribute it and/or modify
@@ -25 +23 @@
  * Plugin URI:        https://wordpress.org/plugins/wp-consent-api
  * Description:       Consent Level API to read and register the current consent level for cookie management and improving compliance with privacy laws.
- * Version:           1.0.8
- * Author:            wordpressdotorg
- * Author URI:        https://github.com/rlankhorst/wp-consent-level-api
+ * Version:           2.0.0
+ * Author:            WordPress Contributors
+ * Author URI:        https://github.com/WordPress/wp-consent-level-api
  * Requires at least: 5.0
- * Requires PHP:      5.6
+ * Requires PHP:      7.4
  * License:           GPL2+
  * License URI:       http://www.gnu.org/licenses/gpl-2.0.html
@@ -39 +37 @@
 }
 
-
-if ( ! function_exists( 'wp_consent_api_activation_check' ) ) {
+if ( ! class_exists( 'WP_Consent_API' ) ) {
     /**
-     * Checks if the plugin can safely be activated, at least php 5.6 and wp 5.0
-     *
-     * @since 1.0.0
+     * WP_Consent_API class.
      */
-    function wp_consent_api_activation_check() {
-        global $wp_version;
-
-        if ( version_compare( PHP_VERSION, '5.6', '<' ) ) {
-            deactivate_plugins( plugin_basename( __FILE__ ) );
-            wp_die( esc_html( __( 'This plugin requires PHP 5.6 or higher', 'wp-consent-api' ) ) );
-        }
-
-        if ( version_compare( $wp_version, '5.0', '<' ) ) {
-            deactivate_plugins( plugin_basename( __FILE__ ) );
-            wp_die( esc_html( __( 'This plugin requires WordPress 5.0 or higher', 'wp-consent-api' ) ) );
-        }
-    }
-}
-register_activation_hook( __FILE__, 'wp_consent_api_activation_check' );
-
-if ( ! class_exists( 'WP_CONSENT_API' ) ) {
-    /**
-     * WP_CONSENT_API class.
-     */
-    class WP_CONSENT_API {
+    class WP_Consent_API {
         /**
          * Instance.
@@ -72 +47 @@
          * @since 1.0.0
          *
-         * @var WP_CONSENT_API|null
+         * @var WP_Consent_API|null
          */
         private static $instance;
@@ -79 +54 @@
          * Config.
          *
-         * @var WP_CONSENT_API_CONFIG
+         * @var WP_Consent_API_Config
          */
         public static $config;
@@ -87 +62 @@
          * Site Health Checks.
          *
-         * @var WP_CONSENT_API_SITE_HEALTH
+         * @var WP_Consent_API_Site_Health
          */
         public static $site_health;
@@ -94 +69 @@
          * Cookie info
          *
-         * @var WP_CONSENT_API_COOKIE_INFO
+         * @var WP_Consent_API_Cookie_Info
          */
         public static $cookie_info;
@@ -103 +78 @@
          * @since 1.0.0
          *
-         * @return WP_CONSENT_API
+         * @return WP_Consent_API
          */
         public static function get_instance() {
@@ -110 +85 @@
             }
             return self::$instance;
+        }
+
+        /**
+         * Initialize the plugin.
+         *
+         * @since 1.0.0
+         *
+         * @return void
+         */
+        public static function init(): void {
+            self::get_instance();
         }
 
@@ -123 +109 @@
             $this->includes();
 
-            self::$config      = new WP_CONSENT_API_CONFIG();
-            self::$site_health = new WP_CONSENT_API_SITE_HEALTH();
-            self::$cookie_info = new WP_CONSENT_API_COOKIE_INFO();
+            self::$config      = new WP_Consent_API_Config();
+            self::$site_health = new WP_Consent_API_Site_Health();
+            self::$cookie_info = new WP_Consent_API_Cookie_Info();
         }
 
@@ -139 +125 @@
             define( 'WP_CONSENT_API_PATH', plugin_dir_path( __FILE__ ) );
             define( 'WP_CONSENT_API_PLUGIN', plugin_basename( __FILE__ ) );
-            define( 'WP_CONSENT_API_VERSION', '1.0.8' );
+            define( 'WP_CONSENT_API_VERSION', '2.0.0' );
             define( 'WP_CONSENT_API_PLUGIN_FILE', __FILE__ );
         }
@@ -151 +137 @@
          */
         private function includes() {
-            require_once WP_CONSENT_API_PATH . 'config.php';
-            require_once WP_CONSENT_API_PATH . 'cookie-info.php';
-            require_once WP_CONSENT_API_PATH . 'api.php';
-            require_once WP_CONSENT_API_PATH . 'site-health.php';
-            require_once WP_CONSENT_API_PATH . 'wordpress-comments.php';
+            require_once WP_CONSENT_API_PATH . 'inc/class-wp-consent-api-config.php';
+            require_once WP_CONSENT_API_PATH . 'inc/class-wp-consent-api-cookie-info.php';
+            require_once WP_CONSENT_API_PATH . 'inc/class-wp-consent-api-site-health.php';
+            require_once WP_CONSENT_API_PATH . 'inc/api-functions.php';
+            require_once WP_CONSENT_API_PATH . 'inc/wordpress-comments-functions.php';
         }
     }
@@ -162 +148 @@
      * Load the plugins main class.
      */
-    add_action( 'plugins_loaded', array( WP_CONSENT_API::class, 'get_instance' ), 9 );
+    add_action( 'plugins_loaded', array( WP_Consent_API::class, 'init' ), 9 );
 }