This repository has been archived by the owner on Mar 30, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathreadme.txt
113 lines (73 loc) · 8.05 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
=== WP GDPR Cookie Notice ===
Contributors: flixos90
Requires at least: 4.9.6
Tested up to: 5.8
Requires PHP: 7.0
Stable tag: 1.0.0-rc.2
License: GNU General Public License v2 (or later)
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Tags: gdpr, cookie notice, cookie consent, amp, web stories, granular cookie control, customizer
Simple performant cookie consent notice that supports AMP, Web Stories, granular cookie control and live preview customization.
== Description ==
This plugin adds a simple performant cookie consent notice to your WordPress site that supports [AMP](https://wordpress.org/plugins/amp/), [Web Stories](https://wordpress.org/plugins/web-stories/), granular cookie control and live preview customization.
Not only does the notice allow you to provide the regular message that your site uses cookies, you can also optionally grant your site visitors permission to granularly allow which cookie types are allowed, supporting groups of functional (always required), preferences, analytics and marketing cookies. This aims towards compliance with how the new GDPR regulations recommend implementing cookie control for your site.
In addition to the Privacy Policy page setting that WordPress core provides, you also get a settings to optionally set an extra Cookie Policy page, and you can easily link to either of them from the cookie consent notice.
The cookie notice content and appearance can easily be tweaked using the Customizer, with an immediate live-preview of what your changes will look like.
Last but not least, another important thing that this plugin takes care of, other than most other cookie consent plugins, is that it actually ensures cookies are only placed if the respective cookie type has been allowed by the visitor. The plugin does this by implementing cookie rules for WordPress itself, and also for the following plugins:
* [AMP](https://wordpress.org/plugins/amp/)
* [Google Analytics for WordPress by MonsterInsights](https://wordpress.org/plugins/google-analytics-for-wordpress/)
* [Jetpack](https://wordpress.org/plugins/jetpack/)
* [Simple Analytics](https://wordpress.org/plugins/simple-analytics/)
* [Site Kit by Google](https://wordpress.org/plugins/google-site-kit/)
More plugins will be supported in the future. If you are a developer though, it's also very easy to add cookie rules for other code, by using the flexible cookie rule component the plugin provides as an extension point.
= Feature Summary =
* **Lightweight and easy-to-use:** Simply activate the plugin, and the notice will appear.
* **Live Preview:** Use the Customizer to adjust the notice to your needs, with an instant live preview.
* **Customizable Appearance:** Specify the notice position, colors, border, button size and more.
* **Customizable Content:** Adjust the notice heading, text and button label to your preferences. You can easily link to your cookie policy page or privacy policy page, and even give visitors granular control about which cookie types they allow.
* **Cookie Policy Support:** Define an optional cookie policy page if your site has one, or alternatively provide an ID attribute to the cookie section in your privacy policy.
* **Cookie Integrations:** Supported cookies are only set once the visitor has given their consent. The cookie rules implemented also respect the more granular cookie control.
* **JavaScript-driven:** The cookie notice is inserted into the page as necessary via JavaScript, but at the same time provides easy access to whether it should be displayed via its PHP API.
* **AMP Support:** The notice is fully AMP-compatible using `<amp-consent>`, integrating seamlessly with the [AMP plugin](https://wordpress.org/plugins/amp/). It integrates with [Web Stories](https://wordpress.org/plugins/web-stories/) as well.
* **Coding Best Practices:** The plugin is fully object-oriented and is coded after best practices, such as using interfaces, traits, dependency injection or the single responsibility principle. It also implements modern coding features requiring PHP 7, such as scalar type hints or return type hints.
= Disclaimer =
This plugin does not provide any legal protection. You as a site administrator are required to ensure that it meets legal standards. This plugin is a technical tool, not a lawyer.
== Installation ==
1. Upload the entire `wp-gdpr-cookie-notice` folder to the `/wp-content/plugins/` directory or download it through the WordPress backend.
2. Activate the plugin through the 'Plugins' menu in WordPress.
== Frequently Asked Questions ==
= Where are the plugin settings? =
Since the settings of the plugin are mostly of visual nature, the plugin does not have any settings page, but uses exclusively the Customizer. You can easily reach the plugin's Customizer panel either by using the link in the Settings menu or the link in the plugin's row on the Plugins screen.
= Which filters are available? =
You can use the following filters:
* `wp_gdpr_cookie_notice_max_content_width`: Filters the maximum width of the cookie notice content. By default, the `$content_width` global is used to determine this value, with a fallback of '640px' if none is defined.
* `wp_gdpr_cookie_notice_heading_level`: Filters the heading level to use for the cookie notice heading. Default is 'h2'.
= Where should I submit my support request? =
For regular support requests, please use the [wordpress.org support forums](https://wordpress.org/support/plugin/wp-gdpr-cookie-notice). If you have a technical issue with the plugin where you already have more insight on how to fix it, you can also [open an issue on Github instead](https://github.com/felixarntz/wp-gdpr-cookie-notice/issues).
= How can I contribute to the plugin? =
If you have some ideas to improve the plugin or to solve a bug, feel free to raise an issue or submit a pull request in the [Github repository for the plugin](https://github.com/felixarntz/wp-gdpr-cookie-notice). Please stick to the [contributing guidelines](https://github.com/felixarntz/wp-gdpr-cookie-notice/blob/master/CONTRIBUTING.md).
You can also contribute to the plugin by translating it. Simply visit [translate.wordpress.org](https://translate.wordpress.org/projects/wp-plugins/wp-gdpr-cookie-notice) to get started.
== Screenshots ==
1. The cookie notice with its default content and appearance
2. Customizing the cookie notice behavior and content
3. Customizing the cookie notice appearance
== Changelog ==
= 1.0.0-rc.2 =
* Introduce filter `wp_gdpr_cookie_notice_amp_use_submission_endpoint` to allow disabling usage of the form submission endpoint for cookie consent preferences in AMP.
= 1.0.0-rc.1 =
* Add support for cookie notice to show up in [Web Stories](https://wordpress.org/plugins/web-stories/).
* Add integration for blocking AdSense tags via [Site Kit by Google](https://wordpress.org/plugins/google-site-kit/) and improve the existing Analytics integration as well, relying on [Site Kit's tag blocking API](https://github.com/google/site-kit-wp/issues/2087).
* Add support for cookie notice to show up in AMP legacy theme / reader mode.
* Fix bug where accepting the cookie notice on the WordPress login screen was not working when the AMP plugin is active.
* Remove usage of `!important` in cookie notice CSS since it is bad practice and can get flagged by AMP.
* Update default settings so that the integrations are opt-in, i.e. disabled by default.
* Fix bug where the AMP version of the cookie notice form was unexpectedly used in Customizer previews.
= 1.0.0-beta.3 =
* Add cookie integration support for the [Site Kit by Google plugin](https://wordpress.org/plugins/google-site-kit/).
* Introduce filter `wp_gdpr_cookie_notice_amp_use_endpoint` to allow disabling usage of the `checkConsentHref` endpoint relevant for `amp-consent`. Props claudiulodro.
* Fix bug with deprecated `amp-consent` attribute. Props claudiulodro.
* Support current Lighthouse user agent so that the consent is skipped for it.
= 1.0.0-beta.2 =
* Fix incompatibility with [PWA plugin](https://wordpress.org/plugins/pwa/), previously causing the service worker to be broken.
= 1.0.0-beta.1 =
* Initial beta release.