Plugin Directory

Changeset 3337713


Ignore:
Timestamp:
08/01/2025 10:16:08 AM (7 months ago)
Author:
optimole
Message:

Updating readme/assets from GitHub

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wp-cloudflare-page-cache/trunk/readme.txt

    r3335580 r3337713  
    1313== Description ==
    1414
    15 ### **Why Choose This Plugin?**
    16 
    17 The Super Page Cache plugin helps you to make your website blazing fast by taking the website caching to the next level. This plugin will help you to cache not only the static files (e.g. CSS, JS, images etc.) but also the HTML webpages generated by WordPress; both at server disk-level and to the global Cloudflare CDN.
    18 
    19 Moreover, **this plugin works completely out of the box**, you can use it without or with Cloudlflare, if you want to use the Cloudflare CDN, all you need to do is provide your Cloudflare Account's API Key or API Token details and the plugin will do the rest. But if you are a curious/advanced user, there are detailed settings inside the plugin which you can tweak to make it work as you like. But for most users, you don't need to change any settings as this plugin will work perfectly with the default settings, out of the box.
    20 
    21 Unlike most caching plugin out there which only provides disk caching (i.e. the cached webpages will be served from your web-server), this plugin will cache your webpages and static files to the Cloudflare CDN, one of the [fastest CDN networks](https://www.cdnperf.com/cdn-compare?type=performance&location=world&cdn=akamai-cdn,aws-cloudfront-cdn,azure-cdn,bunnycdn,cachefly,cdn-net,cdn77,cdnetworks,cloudflare-cdn,dorabase,fastly-cdn,g-core-labs-cdn,google-cloud-cdn,keycdn,nusec-cdn,ovh-cdn,stackpath-cdn,verizon-edgecast-cdn) in the world.
    22 
    23 With [more than 200 CDN edge locations](https://www.cloudflare.com/network/) provided by Cloudflare, your webpage will be served from the nearest CDN location of the visitor, rather than sending the request to your web server which might be sitting on the other side of the world. This will reduce your website loading speed drastically thanks to taking advantage of the Cloudflare CDN, not only for the static files but also for the HTML webpages. Take a look at the review video below by IdeaSpot, which will give you a clear idea about the plugin before you install it.
    24 
    25 [youtube https://www.youtube.com/watch?v=c-U5Nw2xTj8]
    26 
    27 ### **How does the plugin work?**
    28 
    29 This plugin takes full advantage of the *FREE Cloudflare Plan*, so to use this plugin, you don't need a paid Cloudflare account. But if you like to use features like Cloudflare image optimization, WAF (Web Application Firewall) etc. then you have to pay for the Cloudflare Pro plan to enable those features in your Cloudflare account.
    30 
    31 The free Cloudflare plan allows you to enable a page cache by entering the *Cache Everything* page rule, greatly improving response times. However for dynamic websites such as Wordpress, it is not possible to use this page rule without running into problems as it is not possible to exclude critical web pages from the cache, the sessions for logged in users, ajax requests and much more. **Thanks to this plugin all of this becomes possible.**
    32 
    33 This plugin enable page caching on your website by taking advantage of either the Cloudflare *Cache Everything* page rule or using Cloudflare Worker. By default the Cloudflare Worker mode is disabled as it is [not 100% free](https://workers.cloudflare.com/#plans) like the *Cache Everything* page rule. But you can enable it if you like.
    34 
    35 The Cloudflare Worker based solution will help you to have a clean page caching solution without any cache buster query string (/?swcfpc=1) for logged-in users. Moreover, you can also overwrite our default worker code to add your own custom login into it if you are an advanced user.
    36 
    37 You will be able to significantly **improve the response times of your Wordpress website** by taking advantage of the very fast Cloudflare cache also for HTML pages, **saving a lot of bandwidth**. The alternative to this plugin is to purchase and configure the Enterprise plan.
    38 
    39 ### **Plugin Features**
    40 
    41 - Developed to work flawlessly with any Cloudflare Plan (be it Cloudflare Free or Pro or Business or Enterprise account)
    42 - Takes full advantage of Cloudflare *Cache Everything* Page Rule
    43 - Cache Buster Support to ensure logged-in users don't see cached content
    44 - Page Caching by using **Cloudflare Worker** (alternate to page rule solution, needs to be manually activated in plugin settings)
    45 - No Cache Buster when using Cloudflare Worker based Page Caching solution
    46 - Ability to overwrite our default Worker code to add your own custom login into it
    47 - Disk level fallback cache system for the requests which might not yet beed cached by CLoudflare or has been expired in Cloudflare cache (plugin settings - Cache tab)
    48 - Ability to select and customize what you want to cache and what you don't (plugin settings - Cache tab)
    49 - Fallback cache in which you can retain your custom response header data (most plugins removes them)
    50 - Automatically purge the post/page/CPTs when you update them along with the related pages where they might be sentence
    51 - Ability to purge only HTML pages of your website rather than purging everything (HTML pages + static contents)
    52 - Ability to preload pages based on page urls, sitemaps, last 20 published/updated contents
    53 - Run the preloader manually (from plugin settings) or over a CRON job
    54 - Ability to automatically purge Varnish cache (if your server has Varnish enabled) when Cloudflare cache is purged
    55 - Automatically purge OPcache & object cache when Cloudflare cache is purged
    56 - Purge the whole Cloudflare cache using CRON job
    57 - Give Cloudflare cache purge permission based on user roles
    58 - Auto prefetch URLs present in Viewport
    59 - Auto prefetch URLs on mouse hover (by using [instant.page](https://instant.page/) script)
    60 - Ability to keep the plugin settings on deactivation (needs to be enabled in plugin settings - Others tab)
    61 - Export/Import plugin settings as JSON
    62 - Ability to purge Cloudflare cache from WP Admin toolbar
    63 - Ability to exclude page from being cached on individual page/post bases (Turn off the `Disable metaboxes on single pages and posts` option in plugin settings - Others tab)
    64 - Integration to many popular host's (e.g. Kinsta, WP Engine, SpinupWP) internal server caching
    65 - Integration to popular eCommerce systems like WooCommerce and Easy Digital Downloads (EDD) [plugin settings - Third Party tab]
    66 - Integration to countless third-party plugins (e.g. Autoptimize, W3 Total Cache, LiteSpeed Cache, Hummingbird, WP Optimize, WP Rocket, WP Asset Clean Up, WP Performance, Yet Another Star Rating, Swift Performance, SIteground SuperCacher etc.)
    67 - Detailed FAQ section covering all kind of questions (plugin settings - FAQ tab)
    68 
    69 Not just these, we are constantly working towards adding new useful features to the plugin all the time. So, your love and support is what keep us going. If you love using the plugin, please consider **sharing your review** in the [review section](https://wordpress.org/plugins/wp-cloudflare-page-cache/#reviews).
    70 
    71 ### **Important Notice**
    72 
    73 If you are using this plugin in conjunction with other page caching plugins like WP Rocket, [LiteSpeed Cache](https://wordpress.org/plugins/litespeed-cache/), W3 Total Cache etc. please ensure that the page caching feature is disabled on those plugins, as the page caching will be handled by this plugin only.
    74 
    75 You can also use plugins like [Autoptimize](https://wordpress.org/plugins/autoptimize/), Perfmatters, ShortPixel, WP Rocket or Optimole to optimize your static assets while using this plugin for page caching.
    76 
    77 If you are an advanced user/developer, you will be pleased to know that **this plugin is 100% jQuery free and compatible with all versions of Wordpress and all Wordpress themes.**
    78 
    79 If you are using Kinsta as your hosting provider, this plugin works flawlessly with Kinsta's Server Level Caching and this plugin has also been thoroughly tested on Kinsta Servers to ensure it is fully compatible with Kinsta Server Caching.
    80 
    81 Moreover if you are using any hosting platform for whom we support their native server caching (i.e. Kinsta, WP Engine, SpinupWP etc.) you don't have to enable our fallback cache system, as you can use the native disk cache provided by your host instead of using our disk level fallback cache.
     15Super Page Cache takes your website caching to the next level, making your WordPress site blazing fast by caching not only static files (CSS, JS, images) but also HTML webpages, both at server disk-level and to the global Cloudflare CDN. With our completely redesigned dashboard and advanced optimization features, you get enterprise-level performance with zero configuration required.
     16
     17This plugin works right out of the box. You can use it with or without Cloudflare. It offers powerful disk caching by saving files locally on your server, even without using a CDN. If you want to take advantage of the Cloudflare CDN, just enter your Cloudflare API Key or API Token, and the plugin will handle the rest. For advanced users, the intuitive dashboard features detailed settings and built-in documentation. Most users don’t need to make any changes because it runs smoothly with the default settings.
     18
     19https://youtu.be/SYhoaL_fUY0?si=94atnvwHRF5r_U3U
     20
     21### **⚡ Quick Links**
     22
     23- [Documentation](https://docs.themeisle.com/collection/2199-super-page-cache) → Complete setup and configuration guide
     24- [Support Forum](https://wordpress.org/support/plugin/wp-cloudflare-page-cache/) → Community help and expert support
     25- [YouTube Videos](https://youtube.com/playlist?list=PLmRasCVwuvpSJuwaV7kDiuXhxl08zbZr5&si=Gem626AyPpNenDF3) → Step-by-step visual guides for every feature
     26- [Go Pro](https://themeisle.com/plugins/super-page-cache-pro/?utm_source=wpadmin&utm_medium=readme&utm_campaign=quicklinks) → Advanced features and priority support
     27
     28### **🚀 How Does The Plugin Work?**
     29
     30Super Page Cache provides blazing-fast performance through dual caching layers: intelligent disk caching that works completely standalone, plus optional Cloudflare CDN integration for global edge caching.
     31
     32#### Disk Caching (Works Without Cloudflare)
     33The plugin provides powerful server-level disk caching by saving cached HTML pages and static files directly to your server. This works completely independently and delivers significant speed improvements even without any CDN integration. Your pages load instantly from locally cached files, dramatically reducing server processing time.
     34
     35#### Optional Cloudflare CDN Integration
     36When you connect your Cloudflare account, the plugin leverages **Cloudflare's modern Cache Rules** (replacing outdated page rules and worker methods) to intelligently cache your content across Cloudflare's global network. This takes full advantage of the **FREE Cloudflare Plan** - no paid account required.
     37
     38#### Why This Matters for Your Website Speed
     39Unlike most caching plugins that only provide disk caching (serving cached webpages from your web server), Super Page Cache caches your webpages and static files in the **Cloudflare CDN, one of the world's [fastest CDN networks](https://www.cdnperf.com/cdn-compare?type=performance&location=world&cdn=akamai-cdn,aws-cloudfront-cdn,azure-cdn,bunnycdn,cachefly,cdn-net,cdn77,cdnetworks,cloudflare-cdn,dorabase,fastly-cdn,g-core-labs-cdn,google-cloud-cdn,keycdn,nusec-cdn,ovh-cdn,stackpath-cdn,verizon-edgecast-cdn)**.
     40
     41With more than **[200 CDN edge locations](https://www.cloudflare.com/network/)** provided by Cloudflare, your webpage will be served from the nearest CDN location to the visitor, rather than sending requests to your web server, which might be on the other side of the world. This significantly reduces website loading speed by leveraging the Cloudflare CDN for both static files and HTML webpages.
     42
     43#### ✅ Works Out of the Box (With or Without Cloudflare)
     44You don't need to configure anything. Just activate the plugin, and it works instantly with intelligent disk caching and default settings. Our completely redesigned dashboard with integrated documentation makes customization easier than ever when you need it.
     45
     46#### ☁️ Designed for Cloudflare (All Plans Supported)
     47Whether you use the **Free, Pro,** or **Enterprise** Cloudflare plan, the plugin integrates seamlessly using modern Cache Rules and lets you:
     48
     49- Automatically purge Cloudflare cache on content updates
     50- Leverage intelligent cache rules optimized for dynamic WordPress sites
     51- Purge Cloudflare cache via cron jobs or manually from the WP admin toolbar
     52- Control caching behavior to avoid conflicts with other plugins
     53- Track cache performance with integrated metrics
     54
     55### **🔥 Core Features (Free Version)**
     56
     57#### 🚀 Complete Caching Solution
     58
     59- **Server-Level Disk Caching:** Lightning-fast page caching directly on your server that works completely standalone, with intelligent fallback when Cloudflare cache is missed or expired.
     60- **Global CDN Integration:** Optional Cloudflare CDN integration with 200+ edge locations worldwide using modern Cache Rules for ultra-low latency delivery.
     61- **Complete Cache Controls:** Exclude specific cookies, query parameters, URIs, and content types like AMP, feeds, or REST API from being cached.
     62- **Flexible Cache Lifespan:** Define custom cache expiration values or set pages never to expire.
     63- **Response Header Management:** Preserve critical response headers in both Cloudflare and fallback disk caches, unlike other plugins that strip them.
     64- **Smart Cache Buster:** Ensure logged-in users and editors never see cached content using intelligent cache-busting techniques.
     65- **Cache Performance Metrics:** Basic metrics system to track cache performance and give you insights into your site's caching effectiveness.
     66
     67#### ⚡ Performance Optimization
     68
     69- **Google Fonts Optimization:** Combine multiple font requests and serve fonts locally for improved privacy and loading speeds while reducing external dependencies.
     70- **Lazy Loading System:** Built-in lazy loading for images, videos, iframes, and background images to improve load performance.
     71- **Flexible Lazy Load Exclusions:** Exclude specific media using keywords, URL patterns, or CSS class detection.
     72- **Advanced Assets Manager:** Enable or disable specific CSS and JavaScript files based on page context with an intuitive frontend modal interface, helping you eliminate unused scripts and optimize page performance.
     73- **Browser Caching Rules:** Automatically configure `.htaccess` rules for long-lived caching of static assets like images, scripts, and stylesheets.
     74
     75#### 🛠️ Advanced Cache Management
     76
     77- **Smart Auto-Purging:** Automatically clear relevant cache entries when posts, pages, or custom post types are updated, including related content.
     78- **Granular Purge Options:** Choose to purge only HTML pages or the entire cache, including assets.
     79- **Intelligent Preloader:** Preload content from sitemaps, menus (top, main, footer), or the last 20 updated posts. Supports manual or scheduled (`CRON`) triggers.
     80- **Enhanced Background Processing:** Improved background processing system using `Action Scheduler` for more reliable background task handling.
     81- **Queue-Based Purging:** Prevent server overload by staggering purge operations for high-frequency events.
     82- **Force Cache Bypassing for Backend:** Add additional cache rules to prevent caching of the admin dashboard in rare edge cases.
     83- **Per-Page Cache Control:** Easily exclude individual posts or pages from caching using a built-in metabox in the editor.
     84- **Toolbar Cache Purging:** Instantly purge cache from the WordPress admin toolbar for convenience.
     85
     86#### 🔧 Developer & Power User Features
     87
     88- **Redesigned Dashboard Experience:** Complete dashboard redesign with improved user experience, intuitive navigation, and reorganized settings structure that groups related options together.
     89- **Integrated Documentation:** Helpful tips and guidance directly within the dashboard, providing context without leaving your WordPress admin.
     90- **Multiple Cache Backends:** Choose between WordPress’s `advanced-cache.php` or a cURL-based approach for compatibility with other performance plugins.
     91- **Enhanced Defer JS Control:** New `spc_defer_script` filter hook allowing developers to exclude specific scripts from being deferred, providing more granular control over JavaScript optimization.
     92- **Role-Based Permissions:** Control which user roles can manually purge the cache.
     93- **API Integration with Cloudflare:** Works with Cloudflare Free, Pro, Business, or Enterprise using either API Key or Token authentication with modern Cache Rules.
     94- **Export/Import Plugin Settings:** Save or transfer plugin settings as a downloadable JSON file.
     95- **Preserve Settings on Deactivation:** Optionally retain all plugin settings when deactivated for smoother migrations or staging workflows.
     96
     97#### 🗄️ Database Optimization
     98
     99- **Automated Database Cleanup:** Remove post revisions, auto-drafts, trashed items, spam comments, and expired transients with both manual and scheduled cleanup options.
     100- **Scheduled Maintenance:** Run cleanups automatically on a daily, weekly, or monthly basis.
     101- **Table Optimization:** Run `SQL OPTIMIZE TABLE` commands to defragment and reclaim space.
     102- **Selective Cleanup Options:** Select precisely which data types to clean based on your site's specific needs.
     103
     104#### 🌐 Universal Compatibility
     105
     106- **Premium Host Integration:** Seamless compatibility with top-tier hosts like Kinsta, WP Engine, and SpinupWP.
     107- **eCommerce Ready:** Fully integrated with WooCommerce and Easy Digital Downloads.
     108- **Varnish & OPcache Support:** Automatically purge server-level caches when Cloudflare cache is cleared.
     109- **Prefetch Optimization:** Supports automatic prefetching of internal links in the viewport or on hover using [Instant.page](https://instant.page) for lightning-fast navigation.
     110
     111### **💎 Super Page Cache PRO with Advanced Performance Features**
     112
     113Take your website speed to the next level with powerful PRO features designed for maximum performance optimization:
     114
     115- **Ignore Marketing Parameters:** Significantly increases cache hit rate by ignoring common marketing and tracking parameters in URLs, treating them as the same page for caching purposes. Perfect for sites with `UTM` parameters, affiliate links, and tracking codes.
     116- **Defer JavaScript:** Eliminate render-blocking JavaScript on your site and improve load times by deferring JavaScript execution until after the page has loaded. [Learn more](https://docs.themeisle.com/article/2058-defer-js).
     117- **Delay JavaScript:** Make your website faster by loading JavaScript files only when the user interacts with the page (e.g., scrolling, clicking, or touching). This dramatically improves initial page load speed. [Learn more](https://docs.themeisle.com/article/2057-delay-js).
     118- **Advanced Lazy Loading System:** Choose between native lazy loading or a custom system with enhanced viewport detection and precise above-the-fold image detection. Automatically loads critical images immediately while lazy loading below-the-fold content, optimized for both mobile and desktop viewports without impacting user experience.
     119- **Advanced Exclusion Controls:** Fine-tune your caching strategy by excluding specific JavaScript files and pages that shouldn't be cached, ensuring critical functionality works flawlessly while maximizing cache efficiency.
     120- **Priority Support:** Get priority email support and faster response times for any technical questions or issues.
     121
     122**Ready to unlock maximum performance? [Upgrade to Pro](https://themeisle.com/plugins/super-page-cache-pro/?utm_source=wpadmin&utm_medium=readme&utm_campaign=spc-pro-featrues)**
     123
     124### **🎯 Important Usage Guidelines**
     125
     126#### Caching Plugin Compatibility
     127If you're using Super Page Cache with other page caching plugins (WP Rocket, LiteSpeed Cache, W3 Total Cache, etc.), please disable the page caching feature on those plugins. Super Page Cache will handle all page caching to avoid conflicts.
     128
     129You can safely use the following plugins alongside Super Page Cache for complete optimization: [Optimole](https://wordpress.org/plugins/optimole-wp/), Autoptimize, Perfmatters, ShortPixel, or WP Rocket for static asset optimization.
     130
     131### **⭐ Here's What Our Users Are Saying**
     132
     133> ★★★★★ 
     134> **Super Page Cache has been a game-changer** 
     135> "Super Page Cache has been a game-changer for our website's performance! We've seen a noticeable improvement in loading times, which has directly boosted our user engagement and SEO rankings. It's incredibly effective and surprisingly easy to set up. Highly recommend for anyone looking to seriously speed up their WordPress site!" 
     136> – @brandnexusstudios
     137
     138---
     139
     140> ★★★★★ 
     141> **Insane Speed Boost – For Free!!! Thank You!!!** 
     142> "With this plugin, I managed to drop response times on my WordPress website from 400ms+ to consistently below 200ms. It has almost the same metrics as my static website on S3!!! Amazing—and this is using the free version!!! So you get all of this for free!!!!!" 
     143> – @jurijs0
     144
     145---
     146
     147> ★★★★★ 
     148> **A powerful and beautiful plugin** 
     149> "I like it a lot, I really appreciate your great work. Fortunately, I've been using it and it's the best. I'll continue using it for a long time. Thank you." 
     150> – @bazkaesnwyllt
     151
     152---
     153
     154> ★★★★★ 
     155> **Does exactly what it promises** 
     156> "One of the great things about using WordPress is the availability of plugins to handle a wide variety of jobs. The best ones–like this one–do that simply and effectively. Couldn't be happier with the increased speed of loading cached pages. Highly recommended." 
     157> – @skipvia
     158
     159### **🏆 Why Choose Super Page Cache?**
     160
     161#### Works Standalone or with Global CDN
     162
     163Unlike plugins that require external services, Super Page Cache delivers powerful disk caching that works completely standalone. You can also optionally integrate with Cloudflare CDN, leveraging 200+ edge locations worldwide for even faster performance.
     164
     165#### Cost-Effective Solution
     166
     167Get enterprise-level caching performance using Cloudflare's free plan or our advanced local disk caching. No need for expensive premium CDN subscriptions or enterprise tools.
     168
     169#### Zero Configuration Required
     170
     171The plugin works perfectly out of the box with intelligent defaults. Our redesigned dashboard includes built-in documentation to help you customize settings whenever needed.
     172
     173#### Continuous Development
     174
     175We’re actively building and improving Super Page Cache. Your support and feedback keep us going. If you enjoy the plugin, we’d love to hear your thoughts — [leave a review](https://wordpress.org/support/plugin/wp-cloudflare-page-cache/reviews/#new-post).
     176
     177### **📚 Resources & Community**
     178
     179#### RESOURCES
     180- [Knowledge Base](https://docs.themeisle.com/)
     181- [Support Forum](https://wordpress.org/support/plugin/super-page-cache-for-cloudflare/)
     182- [Feature Request](mailto:[email protected])
     183
     184#### JOIN OUR COMMUNITY
     185- [Follow us on Twitter](https://twitter.com/themeisle)
     186- [Join us on Facebook](https://www.facebook.com/themeisle/)
     187- [Subscribe to our YouTube channel](https://www.youtube.com/@Themeisle)
     188
     189### **🚀 Ready to Speed Up Your WordPress Site?**
     190
     191Stop settling for slow loading times. Join thousands of WordPress users who’ve already transformed their sites with Super Page Cache’s powerful caching system and advanced optimization features.
     192
     193**Get started today** and experience the difference intelligent caching can make for your website’s performance.
     194
     195---
     196
     197#### Super Page Cache is backed by Themeisle
     198 
     199[Themeisle](https://themeisle.com/) is a trusted provider of premium WordPress themes and plugins, powering over 1 million WordPress sites worldwide, with 450+ five-star ratings on [Trustpilot](https://www.trustpilot.com/review/themeisle.com).
    82200
    83201== Installation ==
Note: See TracChangeset for help on using the changeset viewer.