forked from keycdn/cache-enabler
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
240 lines (173 loc) · 8.06 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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
=== Cache Enabler - WordPress Cache ===
Contributors: keycdn
Tags: cache, caching, wordpress cache, wp cache, performance, gzip, webp, http2
Requires at least: 5.1
Tested up to: 5.5
Stable tag: trunk
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
A lightweight caching plugin for WordPress that makes your website faster by generating static HTML files plus WebP support.
== Description ==
= WordPress Cache Engine =
The Cache Enabler plugin creates static HTML files and stores them on the servers disk. The web server will deliver the static HTML file and avoids the resource intensive backend processes (core, plugins and database). This WordPress cache engine will improve the performance of your website.
= Features =
* Efficient and fast disk cache engine
* Automated and/or manual clearing of the cache
* Manually clear the cache of specific pages
* WP-CLI cache clearing
* Display of the actual cache size in your dashboard
* Minification of HTML and inline JavaScript
* WordPress multisite support
* Custom Post Type support
* Expiry Directive
* Support of *304 Not Modified* if the page has not modified since last cached
* WebP Support (when combined with [Optimus](https://optimus.io "Optimus"))
* Supports responsive images via srcset since WP 4.4
* Works perfectly with [Autoptimize](https://wordpress.org/plugins/autoptimize/)
> Cache Enabler is the first WP plugin to allow you to serve WebP images without JavaScript and also fully supports srcset since WP 4.4. WebP is a new image format that provides lossless and lossy compression for images on the web. WebP lossless images are [26% smaller](https://developers.google.com/speed/webp/docs/webp_lossless_alpha_study#results "webp lossless alpha study") in size compared to PNGs.
= How does the caching work? =
This plugin requires minimal setup time and allows you to easily take advantage of the benefits that come from using WordPress caching.
The WordPress Cache Enabler has the ability to create 2 cached files. One is plain HTML and the other version is gzipped (gzip level 9). These static files are then used to deliver content faster to your users without any database lookups or gzipping as the files are already pre-compressed.
When combined with Optimus, the WordPress Cache Enabler allows you to easily deliver WebP images. The plugin will check your upload directory for any JPG or PNG images that have an equivalent WebP file. If there is, the URI of these image will be cached in a WebP static file by Cache Enabler. It is not required for all images to be converted to WebP when the "Create an additional cached version for WebP image support" option is enabled. This will not break any images that are not in WebP format. The plugin will deliver images that do have a WebP equivalent and will fall back to the JPG or PNG format for images that don't.
= WP-CLI =
* Clear all pages cache.
`wp cache-enabler clear`
* Clear the page cache for post IDs 1, 2, and 3.
`wp cache-enabler clear --ids=1,2,3`
* Clear the page cache for a particular URL.
`wp cache-enabler clear --urls=https://example.com/about-us`
* Clear all pages cache for sites with blog IDs 1, 2, and 3.
`wp cache-enabler clear --sites=1,2,3`
= Website =
* [WordPress Cache Enabler - Documentation](https://www.keycdn.com/support/wordpress-cache-enabler-plugin "WordPress Cache Enabler - Documentation")
= System Requirements =
* PHP >=5.6
* WordPress >=5.1
= Contribute =
* Anyone is welcome to contribute to the plugin on [GitHub](https://github.com/keycdn/cache-enabler).
* Please merge (squash) all your changes into a single commit before you open a pull request.
= Maintainer =
* [KeyCDN](https://www.keycdn.com "KeyCDN")
= Credits =
* Inspired by [Cachify](https://wordpress.org/plugins/cachify/).
== Changelog ==
= 1.5.0 =
* Update WebP URL conversion for images with density descriptors (#125)
* Fix cache clearing for installations in a subdirectory (#127)
* Fix WebP URL conversion for installations in a subdirectory (#125)
= 1.4.9 =
* Fix WebP URL conversion
= 1.4.8 =
* Update WebP URL conversion (#116)
* Update WP-CLI clear subcommand messages (#111)
* Update WP-CLI clear subcommand for multisite networks (#111)
* Fix cache clearing for installations in a subdirectory
* Fix advanced cache settings recognition for installations in a subdirectory
* Fix file permissions requirement notice
= 1.4.7 =
* Update getting wp-config.php if one level above installation (#106)
* Add clear types for strict cache clearing (#110)
* Fix advanced cache settings recognition for subdirectory multisite networks
* Fix WP-CLI clear subcommand for post IDs (#110)
* Fix scheme-based caching for NGINX/PHP-FPM (#109)
* Fix trailing slash handling
= 1.4.6 =
* Add cache bypass method for sitemaps (#104)
* Fix cache clearing for subdirectory multisite networks (#103)
= 1.4.5 =
* Update WP_CACHE constant handling (#102)
* Add cache bypass method for WP_CACHE constant (#102)
* Add translation descriptions (#102)
* Fix cache handling for default redirects (#102)
= 1.4.4 =
* Update cache handling for HTTP status codes (#100)
= 1.4.3 =
* Update cache clearing by URL (#99)
* Fix advanced cache settings updating unnecessarily (#99)
= 1.4.2 =
* Update cache clearing for the Clear URL Cache admin bar button (#98)
* Update scheme-based caching (#98)
* Fix advanced cache path variants (#98)
= 1.4.1 =
* Fix undefined constant
= 1.4.0 =
* Update default cache behavior for WooCommerce stock update (#88)
* Update Cache Behavior setting for plugin actions (#91)
* Update admin bar clear cache buttons (#96)
* Update cache behavior for logged in users (#95)
* Update default clear cache publishing action (#88)
* Update advanced cache settings (#91 and #92)
* Update trailing slash handling (#91)
* Update settings page (#84 and #92)
* Add Cache Behavior setting for WooCommerce stock update (#88)
* Add fbclid as default URL query parameter to bypass cache (#84)
* Add scheme-based caching (#94)
* Fix advanced cache settings recognition for multisite networks (#92)
= 1.3.5 =
* WP-CLI cache clearing (Thanks to Steve Grunwell)
* Added cache_enabler_disk_webp_converted_data filter
* Improved WebP URL conversion
* Fixed advanced cache issue
= 1.3.4 =
* Reverted change to page specific as new default
= 1.3.3 =
* Replaced wp_die in advanced cache
= 1.3.2 =
* Changed to page specific as new default
* Added regex setting for analytics tags in get variables
* Fixed 304 responses
= 1.3.1 =
* Fix for missing trailing slashes was incomplete
* Add filter option before minification
= 1.3.0 =
* Clear cache on WooCommerce stock updates
= 1.2.3 =
* Fix expiry time
* Allow to customize bypass cookies
* Fix Autoptimize config warning
* Pages can now be excluded from cache by a path matching regex
* Plugin upgrades can now trigger cache clear
* Scheduled posts and drafts are now properly handled
* A missing trailing slash will now redirect like WordPress does by default
= 1.2.2 =
* Fixed settings form issue
= 1.2.1 =
* Minor fixes
= 1.2.0 =
* Added advanced cache feature
* Clear cache if reply to a comment in WP admin
= 1.1.0 =
* Added the possibility to clear the cache of a specific URL
* Supports now Windows filesystems
* Added X-Cache-Handler to indicate if loaded through PHP
* Support of WebP images generated by ewww
* Dynamic upload directory for WebP images
* Fixed multisite purge issue
* Added requirements checks
* Made plugin ready for translation
= 1.0.9 =
* Option to disable pre-compression of cached pages if decoding fails
= 1.0.8 =
* Added support for srcset in WP 4.4
* Improved encoding (utf8)
= 1.0.7 =
* Added cache behavior option for new posts
* Improved metainformation of the signature
* Optimized cache handling for nginx
= 1.0.6 =
* Fixed query string related caching issue
= 1.0.5 =
* Credits update
= 1.0.4 =
* Changed WebP static file naming
= 1.0.3 =
* Fixed WebP version switch issue
= 1.0.2 =
* Added support for WebP and CDN Enabler plugin
= 1.0.1 =
* Added WebP support and expiry directive
= 1.0.0 =
* Initial Release
== Screenshots ==
1. Display of the cache size in your dashboard
2. Cache Enabler settings page and "Clear Cache" link in the dashboard