By rtCamp

April 16, 2024

Nginx Helper Plugin

Cleans nginx's fastcgi/proxy cache or redis-cache whenever a post is edited/published. Also does a few more things.

Removes index.php from permalinks when using WordPress with nginx.
Adds support for purging redis-cache when used as full-page cache created using nginx-srcache-module
Adds support for nginx fastcgi_cache_purge & proxy_cache_purge directive from module. Provides settings so you can customize purging rules.
Adds support for nginx map{..} on a WordPress-multisite network installation. Using it, Nginx can serve PHP file uploads even if PHP/MySQL crashes. Please check the tutorial list below for related Nginx configurations.

Tutorials

You will need to follow one or more tutorials below to get desired functionality:

Installation

Automatic Installation

Log in to your WordPress admin panel, navigate to the Plugins menu and click Add New.
In the search field type “Nginx Helper” and click Search Plugins. From the search results, pick Nginx Helper and click Install Now. WordPress will ask you to confirm to complete the installation.

Manual Installation

Extract the zip file.
Upload them to /wp-content/plugins/ directory on your WordPress installation.
Then activate the Plugin from Plugins page.

For proper configuration, check out our tutorial list in the Description tab.

Screenshots

Nginx plugin settings
Remaining settings

FAQ

Important – Please refer to https://github.com/rtcamp/nginx-helper#frequently-asked-questions for up-to-date FAQs.

FAQ – Installation/Comptability

Q. Will this work out of the box?

No. You need to make some changes at the Nginx end. Please check our tutorial list.

FAQ – Nginx Fastcgi Cache Purge

Q. There’s a ‘purge all’ button? Does it purge the whole site?

Yes, it does. It physically empties the cache directory. It is set by default to /var/run/nginx-cache/.

If your cache directory is different, you can override this in your wp-config.php by adding
define(‘RT_WP_NGINX_HELPER_CACHE_PATH’,’/var/run/nginx-cache/’);

Replace the path with your own.

Q. Does it work for custom posts and taxonomies?

Yes. It handles all post-types the same way.

Q. How do I know my Nginx config is correct for fastcgi purging?

Manually purging any page from the cache, by following instructions in the previous answer.

Version 1.3.4 onwards, Nginx Helper adds a comment at the end of the HTML source (‘view source’ in your favourite browser):
<!–Cached using Nginx-Helper on 2012-10-08 07:01:45. It took 42 queries executed in 0.280 seconds.–>. This shows the time when the page was last cached. This date/time will be reset whenever this page is purged and refreshed in the cache. Just check this comment before and after a manual purge.

As long as you don’t purge the page (or make changes that purge it from the cache), the timestamp will remain as is, even if you keep refreshing the page. This means the page was served from the cache and it’s working!

The rest shows you the database queries and time saved on loading this page. (This would have been the additional resource load, if you weren’t using fast-cgi-cache.)

Q. I need to flush a cached page immediately! How do I do that?

Nginx helper plugin handles usual scenarios, when a page in the cache will need purging. For example, when a post is edited or a comment is approved on a post.

To purge a page immediately, follow these instructions:

Let’s say we have a page at the following domain: http://yoursite.com/about.
Between the domain name and the rest of the URL, insert ‘/purge/’.
So, in the above example, the purge URL will be http://yoursite.com/purge/about.
Just open this in a browser and the page will be purged instantly.
Needless to say, this won’t work, if you have a page or taxonomy called ‘purge’.

FAQ – Nginx Redis Cache

Q. Can I override the redis hostname, port and prefix?

Yes, you can force override the redis hostname, port or prefix by defining constant in wp-config.php. For example:

define(‘RT_WP_NGINX_HELPER_REDIS_HOSTNAME’, ‘10.0.0.1’);

define(‘RT_WP_NGINX_HELPER_REDIS_PORT’, ‘6000’);

define(‘RT_WP_NGINX_HELPER_REDIS_PREFIX’, ‘page-cache:’);
`

FAQ – Nginx Map

Q. My multisite already uses WPMU_ACCEL_REDIRECT. Do I still need Nginx Map?

Definitely. WPMU_ACCEL_REDIRECT reduces the load on PHP, but it still ask WordPress i.e. PHP/MySQL to do some work for static files e.g. images in your post. Nginx map lets nginx handle files on its own bypassing wordpress which gives you much better performance without using a CDN.

Q. I am using X plugin. Will it work on Nginx?

Most likely yes. A wordpress plugin, if not using explicitly any Apache-only mod, should work on Nginx. Some plugin may need some extra work.

Still need help!

Please post your problem in our free support forum.

Changelog

2.2.5

Add the capability to enable/disable purging of feeds. #281 – by Amaan Khan
Fix undefined port error when Redis port is set to empty string. #333 – by Amaan Khan

2.2.4

Introduces the capability to specify the NGINX_HELPER_LOG constant, allowing users to activate the logging feature. #318 – by Vishal Kakadiya
Existing users employing the nginx-helper plugin with logging enabled will experience no disruptions. However, if logging is disabled, users must define the NGINX_HELPER_LOG constant to re-enable the logging feature.

2.2.3

Add the URL being purged as parameter in rt_nginx_helper_purge_cached_file hook. #271 – by Arafat Islam
Fix performance issue when saving nav menus. #112, #272 – by Arafat Islam
Fix purging date archives for custom post types. #40, #268 – by Arafat Islam
Fix pages and CPT URLs not being purged on moving to trash. #191, #267 – by Arafat Islam
Fix notice – Undefined index: path #190, #251, #262 – by George Lagonikas
PHP 8.1 compatibility #291, #302 – by Siddharth Tikekar
Tested with WordPress 6.1 #285

2.2.2

Add action rt_nginx_helper_after_purge_all to fire after the entire cache has been purged whatever caching type is used. #232 – by Julien-prrs
Fix issue where settings not saved because the button’s value localized (for any language). #236 – by umeshnevase
Fix issue where “Custom Purge URL” option displays previous value. #240, #241 – by KirillGritcenko
Tested with WordPress 5.4

2.2.1

Fix timeout issue on FastCGI cache purge. #229 – by chandrapatel, thrijith

2.2.0

Add filter rt_nginx_helper_fastcgi_purge_suffix to change purge suffix for FastCGI cache. #141 – by stayallive
Add filter rt_nginx_helper_fastcgi_purge_url_base to change purge URL base for FastCGI cache. #141 – by stayallive
Update our code to be in line with WordPress Coding standards in various places. #209, #225 – by abhijitrakas, chandrapatel
Check and verify purging is enabled before purging cache. #168 – by jaredwsmith
Hide Purge Cache button in admin bar when purge is disabled. #218, #219 – by mbautista, chandrapatel
Don’t add Nginx Timestamp on WordPress login page. #204, #220 – by peixotorms, chandrapatel

2.1.0

Add wildcard cache key deletion for device type cache purge. #203 – by pradeep910
Add filter rt_nginx_helper_purge_url to filter the URL to be purged. #182 – by todeveni
Add filter rt_nginx_helper_purge_cached_file to filter the cached file name. #182 – by todeveni
Add filter rt_nginx_helper_remote_purge_url to filter remote URL to be purged. #182 – by todeveni
Add action rt_nginx_helper_after_fastcgi_purge_all to fire after the FastCGI cache has been purged. #182 – by todeveni
Add action rt_nginx_helper_after_redis_purge_all to fire after the Redis cache has been purged. #182 – by todeveni
Add action rt_nginx_helper_purged_file to fire an action after deleting file from cache. #182 – by todeveni
Add action rt_nginx_helper_before_remote_purge_url to fire an action before purging remote URL. #182 – by todeveni
Add action rt_nginx_helper_after_remote_purge_url to fire an action after remote purge request. #182 – by todeveni
Fix issue with post purge on new comments. #175 – by jinschoi
Fix Nginx Timestamp being added to invalid content type. #200 – by thrijith
Handle filesize exception while truncating nginx.log file. #206 – by peterjanes

2.0.3

Update article link for fastcgi cache purge. #187 – by gagan0123
Fix map generation issue on SUBDOMAIN_INSTALL. #189 – by ChrisHardie

2.0.2

Fix undefined error when we install the plugin for the first time and if Redis is not available. #162 – by Joel-James
Remove extra spacing for nginx map section. #169 – by ShashwatMittal
Purge Cache menu in front-end admibar now purge current page. #173 – by imranhsayed
Fix issue where cache is not cleared when page is swiched from publish to draft. #174 – by imranhsayed
Fix an issue where custom purge url option does not show newlines when using multiple urls. #184 – by mist-webit

2.0.1

Fix settings url for multisite: use network_admin_url to get network correct settings url. #163 – by Joel-James
Fix php error with arbitrary statement in empty – Prior to PHP 5.5. #165 – by PatelUtkarsh

2.0.0

Fix typo causing failure to purge on trashed comment. #159 – by jinschoi
Refactor Plugin structure and remove unused code. Initial code by chandrapatel, #153 – by jinschoi,
Run phpcs and fix warning. #158
Make compatible with EasyEngine v4.

1.9.12

Allow override Redis host/port/prefix by defining constant in wp-config.php #152 – by vincent-lu

1.9.11

Fixed issue where permalinks without trailing slash does not purging #124 – by Patrick
Check whether role exist or not before removing capability. #134 – by 1gor

1.9.10

Fixed issue where Nginx cache folders deleted on purge. #123 – by johan-chassaing
Fixed Redis purge all feature for installation where WordPress lives in a separate folder. #130 – by pySilver

1.9.9

Fix wp_redirect issue. #131 – by matt-h

1.9.8

Fixed homepage cache cleared when WPML plugin used #116 – by Niwreg
Fixed Purge Cache clears the whole Redis cache #113 – by HansVanEijsden
One log file for all site in WPMU.
Single site Redis cache purge when click on Purge Cache button in WPMU #122 – by Lars Støttrup Nielsen
Fixed notices and warnings.

1.9.7

Remove timestamp if cron or wp-cli #114 – by samedwards
Fixed notices and warnings.

1.9.6

Fixed cache purging on post publish.
Error fixed when redis server not installed.

1.9.5

Added custom purge URL option.

1.9.4

Added redis server connection timeout.
Added RedisException handling.

1.9.3

Added PhpRedis API support.
Added redis-lua script support to purge complete cache very fast.
Added composer.json support
Fixed cache purging link in admin bar.
Updated the initial settings to include the ‘purge_method’ #99 – by
gagan0123

1.9.2

Fix purging for Redis cache and FastCGI cache

1.9.1

Fix purging for custom post types

1.9

Added Redis cache purge support.

1.8.13

Fixed PHP notice for an undefined index when “Enable Logging” is not set.

1.8.12

Updated readme and changelog

1.8.11

Fix url escaping #82 – by
javisperez

1.8.10

Security bug fix

1.8.9

Default setting fix and wp-cli example correction – by bcole808

1.8.8

Added option to purge cache without nginx purge module – by bcole808

1.8.7

Added action rt_nginx_helper_purge_all to purge cache from other plugins – by gungeekatx

1.8.6

Removed wercker.yml from plugin zip/svn.
Updated readme

1.8.5

Added WP_CLI support – by Udit Desai

1.8.4

Fix undefined index issue and correct “purge_archive_on_del” key

1.8.3

Tested with WordPress 4.0
Fix issue #69

1.8.1

Tested with wordpress 3.9.1
Fix confilct with Mailchimp’s Social plugin

1.8

New admin UI
Fix missing wp_sanitize_redirect function call

1.7.6

Update Backend UI
Added Language Support

1.7.5

Fixed option name mismatch issue to purge homepage on delete.

1.7.4

Disable purge and stamp by default.

1.7.3

Suppressed unlink related error-messages which can be safely ignored.
Fixed a bug in purge-all option.

1.7.2

pjv fixed bug in logging file.

1.7.1

Fixes bug in true purge and admin screen.

1.7

True full cache purge added.
Map file location changed to uploads’ directory to fix http://rtcamp.com/support/topic/plugin-update-removes-map-file/
Log file location also changed to uploads’ directory.

1.6.13

pjv changed the way home URL is accessed. Instead of site option, the plugin now uses home_URL() function.

1.6.12

telofy added purging of atom and RDF feeds.

1.6.11

Removed comments from Admin screens since, it was interfering with media uploads in 3.5 up.

1.6.10

Cleaned up code.
Added credits for code.
Improved attachment purging.

1.6.9

Added Faux to Purge all buttons, to avoid misleading users.

1.6.8

daankortenbach added Purge Cache link to wp-admin bar

1.6.7

jk3us added better content-type detection for cache verification comments

1.6.6

darren-slatten added Manual ‘Purge all URLs’ functionality

1.6.5

Fixed typo that interfered with archive purge settings. Thanks to Daan Kortenbach for pointing this out.

1.6.4

Improved code for map generation to better conventions since the nesting confused some servers.
Added map update process to admin_init for frequent refreshes.

1.6.3

Fixed duplicate entries.

1.6.2

Another bug fix in the revised code for improved multisite and multidomain mapping.

1.6.1

Fixed bug in the revised code for improved multisite and multidomain mapping.

1.6

Revised code for improved multisite and multidomain mapping.

1.5

Timestamp now only gets added to content-type text/html
Added option to toggle timestamp creation

1.4

Fixed bug related to nomenclature of comment status that caused purge to fail.

1.3.9

Removed extraneous headers.

1.3.8

Fixed bug in single post/page/post-type purging code. Thanks to Greg for pointing this out here: http://rtcamp.com/support/topic/updating-post-nginx-helper-purge-cache-post/.

1.3.7

Changed the action hook, back to ‘shutdown’ from ‘wp_footer’ to add verification comments.
Added a check to prevent adding comments to ajax requests,

1.3.6

Changed the action hook, from ‘shutdown’ to ‘wp_footer’ to add verification comments. This was interfering with other plugins.

1.3.5

Improved Readme.
Improved cache verification comments.

1.3.4

Fixed duplicate entries generated for maps (Harmless, but doesn’t look good!)
Added timestamp html comments for cache verification, as described here: http://rtcamp.com/wordpress-nginx/tutorials/checklist/

1.3.3

Fixed map generation for multi domain installs using domain mapping plugin, where blog ids were not displayed.

1.3.2

Fixed map generation for multi domain installs with domain mapping plugin.

1.3.1

Minor fixes for directory structure and file names.

1.3

Improved Readme.

1.2

Fixed map generation error.
Fixed purging logic.
Fixed UI where purge settings were lost on disabling and re-enabling purge.
Minor Ui rearrangement.

1.1

Improved readme.txt. Added Screenshots.

1.0

First release