cookiebot
Last commit date
addons
6 years ago
assets
6 years ago
css
6 years ago
documentation
6 years ago
langs
8 years ago
widgets
6 years ago
CookiebotAPI.md
6 years ago
LICENSE.txt
8 years ago
README.md
6 years ago
cookiebot-logo.png
8 years ago
cookiebot.php
6 years ago
phpunit.xml
6 years ago
readme.txt
6 years ago
readme.txt
316 lines
| 1 | # Cookiebot | GDPR Compliant Cookie Consent and Notice # |
| 2 | * Contributors: cookiebot,phpgeekdk,aytac,rvcybot,kh1987,bmlcybot |
| 3 | * Tags: cookie, compliance, eu, gdpr, europe, cookie consent, consent |
| 4 | * Requires at least: 4.4 |
| 5 | * Tested up to: 5.2 |
| 6 | * Stable tag: 3.2.0 |
| 7 | * Requires PHP: 5.6 |
| 8 | * License: GPLv2 or later |
| 9 | |
| 10 | Cookiebot is a fully GDPR & ePrivacy compliant cookie consent solution supporting prior consent, cookie declaration, and documentation of consents. Easy to install, implement and configure. |
| 11 | |
| 12 | ## Description ## |
| 13 | |
| 14 | ### Trustworthy and easy GDPR/ePR compliant cookie consent ### |
| 15 | |
| 16 | Cookiebot is a cloud-driven solution that enables full cookie compliance, offering: |
| 17 | |
| 18 | * A highly customizable consent banner to handle consents and give the users the possibility to opt-in and -out of cookie categories, as required by the GPDR, ePrivacy Directive and similar legislations around the world. |
| 19 | * An automatically generated and updated cookie policy and cookie declaration, with purpose descriptions and categorization of your cookies (Necessary, Statistics, Preferences, Marketing). |
| 20 | * Full monthly website scan, detecting all first and third party cookies and similar tracking on your site (e.g. HTML5 Local Storage, Flash Local Shared Object, Silverlight Isolated Storage, IndexedDB, ultrasound beacons, pixel tags etc.) as well as their provenance, duration and where to the data is sent. |
| 21 | * The unique Cookiebot feature of automatic cookie blocking. All cookies and tracking are automatically held back right from the moment the user lands on the website and until the proper consent has been obtained, enabling compliance with the GDPR and ePrivacy requirement for “prior consent”. |
| 22 | * An easy way to allow the users to change or withdraw their consent. |
| 23 | * Translations for 44 languages and the ability to change the text on the banner and cookie declaration for any language. |
| 24 | * Storage of user consents in our cloud-driven environment, which are downloadable and can be used as proof that the consent was given. |
| 25 | * Execution of cookie-setting scripts without a page reload, if the user gives consent. |
| 26 | |
| 27 | Please read our FAQ at the bottom of the page for more information. |
| 28 | |
| 29 | https://youtube.com/watch?v=t1LJ6i1i9gA |
| 30 | |
| 31 | ### Will my website become compliant once I install Cookiebot? ### |
| 32 | |
| 33 | If you use our plugin version 3.0 or later and chose our automatic implementation, Cookiebot enables full compliance with the ‘prior consent’ requirement of the GDPR, the ePrivacy Directive (ePR) and similar legal instruments for protection of user data around the world. |
| 34 | |
| 35 | The default consent banner has the strictest settings possible and is suitable for obtaining consent under both GDPR and the ePR. Make sure to adapt the consent banner content to fit your website. You should also check out [our GDPR checklist](https://support.cookiebot.com/hc/en-us/sections/360000917513-Ready-for-25-May-2018-GDPR-enforcement-date-A-Cookiebot-checklist-). If you are using server-side cookies, please check the [“Server side usage” guide](https://www.cookiebot.com/en/developer/). |
| 36 | |
| 37 | However, being a customizable plugin, true compliance always depends on the website owner choosing a type of banner, wording and settings that are compliant with the local legislation and fits the specific website and company (controller). |
| 38 | |
| 39 | **If you choose the manual implementation…** |
| 40 | |
| 41 | Then please make sure of the following: |
| 42 | |
| 43 | If you are using plugins that set cookies which require consent (which most do), you have to: |
| 44 | |
| 45 | * Ask the plugin developers if they are planning on becoming GDPR compliant, or if they would like to integrate with Cookiebot. |
| 46 | * Check if there already exists an addon for your plugin in the "Prior consent" submenu. |
| 47 | * [Check out our Github repository](https://github.com/CybotAS/CookiebotAddons), where we are developing integrations for Cookiebot, until the plugin developers choose to do this themselves, [or if WP Core enables such functionality](https://core.trac.wordpress.org/ticket/44043) |
| 48 | |
| 49 | Once Cookiebot is installed, and we've scanned your site, you can check the [cookie report](https://manage.cookiebot.com/goto/reports), to identify all cookies being set on your website. If the cookies are coming from content that you have inserted manually, you can mark up that content [as described in our manual implementation guide step 4](https://cookiebot.com/goto/manual-implementation). |
| 50 | |
| 51 | Embedded videos and iframes which set cookies can be marked up as explained in our [Iframe cookie consent with YouTube example](https://support.cookiebot.com/hc/en-us/articles/360003790854-Iframe-cookie-consent-with-YouTube-example). |
| 52 | |
| 53 | |
| 54 | ### Cookiebot Addons #### |
| 55 | Add-ons are produced by an open-source community of developers. This is done to help make it easier for Wordpress users to implement ‘prior consent’ for cookies and trackers set by plugins that do not offer this as a built-in functionality. |
| 56 | |
| 57 | The add-ons are currently the best alternative to a Wordpress Core framework that can signal the user’s consent state to other plugins (if and when this will be implemented is unknown) and to those plugins who do not yet offer native support for Cookiebot built into the plugin itself. |
| 58 | |
| 59 | We do not assume any responsibility for the use of these add-ons. If one of the plugins that the add-ons hook into makes a ‘breaking change’, there may be a period of time where the add-on will not work properly until it has been updated to accommodate the changes in the plugin. |
| 60 | |
| 61 | If your favourite plugin isn't supported you're welcome to contribute or request on our [Github development page](https://github.com/CybotAS/CookiebotAddons). |
| 62 | |
| 63 | |
| 64 | ## Installation ## |
| 65 | First, install the plugin on your WordPress site. |
| 66 | |
| 67 | Then, go to Settings -> Cookiebot and add your Cookiebot ID. |
| 68 | |
| 69 | If you haven't created one yet - or if you're not sure how to find it - follow the instructions on the page. |
| 70 | |
| 71 | Once your Cookiebot ID is added, the consent dialog will be displayed to the visitors of your site. |
| 72 | |
| 73 | [For more help, visit our support section, that contains various articles on how to set up Cookiebot properly](https://support.cookiebot.com/). |
| 74 | |
| 75 | **Installation video:** |
| 76 | |
| 77 | https://www.youtube.com/watch?v=t1LJ6i1i9gA |
| 78 | |
| 79 | **Implementing the cookie declaration:** |
| 80 | |
| 81 | https://youtu.be/OCXz2bt4H_w |
| 82 | |
| 83 | **Implementing prior consent:** |
| 84 | |
| 85 | Below is a video tutorial on how to manually implement prior consent i.e. holding back all cookies and trackers (other than those strictly necessary for the website to function) until the user has given a consent. The manual implementation guide (found in step 11 of the video) can be [found here](https://cookiebot.com/goto/manual-implementation). |
| 86 | Please note that you can make use of our automatic cookie blocking functionality instead of manually having to mark up the cookie-setting scripts. To do so, update the plugin (version 3.0.0 or higher) and choose automatic cookie control in your Admin panel. |
| 87 | |
| 88 | https://youtu.be/MeHycvV2QCQ |
| 89 | |
| 90 | ## Frequently Asked Questions ## |
| 91 | |
| 92 | ### Is Cookiebot free? ### |
| 93 | Cookiebot is a freemium plugin, much like [Jetpack](https://wordpress.org/plugins/jetpack/) and [Monsterinsights](https://wordpress.org/plugins/google-analytics-for-wordpress/). |
| 94 | |
| 95 | Whether the free plan can suffice or you need a premium plan, depends on two things: |
| 96 | |
| 97 | **1. The size of your website, i.e. the number of subpages on your website.** |
| 98 | In other words, you cannot choose whether you want a free plan or a premium plan, as this is determined by the amount of subpages on your website. You can [get a quote](https://www.cookiebot.com/goto/quote-input/) to see what plan you need for your website. |
| 99 | |
| 100 | **2. Your necessities, as the free plan does not include all features available in the premium plans.** The free plan does not include customization of banner and cookies declaration, multiple languages, e-mail reports, data-export, geo location, bulk consent, consent statistics, internal domain alias for development, test and staging. |
| 101 | |
| 102 | If more than 100 subpages are found during the initial website scan, you will be given a free one-month trial of Cookiebot with full functionality. |
| 103 | |
| 104 | See all details of [Cookiebot plans and pricing](https://www.cookiebot.com/goto/pricing/). |
| 105 | |
| 106 | ### What does Cookiebot count as pages? |
| 107 | Your pricing plan is dependent on the number of subpages we have detected on your website. |
| 108 | |
| 109 | Some users mistakenly think that Cookiebot counts their **image files** as subpages, thus setting the users on a higher subscription plan. |
| 110 | |
| 111 | Cookiebot does **not count image files as subpages**. Depending on your theme, Wordpress may automatically create real pages for content placed in your media library, called Attachment pages. Because these pages can contain online trackers, Cookiebot includes them in your page count. |
| 112 | |
| 113 | To disable the Attachment page feature in Wordpress, please see the following guides: |
| 114 | |
| 115 | https://themeskills.com/disable-media-attachment-pages-wordpress/ |
| 116 | https://www.wpexplorer.com/disable-image-page/ |
| 117 | |
| 118 | ### Cookie declaration ### |
| 119 | The Cookiebot solution also includes an automatically updated cookie declaration about the cookies in use on your site. |
| 120 | |
| 121 | By implementing it, you ensure that your cookie declaration is specific and accurate at all times, as required by the GDPR. Also, the declaration automatically provides the mandatory options for the user to change or withdraw consent. |
| 122 | |
| 123 | To display your cookie declaration, create a new page on your website - and add the shortcode that the plugin provides to the page: [cookie_declaration]. Alternatively, you can incorporate it into e.g. your existing Privacy Policy. |
| 124 | |
| 125 | By default, the cookie declaration is displayed in the chosen Cookiebot language. You are able to override this setting with a "lang" attribute in the shortcode. Eg.: [cookie_declaration lang="de"] for a German version. Remember to add all used languages in the [Cookiebot Manager](https://manage.cookiebot.com). |
| 126 | |
| 127 | https://youtu.be/OCXz2bt4H_w |
| 128 | |
| 129 | ### Cookie-checker: What cookies are in use on my site? ### |
| 130 | If you are in doubt about what cookies are in use on our site, you can start by trying our free compliance test: |
| 131 | |
| 132 | **[Test my site](https://www.cookiebot.com/)** |
| 133 | |
| 134 | The test scans up to five pages of your website and sends you a complete report of the cookies and online tracking on these pages, including information on their provenance, purpose and whether or not they are compliant with EU-legislation. |
| 135 | |
| 136 | If you want a complete overview of the cookies and online tracking going on on all of your website, sign up to the Cookiebot solution. |
| 137 | |
| 138 | ### What is the GDPR and the ePrivacy Directive? ### |
| 139 | The GDPR is the General Data Protection Regulation, an EU-law enforced since May 2018, that protects EU citizens’ personal data globally and affects all organizations and websites that handle such data. If you have a website with users from the EU, and if your websites uses cookies (it probably does), then you need to make your use of cookies and tracking compliant with the GDPR. |
| 140 | |
| 141 | See the [EU homepage of the GDPR](https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=celex%3A32016R0679) for more information, and their infographic for businesses: [Data Protection: Better rules for small businesses](http://ec.europa.eu/justice/smedataprotect/index_en.htm) |
| 142 | |
| 143 | The ePrivacy Directive is another legal instrument of the EU that specifically aims to protect EU citizens’ online data such as data from online communication. It is in the process of becoming an actual Regulation such as the GDPR, which will probably happen in 2020. |
| 144 | |
| 145 | ### How do I make other plugins support Cookiebot? ### |
| 146 | If your favourite plugin doesn't support Cookiebot you are always welcome to ask the author to add support for Cookiebot. |
| 147 | |
| 148 | Send an e-mail to the author of the plugin you want to support Cookiebot. Ask for adding support for Cookiebot. Cookiebot provides a helper function to check if there is an active, working version of Cookiebot on the website. |
| 149 | |
| 150 | The easiest way for a developer to implement Cookiebot support is following to add a check for Cookiebot where <script> tags are outputted to the visitor. This can be done following way |
| 151 | |
| 152 | $scriptTag = '<script>'; |
| 153 | if(function_exists('cookiebot_active') && cookiebot_active()) { |
| 154 | $scriptTag = '<script'.cookiebot_assist('statistics').'>'; |
| 155 | } |
| 156 | |
| 157 | The developer of the plugin can see more details on [our Github repository](https://github.com/CybotAS/CookiebotAddons) |
| 158 | |
| 159 | ### Can I use Cookiebot with GTM? ### |
| 160 | Cookiebot works with GTM, however you need to enable the "Hide Cookie Popup" option on the Cookiebot plugin settings page. |
| 161 | |
| 162 | [Please see our article on how to deploy Cookiebot with GTM](https://support.cookiebot.com/hc/en-us/articles/360003793854-Google-Tag-Manager-deployment). |
| 163 | |
| 164 | |
| 165 | ## Changelog ## |
| 166 | |
| 167 | ### 3.2.0 - 2019-10-29 ### |
| 168 | * Adding fix for conflict with Elementor Page Builder when Cookie blocking is in auto mode |
| 169 | * Adding fix for conflict with Divi Builder when Cookie blocking is in auto mode (still need to disable Cookiebot on admin pages to work properly). |
| 170 | * Minor adjustments to code style and unit tests |
| 171 | |
| 172 | ### 3.1.0 - 2019-09-24 ### |
| 173 | * Change option to hide cookie banner in WP Admin to instead disabling Cookiebot |
| 174 | * Set option to disable Cookiebot banner as default for new installs |
| 175 | |
| 176 | ### 3.0.1 - 2019-09-17 ### |
| 177 | * Clean up setting page |
| 178 | * Fixing failing addons after plugin updates |
| 179 | |
| 180 | ### 3.0.0 - 2019-09-10 ### |
| 181 | * Adding support for auto cookie blocking mode |
| 182 | |
| 183 | ### 2.5.0 - 2019-06-12 ### |
| 184 | * Add support for custom regex for embed autocorrect |
| 185 | * Adding Cookie Declaration widget |
| 186 | * Remove support for PHP 5.4 |
| 187 | |
| 188 | ### 2.4.4 - 2019-05-22 ### |
| 189 | * Minor bugfixes in Embed Autocorrect addon |
| 190 | |
| 191 | ### 2.4.3 - 2019-05-16 ### |
| 192 | * Fix bug in Embed Autocorrect addon. |
| 193 | |
| 194 | ### 2.4.2 - 2019-05-15 ### |
| 195 | * Adding addthis addon |
| 196 | * Disable default autoupgrade |
| 197 | * Minor fixes |
| 198 | |
| 199 | ### 2.4.1 - 2019-03-19 ### |
| 200 | * Fix jetpack related warning |
| 201 | |
| 202 | ### 2.4.0 - 2019-03-19 ### |
| 203 | * Fixed bug resulting in some tags where not tagged |
| 204 | * Change Piwik addon to use output buffering |
| 205 | * Clean up redundant code in addons |
| 206 | |
| 207 | ### 2.3.0 - 2019-03-13 ### |
| 208 | * Added GADWP addon |
| 209 | * Changes in file structure of plugin |
| 210 | |
| 211 | ### 2.2.2 - 2019-02-12 ### |
| 212 | * Fix warning non-static call to get_cbid |
| 213 | |
| 214 | ### 2.2.1 - 2019-02-12 ### |
| 215 | * Adding support for WPForms |
| 216 | * Add plugin deactivation hook for addons |
| 217 | |
| 218 | ### 2.2.0 - 2019-02-11 ### |
| 219 | * Adding support for network wide settings on Multisite Wordpress setups. |
| 220 | |
| 221 | ### 2.1.5 - 2019-01-17 ### |
| 222 | * New addon: Custom Facebook Feed Pro |
| 223 | * Adding support for setting none, defer or async to Cookiebot script tags |
| 224 | |
| 225 | ### 2.1.3 - 2018-11-18 ### |
| 226 | * New addon: Popups by OptinMonster |
| 227 | * Added support for grouping addons for different versions of same plugin |
| 228 | |
| 229 | ### 2.1.2 - 2018-11-06 ### |
| 230 | * Auto correct addon added support for single quotes in iframe embeds |
| 231 | |
| 232 | ### 2.1.1 - 2018-11-02 ### |
| 233 | * Updated addons with new tests and better plugin integration |
| 234 | |
| 235 | ### 2.1.0 - 2018-10-05 ### |
| 236 | * Updated addons improved handling of tags |
| 237 | * Adding Basque as language option |
| 238 | * Remove .git files in addons |
| 239 | |
| 240 | ### 2.0.6 - 2018-09-26 ### |
| 241 | * Updated addons to support newest version of CAOS |
| 242 | * Minor bugfixes and text adjustments |
| 243 | |
| 244 | ### 2.0.5 - 2018-09-21 ### |
| 245 | * Added "Leave a review" admin notice |
| 246 | |
| 247 | ### 2.0.4 - 2018-09-18 ### |
| 248 | * Added [IAB Consent Framework](https://support.cookiebot.com/hc/en-us/articles/360007652694-Cookiebot-and-the-IAB-Consent-Framework) option |
| 249 | * Update Cookiebot Addons |
| 250 | * Minor bugfixes |
| 251 | |
| 252 | ### 2.0.3 - 2018-08-10 ### |
| 253 | * Removing informative message in admin_notice. Causing parse error for some users. |
| 254 | |
| 255 | ### 2.0.2 - 2018-08-01 ### |
| 256 | * Quickfix - disable Script Config. Made trouble for some users. |
| 257 | |
| 258 | ### 2.0.1 - 2018-08-01 ### |
| 259 | * Disable load of Addons if server runs PHP < 5.4. |
| 260 | * Fix placeholder in addons |
| 261 | |
| 262 | ### 2.0.0 - 2018-07-30 ### |
| 263 | * Merge Cookiebot and Cookiebot Addons plugins. Cookiebot plugin now bundled with addons making other plugins GDPR compliant. |
| 264 | |
| 265 | ### 1.6.2 - 2018-06-21 ### |
| 266 | * Fix check for WP Rocket. |
| 267 | |
| 268 | ### 1.6.1 - 2018-06-11 ### |
| 269 | * Fixing shortcode when using WP Rocket |
| 270 | |
| 271 | ### 1.6.0 - 2018-05-30 ### |
| 272 | * Support for removing cookie consent banner for tag manager users |
| 273 | * Support for multiple consent types in cookie_assist - eg. cookie_assist(['marketing','statistics']); |
| 274 | * Loading Cookiebot JS on admin pages too |
| 275 | * Adjusting help texts and adding links to demonstration videos. |
| 276 | |
| 277 | ### 1.5.1 - 2018-05-25 ### |
| 278 | * Adjusting readme.txt including new video |
| 279 | |
| 280 | ### 1.5.0 - 2018-05-22 ### |
| 281 | * Adding autoupdate for Cookiebot |
| 282 | |
| 283 | ### 1.4.2 - 2018-05-17 ### |
| 284 | * Fix undefined $lang bug in shortcode output |
| 285 | |
| 286 | ### 1.4.1 - 2018-05-11 ### |
| 287 | * Adjusting readme file |
| 288 | |
| 289 | ### 1.4.0 - 2018-05-10 ### |
| 290 | * Adding support for specifying language of cookie banner |
| 291 | * Adding optional "lang" attribute to [cookie_declaration] shortcode |
| 292 | |
| 293 | ### 1.3.0 - 2018-04-29 ### |
| 294 | * Bug fixed: Headers already sent when editing pages using shortcode |
| 295 | |
| 296 | ### 1.2.0 - 2018-03-28 ### |
| 297 | * Updating readme file with more details |
| 298 | * Adding cookiebot_active helper function |
| 299 | |
| 300 | ### 1.1.2 - 2018-02-27 ### |
| 301 | * Removing short array syntax to improve compatibility |
| 302 | |
| 303 | ### 1.1.1 - 2018-02-02 ### |
| 304 | * Adjusting readme.txt |
| 305 | |
| 306 | ### 1.1.0 - 2018-02-02 ### |
| 307 | * Adding data-culture to cookiebot script tags. |
| 308 | |
| 309 | ### 1.0.0 ### |
| 310 | * Initial release of the plugin. |
| 311 | |
| 312 | |
| 313 | ## Copyright and Trademarks ## |
| 314 | |
| 315 | Cookiebot is a registered trademark of Cybot A/S |
| 316 |