├── .gitattributes
├── consent-api-example-plugin.php
├── main.js
├── main.min.js
└── readme.txt


/.gitattributes:
--------------------------------------------------------------------------------
1 | # Auto detect text files and perform LF normalization
2 | * text=auto
3 | 


--------------------------------------------------------------------------------
/consent-api-example-plugin.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Plugin Name: Example plugin for the WP Consent Level API
 4 |  * Plugin URI: https://www.wordpress.org/plugins/wp-consent-api
 5 |  * Description: Example plugin to demonstrate usage of the Consent API
 6 |  * Version: 1.0.0
 7 |  * Text Domain: wp-consent-api
 8 |  * Domain Path: /languages
 9 |  * Author: WP privacy team
10 |  * Author URI:
11 |  */
12 | 
13 | 
14 | $plugin_data = get_file_data( __FILE__, array( 'Version' => 'Version' ), false );
15 | define( 'CONSENT_API_EXAMPLE_PLUGIN_VERSION', $plugin_data['Version'] );$plugin = plugin_basename(__FILE__);
16 | 
17 | /**
18 |  * Tell the consent API we're following the api
19 |  */
20 | add_filter("wp_consent_api_registered_$plugin", function(){return true;});
21 | 
22 | add_action( 'wp_enqueue_scripts', 'example_plugin_enqueue_assets' );
23 | function example_plugin_enqueue_assets( $hook ) {
24 | 	wp_enqueue_script( 'example-plugin', plugin_dir_url(__FILE__) . "main.js", array('jquery'), CONSENT_API_EXAMPLE_PLUGIN_VERSION, true );
25 | }
26 | 
27 | add_shortcode('example-plugin-shortcode', 'example_plugin_load_document');
28 | function example_plugin_load_document($atts = [], $content = null, $tag = '')
29 | {
30 | 	$atts = array_change_key_case((array)$atts, CASE_LOWER);
31 | 	ob_start();
32 | 
33 | 	// override default attributes with user attributes
34 | 	$atts = shortcode_atts(array('category' => 'marketing'), $atts, $tag);
35 | 	//default
36 | 	$category = 'marketing';
37 | 	if (function_exists('wp_validate_consent_category')){
38 | 		$category = wp_validate_consent_category($atts['category']);
39 |     }
40 | 
41 | 	?>
42 | 	<div id="example-plugin-content" data-consentcategory="<?php echo $category?>">
43 | 		<div class="functional-content">
44 | 			<h1>No consent has been given yet for category <?php echo $category?>. </h1>
45 | 		</div>
46 | 		<div class="marketing-content" style="display:none">
47 | 			<h1>Woohoo! consent has been given for category <?php echo $category?> :)</h1>
48 | 		</div>
49 | 
50 | 	</div>
51 | 
52 | 	<?php
53 | 	return ob_get_clean();
54 | }
55 | 


--------------------------------------------------------------------------------
/main.js:
--------------------------------------------------------------------------------
 1 | jQuery(document).ready(function ($) {
 2 |     var consentCategory = $('#example-plugin-content').data('consentcategory');
 3 |     console.log("checking consent for category "+consentCategory);
 4 |     /**
 5 |      * cookie placing plugin can listen to consent change
 6 |      *
 7 |      */
 8 |     console.log("load plugin example");
 9 |     document.addEventListener("wp_listen_for_consent_change", function (e) {
10 |         console.log('listen for consent events');
11 |         var changedConsentCategory = e.detail;
12 |         console.log(changedConsentCategory);
13 |         for (let key in changedConsentCategory) {
14 |             if (changedConsentCategory.hasOwnProperty(key)) {
15 |                 if (key === consentCategory && changedConsentCategory[key] === 'allow') {
16 |                     console.log("set "+consentCategory+" cookie on user actions");
17 |                     activateConsent();
18 |                 }
19 |             }
20 |         }
21 |     });
22 | 
23 |     /**
24 |      * Or do stuff as soon as the consenttype is defined
25 |      */
26 |     $(document).on("wp_consent_type_defined", activateMyCookies);
27 | 
28 |     function activateMyCookies(consentData) {
29 |         console.log("check service");
30 |         if (wp_has_consent(consentCategory, 'service')) {
31 |             console.log("do "+consentCategory+" cookie stuff");
32 |         } else {
33 |             console.log("no "+consentCategory+" cookies please");
34 |         }
35 | 
36 |         console.log("check category")
37 |         //your code here
38 |         if (wp_has_consent(consentCategory)) {
39 |             console.log("do "+consentCategory+" cookie stuff");
40 |         } else {
41 |             console.log("no "+consentCategory+" cookies please");
42 |         }
43 |     }
44 | 
45 |     //check if we need to wait for the consenttype to be set
46 |     if (!window.waitfor_consent_hook) {
47 |         console.log("we don't have to wait for the consent type, we can check the consent level right away!");
48 |         if (wp_has_consent(consentCategory)) {
49 |             activateConsent();
50 |             console.log("set "+consentCategory+" stuff now!");
51 |         } else {
52 |             console.log("No "+consentCategory+" stuff please!");
53 |         }
54 |     }
55 | 
56 |     /**
57 |      * Do stuff that normally would do stuff like tracking personal user data etc.
58 |      */
59 | 
60 |     function activateConsent() {
61 |         console.log("fire "+consentCategory);
62 |         $('#example-plugin-content .functional-content').hide();
63 |         $('#example-plugin-content .marketing-content').show();
64 |     }
65 | });
66 | 


--------------------------------------------------------------------------------
/main.min.js:
--------------------------------------------------------------------------------
1 | jQuery(document).ready(function($){var consentCategory=$("#example-plugin-content").data("consentcategory");console.log("checking consent for category "+consentCategory);console.log("load plugin example");document.addEventListener("wp_listen_for_consent_change",function(e){console.log("listen for consent events");var changedConsentCategory=e.detail;console.log(changedConsentCategory);for(var key in changedConsentCategory){if(changedConsentCategory.hasOwnProperty(key)){if(key===consentCategory&&changedConsentCategory[key]==="allow"){console.log("set "+consentCategory+" cookie on user actions");activateConsent()}}}});$(document).on("wp_consent_type_defined",activateMyCookies);function activateMyCookies(consentData){if(wp_has_consent(consentCategory)){console.log("do "+consentCategory+" cookie stuff")}else{console.log("no "+consentCategory+" cookies please")}}if(!window.waitfor_consent_hook){console.log("we don't have to wait for the consent type, we can check the consent level right away!");if(wp_has_consent(consentCategory)){activateConsent();console.log("set "+consentCategory+" stuff now!")}else{console.log("No "+consentCategory+" stuff please!")}}function activateConsent(){console.log("fire "+consentCategory);$("#example-plugin-content .functional-content").hide();$("#example-plugin-content .marketing-content").show()}});


--------------------------------------------------------------------------------
/readme.txt:
--------------------------------------------------------------------------------
 1 | === Consent API Example plugin ===
 2 | Contributors: RogierLankhorst
 3 | Tags: consent, privacy
 4 | Requires at least: 5.0
 5 | License: GPL2
 6 | Tested up to: 5.3
 7 | Requires PHP: 5.6
 8 | Stable tag: 1.0.0
 9 | 
10 | Simple plugin to demonstrate the usage of the WP Consent API.
11 | 
12 | == Description ==
13 | Usage:
14 | 1) add the shortcode [example-plugin-shortcode category='marketing'] to a page.
15 | 2) Install a plugin with WP Consent API support (e.g. https://github.com/really-simple-plugins/complianz-gdpr)
16 | 3) Install the WP Consent API (http://wordpress.org/plugins/wp-consent-api).
17 | 


--------------------------------------------------------------------------------