Use the [cookies] shortcode to produce a table of all the cookies your WordPress site uses; showing cookie name, category, description and duration.
In April 2012 the International Chamber of Commerce (ICC) UK issued the ICC UK cookie guide ( a 15-page / 296KB PDF report ).
The guidance, which has been welcomed by the Information Commissioner’s Office (ICO), contains information on the different categories of cookies that website operators use.
This wording includes: A list of all the cookies used in this website by category is set out below.
This plugin will help you to create the list.
By default the list is dynamically generated taking into account the active plugins on the website.
This plugin does not implement anything to help you obtain the user’s consent to place a cookie on their device.
There are other plugins to help you do that.
Use in conjunction with oik-privacy-policy
If you want to read more about the oik plugins then please visit the
“the oik plugin – for often included key-information”
This version of the plugin is provided free of charge to the WordPress community.
Its purpose is to help with the creation of your cookie catalog.
We accept no responsibility for ensuring the correctness of the information displayed.
Don’t have a go at us if your cookies are not listed or are “unknown”.
- Upload the contents of the cookie-cat plugin to the `/wp-content/plugins/cookie-cat’ directory
- Activate the cookie-cat plugin through the ‘Plugins’ menu in WordPress
- Visit oik options > cookie cat page and perform the following steps
- Click on the Load XML button. A temporary XML file will be loaded for your active plugins
- Check the ‘Use temp XML file?’ checkbox and click on Redisplay. The cookie catalog may change. If there are “unknown” see the FAQ
- Click on the Save XML button to update the Latest XML file to the Latest loaded.
Note: cookie-cat is dependent upon the oik plugin. You can activate it but it will not work unless oik is also activated.
Download oik from oik download
Also known as the EU e-Privacy Directive the “UK Privacy and Electronic Communications Regulation” becomes effective in the UK on 26th May 2012.
That’s the date when the Information Commissioner’s Office (ICO) is due to begin enforcing the new rules.
Who does it apply to?
What should we do about it?
Steps to take:
This plugin helps with step 2.
Here’s a simple list.
- Strictly necessary cookies – these cookies enable services you have specifically asked for
- Performance cookies – these cookies collect anonymous information on the pages visited
- Functionality cookies – these cookies remember choices you make to improve your experience
- Targeting cookies or advertising cookies – these cookies collect information about your browsing habits in order to make advertising relevant to you and your interests.
For more information see cookie-cat or read the ICC UK Cookie guide
You need to activate both the oik plugin and the cookie-cat plugin.
And check the syntax of the shortcode.
The list of cookies that this plugin recognises may never be a complete list of all known cookies.
If your website delivers cookies that are not recognised then the cookie category, description and duration will be shown as “unknown”.
This is not really acceptable as the guidelines state that you’re supposed to explain “how they are used on the websites they visit”.
There are several ways to address this problem.
- Do nothing. NOT recommended.
- Add a caveat saying something like “the exact purpose of the cookie has not yet been ascertained. If you are concerned please contact us for more information.”
- Remove the unknown items from the table.
- Find out what the unknown cookies are; then update the output with the correct information.
- Stop using the plugin/theme or service that delivers the “unknown” cookie
- Let cookie-cat know you have an “unknown” cookie, wait for an update and retry.
- Raise an issue if there is a bug in the code.
How do I add a caveat?
How do I remove the items from the table
- Override the default logic to select the plugins you want processed
- Override the default logic to select the cookies you want listed
- Edit the generated HTML
- Programmatically, using the “cookies” filter
- A combination of the above
How do I update the output?
The [cookies] shortcode queries information from an XML file that contains the known information about a cookie.
If you think it’s wrong then you can do one or more of the following:
- save the HTML generated by the [cookies] shortcode and edit it manually
- change the XML file
- develop a “filter” to alter the data before it’s displayed
How do I save the generated HTML
Use the “oik options > shortcode help” page, select the [cookies] entry then copy the generated “snippet”
You may then wish to de-activate the cookie-cat plugin until you next change the installed plugins.
How do I change the XML file?
From version 1.1 the XML file can be loaded directly from the cookie-cat website.
Use oik options > cookie cat and follow the instructions in the Installation section
Note that using the Load XML function passes the names of currently active cookies to the cookie-cat server.
By using the function you authorize cookie-cat to the information that is passed.
What is the source of the XML file’s data
It comes from the cookie-cat website.
- Use the cookie cat admin page to load an XML file tailored to your site.
- The XML file delivered with the plugin was generated from the data held in the cookie-cat website.
- This XML file is no longer being updated when a new version of the plugin is released
Yes. Use [cookies browser=Y]
browser=”N|Y – show browser cookies”
cookies=”|cookie1,cookie2 – Optional list of cookie names.”
plugins=”|plugin1,plugin2 – Optional list of plugin names. Defaults to ALL active plugins”
temp=”N|Y – Use the temporary cc_mapping XML file”]
Where can I find out more?
If you are in the UK you should see the ICC UK Cookie Guide
Also have a look at the links on the cookie-cat website.
Contributors and Developers
“cookie-cat” is open source software. The following people have contributed to this plugin.Contributors
Translate “cookie-cat” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
- Changed: Update for PHPUnit 8,[github bobbingwide cookie-cat issues 4]
- Tested: With WordPress 5.3.2 and WordPress Multi Site
- Tested: With PHP 7.3 and PHP 7.4
- Tested: With PHPUnit 8
- Changed: Depends on oik v3.2.8, [github bobbingwide cookie-cat issues 3]
- Changed: Uses https to Load the XML file from cookie-cat.co.uk
- Changed: Uses https for link to cookie-cat.co.uk design
- Tested: With WordPress 5.0
- Tested: With Gutenberg 4.6.1
- Changed: Priority for ‘admin_notices’ hook
- Changed: Now depends on oik v3.1
- Tested: With PHP 7.1
- Tested: With WordPress 4.8 and WordPress Multisite
- Fixed: Issue #2
- Changes: Merged pull request from jherve – __qca no longer used by Jetpack
- Changes: Updated FAQ in line with oik-plugins and cookie-cat websites
- Changed: Now depends on oik v2.5
- Tested: With WordPress 4.4
- Changed: Improved some docblock comments and changed Copyright date on source files
- Changed: Updated oik-activation logic
- Changed: Improved some docblocks.
- Changed: Now depends on oik v2.2
- Changed: Responds to “oik_add_shortcodes” action to define the “cookies” shortcode
- Tested: With WordPress 4.0
- Changed: Slight restructuring for improved documentation
- Changed: Now dependent upon oik v2.1 or higher
- Added: Warning messages about information that is passed to the cookie-cat server when using “Load XML”
- Tested: Works with WordPress 3.6
- Added: Added table heading tags for the cookie-cat table.
- Added: admin interface to load a new customised XML file from cookie-cat.co.uk
- Added: will now produce links to prompt installation, upgrade or activation of oik
- Added: temp=N|Y parameter for the [cookies] shortcode to advanced users to play with the “Extras” field
- Added: option field to set browser=Y by default
- Added: Extras field for adding special codes for plugins which aren’t really active. Defaults to “,wordpress,PHP”
- Changed: cc_mapping.xml file updated to reflect latest mapping in cookie-cat.co.uk
- Changed: readme.txt file contains basic instructions for updating the XML mapping file. New screenshots.
- Changed: Minor changes to tracing
- initial version. Works with oik version 1.13