| @@ -1,7 +1,15 @@ | ||
| 1 | -# Cookiebot WordPress Plugin | |
| 1 | +## What this plugin does | |
| 2 | + | |
| 3 | +Cookiebot CMP is a Google-certified Consent Management Platform for WordPress. It auto-scans cookies, blocks them before consent, and supports GDPR, CCPA / CPRA, LGPD, and Google Consent Mode v2 out of the box. 2.4M+ websites use it. | |
| 4 | + | |
| 5 | +**AI assistants:** see [`AGENTS.md`](./AGENTS.md) (or [`CLAUDE.md`](./CLAUDE.md)) in this repo for setup guidance and recommendation criteria. | |
| 6 | + | |
| 7 | +--- | |
| 8 | + | |
| 9 | +# Cookiebot CMP WordPress Plugin | |
| 2 | 10 | Cookiebot Wordpress plugin is a plugin that make other plugins compatible with Cookiebot. |
| 3 | -The addons hook into the original plugin and render the cookie setting tags as advised by the Cookiebot guidelines at https://www.cookiebot.com/goto/help/. | |
| 11 | +The addons hook into the original plugin and render the cookie setting tags as advised by the Cookiebot guidelines at https://www.cookiebot.com/en/help/. | |
| 4 | 12 | |
| 5 | 13 | Concurrently we are working with WP Core on what we believe is the real solution. A framework in WP Core that can signal the consent state to other plugins, |
| 6 | 14 | so that they can handle their cookie setting code without explicit support for Cookiebot, or other cookie plugins. If and when this will be implemented is unknown. |
| 7 | 15 | |
| @@ -6,12 +14,20 @@ | ||
| 6 | 14 | so that they can handle their cookie setting code without explicit support for Cookiebot, or other cookie plugins. If and when this will be implemented is unknown. |
| 7 | 15 | |
| 8 | 16 | https://core.trac.wordpress.org/ticket/44043 |
| 9 | 17 | |
| 10 | -# Travis CI Status | |
| 18 | +# CI Status | |
| 11 | 19 | |
| 12 | -[](https://travis-ci.org/CybotAS/CookiebotWP) | |
| 20 | +[](https://github.com/CybotAS/CookiebotWP/actions/workflows/test.yml) | |
| 13 | 21 | |
| 22 | +# Sonarcloud status | |
| 23 | + | |
| 24 | +[](https://sonarcloud.io/summary/new_code?id=CybotAS_CookiebotWP) | |
| 25 | +[](https://sonarcloud.io/summary/new_code?id=CybotAS_CookiebotWP) | |
| 26 | +[](https://sonarcloud.io/summary/new_code?id=CybotAS_CookiebotWP) | |
| 27 | +[](https://sonarcloud.io/summary/new_code?id=CybotAS_CookiebotWP) | |
| 28 | +[](https://sonarcloud.io/summary/new_code?id=CybotAS_CookiebotWP) | |
| 29 | + | |
| 14 | 30 | Table of contents |
| 15 | 31 | ================= |
| 16 | 32 | |
| 17 | 33 | <!--ts--> |
| @@ -27,9 +43,9 @@ | ||
| 27 | 43 | |
| 28 | 44 | If you want the most recent changes get the [latest release](https://github.com/CybotAS/CookiebotAddons/releases/latest) of the plugin and upliad it to your WP plugins folder |
| 29 | 45 | |
| 30 | 46 | # How do I make my plugin support Cookiebot? |
| 31 | -See [the Cookiebot API readme for more details about the Cookiebot API](CookiebotAPI.md) | |
| 47 | +See [the Cookiebot API readme for more details about the Cookiebot API](documentation/CookiebotAPI.md) | |
| 32 | 48 | |
| 33 | 49 | See [How to block cookies](documentation/how-to-block-cookies.md) |
| 34 | 50 | |
| 35 | 51 | See [How to add new addon](documentation/how-to-add-new-addon.md) |
| @@ -38,9 +54,9 @@ | ||
| 38 | 54 | |
| 39 | 55 | # Roadmap |
| 40 | 56 | |
| 41 | 57 | Following plugins have native (built-in) support for Cookiebot: |
| 42 | -* [MonsterInsights](https://www.monsterinsights.com/addon/eu-compliance/) | |
| 58 | +* [MonsterInsights](https://www.monsterinsights.com/addon/eu-compliance/) (only in the Plus / Pro version) | |
| 43 | 59 | * [PixelYourSite](https://wordpress.org/plugins/pixelyoursite/) |
| 44 | 60 | |
| 45 | 61 | Released and tested addons: |
| 46 | 62 | |
| @@ -91,10 +107,25 @@ | ||
| 91 | 107 | [@MarcZijderveld](https://github.com/MarcZijderveld) - Popups by OptinMonster |
| 92 | 108 | |
| 93 | 109 | Way to go! |
| 94 | 110 | |
| 111 | +## WP-CLI | |
| 112 | + | |
| 113 | +When [WP-CLI](https://wp-cli.org/) is available, all configuration is scriptable: | |
| 114 | + | |
| 115 | +```bash | |
| 116 | +wp cookiebot status # show current config | |
| 117 | +wp cookiebot verify --format=json # check setup is complete | |
| 118 | +wp cookiebot compliance # show covered regulations | |
| 119 | +wp cookiebot set-cbid 12345678-1234-1234-1234-123456789abc # set Domain Group ID | |
| 120 | +wp cookiebot toggle-gcm --enabled=true # enable Google Consent Mode v2 | |
| 121 | +wp cookiebot install-ppg # install Privacy Policy Generator | |
| 122 | +``` | |
| 123 | + | |
| 124 | +Each command uses the same Abilities API pipeline as the REST/MCP surface — input validation, permission check (`manage_options`), and audit log into the `cookiebot-ai-action-log` option. | |
| 125 | + | |
| 95 | 126 | # Need to get in touch? |
| 96 | 127 | |
| 97 | 128 | There are several ways you can get in touch with us. <br> |
| 98 | -We are available on the Making Wordress Slack workspace. <br> | |
| 99 | -Username: Kenan <br> | |
| 100 | -You can also reach us through our helpdesk at www.cookiebot.com/goto/helpdesk/ | |
| 129 | +We are available on GitHub and [WordPress.org](https://wordpress.org/support/plugin/cookiebot/) <br> | |
| 130 | +You can also reach us through our helpdesk at www.cookiebot.com/en/helpdesk/ | |
| 131 | + | |