Purging<\/strong> \u2014 calls the Cloudflare API to purge the relevant tags when content changes (post publish\/update\/trash\/delete and taxonomy term edits).<\/li>\n<\/ol>\n\nThe two features can be enabled independently.<\/p>\n\n
Works on any Cloudflare plan.<\/strong> The Cache-Tag<\/code> header and purge-by-tag are available on all Cloudflare plans (Free, Pro, Business, and Enterprise); purge API rate limits scale with your plan.<\/p>\n\nDefault tags<\/h4>\n\n
For singular content the plugin emits:<\/p>\n\n
\ncontent<\/code><\/li>\nb{id}<\/code> (site scope: b1<\/code> on single site, b{blog_id}<\/code> on multisite)<\/li>\nb{id}-p{ID}<\/code><\/li>\nb{id}-pt-{post_type}<\/code><\/li>\nb{id}-t{term_id}<\/code> for every public taxonomy term the post belongs to<\/li>\n<\/ul>\n\nExample header:<\/p>\n\n
Cache-Tag: content,b1,b1-p42,b1-pt-post,b1-t5\n<\/code><\/pre>\n\nTerm tags use the numeric term ID (b1-t5<\/code>), so they stay stable when a term is renamed or its slug changes.<\/p>\n\nCredentials<\/h4>\n\n
Provide a scoped Cloudflare API token (Zone \u2192 Cache Purge permission) and a Zone ID. Define them in wp-config.php<\/code> for best security:<\/p>\n\ndefine( 'CACHE_TAGS_CF_API_TOKEN', 'your-scoped-token' );\ndefine( 'CACHE_TAGS_CF_ZONE_ID', 'your-zone-id' );\n<\/code><\/pre>\n\nWhen these constants are defined they take precedence and the settings fields become read-only. Otherwise enter them under Settings \u2192 Cache Tags<\/strong>.<\/p>\n\nPurge tools<\/h4>\n\n
The Settings \u2192 Cache Tags<\/strong> screen has a Purge<\/strong> tab for manual, on-demand purges by group: a whole post type, a taxonomy term, everything, or raw comma-separated tags. Saving valid credentials on the Settings<\/strong> tab automatically verifies the Cloudflare connection and unlocks the purge tools.<\/p>\n\nAutomatic purging<\/h4>\n\n
When Auto-purge on changes<\/strong> is enabled and valid credentials are set, the plugin purges the affected tags automatically on these events:<\/p>\n\n\n- Post published, updated, trashed, or untrashed (any transition to or from the published status) \u2014 purges
b{id}-p{ID}<\/code> plus the post's b{id}-t{term_id}<\/code> tags.<\/li>\n- Post permanently deleted \u2014 purges
b{id}-p{ID}<\/code> and its b{id}-t{term_id}<\/code> tags.<\/li>\n- Taxonomy term edited or deleted \u2014 purges
b{id}-t{term_id}<\/code>.<\/li>\n<\/ul>\n\nOnly public post types and taxonomies are considered; revisions and autosaves are ignored. Tags collected during a request are de-duplicated and sent as a single batched purge after the response (in Cloudflare's 30-tags-per-request batches). Draft-only edits, comments, menu\/widget\/theme changes, and plugin\/core updates do not trigger a purge \u2014 use the Purge tab, WP-CLI, or the cache_tags_for_cloudflare\/purge_tags<\/code> filter for those. Static files such as images are served outside WordPress and are not tagged or purged by tag.<\/p>\n\nHooks and programmatic purging<\/h4>\n\n
The plugin exposes hooks for customizing tags and purging from your own code:<\/p>\n\n
\n- Filters:
cache_tags_for_cloudflare\/tags<\/code>, cache_tags_for_cloudflare\/purge_tags<\/code><\/li>\n- Result actions:
cache_tags_for_cloudflare\/purged<\/code>, cache_tags_for_cloudflare\/purge_failed<\/code><\/li>\n- Programmatic purging:
cache_tags_for_cloudflare\/purge_post<\/code>, \/purge_terms<\/code>, \/purge_post_type<\/code>, \/purge_all<\/code>, \/purge<\/code><\/li>\n<\/ul>\n\nSee the Developer guide<\/a> for full documentation and examples.<\/p>\n\nWP-CLI<\/h4>\n\nwp cache-tags purge --post-type=page\nwp cache-tags purge --taxonomy=category --terms=news,sport\nwp cache-tags purge --post=42\nwp cache-tags purge --tags=b1-t5,content\nwp cache-tags purge --all\nwp cache-tags verify\n<\/code><\/pre>\n\nOn multisite, --all<\/code> purges only the current subsite (via its b{id}<\/code> tag). To purge every site sharing the Cloudflare zone at once, purge the global content<\/code> tag: wp cache-tags purge --tags=content<\/code>.<\/p>\n\nExternal services<\/h4>\n\n
This plugin connects to the Cloudflare API<\/strong> (https:\/\/api.cloudflare.com<\/code>) to verify your credentials and to purge cached content by cache tag. Cloudflare is required for the plugin's purging feature to work; the tagging feature (emitting Cache-Tag<\/code> headers) works without contacting any external service.<\/p>\n\nThe plugin contacts Cloudflare in the following cases, and only after you have provided a Cloudflare API token and Zone ID:<\/p>\n\n
\n- Verifying credentials<\/strong> \u2014 when you save credentials on the settings screen or run
wp cache-tags verify<\/code>, the plugin calls GET https:\/\/api.cloudflare.com\/client\/v4\/user\/tokens\/verify<\/code>. It sends your API token (in the Authorization<\/code> header) so Cloudflare can confirm the token is valid.<\/li>\n- Purging cache<\/strong> \u2014 when content changes and auto-purge is enabled, or when you purge manually via the settings screen or
wp cache-tags purge<\/code>, the plugin calls POST https:\/\/api.cloudflare.com\/client\/v4\/zones\/{zone-id}\/purge_cache<\/code>. It sends your API token (in the Authorization<\/code> header), your Zone ID (in the request URL), and the list of cache tags to purge (in the request body). It does not send post content, personal data, or visitor information.<\/li>\n<\/ul>\n\nNo data is sent to Cloudflare until you configure credentials, and no request is made unless one of the actions above is triggered.<\/p>\n\n
Cloudflare is a third-party service provided by Cloudflare, Inc. By using this plugin's purging feature you agree to Cloudflare's terms and privacy policy:<\/p>\n\n
\n- Terms of Service: https:\/\/www.cloudflare.com\/website-terms\/<\/li>\n
- Privacy Policy: https:\/\/www.cloudflare.com\/privacypolicy\/<\/li>\n<\/ul>\n\n\n
\n- Upload the plugin to
\/wp-content\/plugins\/cache-tags-for-cloudflare<\/code> or install it from the Plugins screen.<\/li>\n- Activate the plugin.<\/li>\n
- Go to Settings \u2192 Cache Tags<\/strong> and add your Cloudflare API token and Zone ID (or define the constants in
wp-config.php<\/code>).<\/li>\n<\/ol>\n\n\n\nHow do I get a Cloudflare API token and Zone ID?<\/h3><\/dt>\nIn the Cloudflare dashboard, create a scoped API token (My Profile \u2192 API Tokens \u2192 Create Token<\/strong>) with the Zone \u2192 Cache Purge<\/strong> permission, limited to the zone you want to purge. Your Zone ID is on that zone's Overview<\/strong> page. Add both under Settings \u2192 Cache Tags<\/strong>, or define CACHE_TAGS_CF_API_TOKEN<\/code> and CACHE_TAGS_CF_ZONE_ID<\/code> in wp-config.php<\/code>.<\/p><\/dd>\nDo I need to configure anything in Cloudflare?<\/h3><\/dt>\nNo extra setup is required. Cloudflare reads the Cache-Tag<\/code> header the plugin adds automatically, and the plugin purges by tag through the API. Just make sure your site is proxied through Cloudflare (orange-clouded) so responses are cached.<\/p><\/dd>\n