Cache Cleaner uses the options below. Labels and descriptions follow the current English extension language strings. Rows marked as Pro are editable only in the Pro edition; Free either omits the control or keeps its documented fixed value.
Options
| Download Key | Please enter your Download Key from the Regular Labs website here. You can find your Download Key under Downloads on the Regular Labs website after logging in. Pro only. |
What to clean
| Purge Cache | Normal Joomla cache cleaning always runs. This cleans the cache stored by Joomla! (not the browser's cache). Options: Yes |
| Minimum Age (in minutes) | Set the minimum age (in minutes) of the files to delete. The age is measured from the last time the file was modified. Pro only. |
| Clear Expired Cache | Enable to purge the expired cache when cleaning cache. This is a separate optional action and does not enable or disable normal Joomla cache cleaning. Options: No, Yes, Only via button |
| Purge Update Cache | Enable to purge the cache in the updates table (used for checking updates for Joomla! and extensions) when cleaning cache. Options: No, Yes, Only via button |
| Purge Disabled Redirects | Enable to purge the disabled links from the redirects component. Options: No, Yes, Only via button |
| Minimum Age (in days) | Set the minimum age in days of disabled redirects to remove. Set this to 0 to remove all disabled redirects. |
| Recreate Namespace Map | Enable to recreate the PSR4 namespace map (used for autoloading) when cleaning cache. Options: No, Yes, Only via button |
| Invalidate Media Versions | Select to delete the media/asset cache files and reset the media versions of the asset files in the media folder. Options: No, Yes, Only via button Pro only. |
| Global Check-in | Enable to do a global check-in. This will unlock any checked-out items. Options: No, Yes, Only via button |
| Empty tmp Folder | Select to have the tmp folder emptied when cleaning cache Options: No, Yes, Only via button |
| Minimum Age (in minutes) | Set the minimum age (in minutes) of the files to delete. The age is measured from the last time the file was modified. Pro only. |
| Empty Custom Folders | Select to have the custom folders emptied when cleaning cache Options: No, Yes, Only via button Pro only. |
| Custom Folders | Enter the paths of extra folders you want emptied. The path should be relative to the root of the site. One path per line. WARNING: Please use with care. If you enter a folder that has important files/folders, you will lose them when cache is cleaned! Pro only. |
| Minimum Age (in minutes) | Set the minimum age in minutes of files to delete from the custom folders. The age is measured from the last time the file was modified. Pro only. |
| Clean Database Tables | Options: No, Yes, Only via button Pro only. |
| Database Tables | A comma or enter separated list of database table names you want emptied. You may use #__ as a placeholder for your Joomla database prefix, like #__dbcache instead of jos_dbcache. WARNING: Please use with care. If you enter names of tables with important data, you will lose it when cache is cleaned! Pro only. |
| LiteSpeed | Purge the servers LiteSpeed cache when cleaning cache. This only works when your server is using LiteSpeed caching. Options: No, Yes, Only via button Pro only. |
| OPcache | Purge the servers OPcache when cleaning cache. This only works when your server is using OPcache. Options: No, Yes, Only via button Pro only. |
| Memcached | Purge the servers Memcached cache when cleaning cache. This only works when your server is using Memcached. Options: No, Yes, Only via button Pro only. |
| Memcache(d) Server Host | Pro only. |
| Memcache(d) Server Port | Pro only. |
| Redis | Purge the servers Redis cache when cleaning cache. This only works when your server is using Redis. Options: No, Yes, Only via button Pro only. |
| Persistent Redis | Options: No, Yes Pro only. |
| Redis Server Host/Sock | Pro only. |
| Redis Server Port | Port discarded if connecting to Redis server over Unix sockets. Pro only. |
| Redis Server Authentication | Pro only. |
| Redis Database | Pro only. |
| SiteGround Cache | Purge the SiteGround Cache. You can only use this if your site is running on a SiteGround server on which Static/Dynamic Cache is active. Options: No, Yes, Only via button Pro only. |
Cloudflare PRO | |
|---|---|
| Enable | Purge the CloudFlare cache. You can only use this if you have an active CloudFlare account. Options: No, Yes, Only via button Pro only. |
| Authorization Method | Select what method to use for the authorization. Options: API Token, Username & API Key Pro only. |
| Username | The CloudFlare account username Pro only. |
| API Key | Enter the CloudFlare API Key (see link above). Pro only. |
| API Token | Enter the CloudFlare API Token (see link above). Pro only. |
| Domains | A comma separated list of domains of which you want to purge the cache. Leave empty to use the current (sub)domain. Pro only. |
KeyCDN PRO | |
| Enable | Purge the KeyCDN cache. You can use this only with an active KeyCDN account. Options: No, Yes, Only via button Pro only. |
| API Authentication Key | Enter the KeyCDN API Authentication Key (see link above). Pro only. |
| Zone IDs | A comma separated list of KeyCDN pullzone IDs of which you want to purge the cache. Pro only. |
CDN77 PRO | |
| Enable | Purge the CDN77 cache. You can use this only with an active CDN77 account. Options: No, Yes, Only via button Pro only. |
| Username | Enter the CDN77 account username. Pro only. |
| API Password | Enter the CDN77 API Password (see link above). Pro only. |
| CDN IDs | A comma separated list of CDN77 CDN IDs of which you want to purge the cache. Pro only. |
BunnyCDN PRO | |
| Enable | Purge the BunnyCDN cache. You can only use this if you have an active BunnyCDN account. Options: No, Yes, Only via button Pro only. |
| API Key | Enter the BunnyCDN API Key (see link above). Pro only. |
| Zone IDs | A comma separated list of BunnyCDN pullzone IDs of which you want to purge the cache. Pro only. |
| Query Url | Options: No, Yes, Only via button Pro only. |
| URL | Enter the full URL to query in the background after purging the other caches. Pro only. |
| URL Timeout | Set the maximum time in seconds that may be used to query the above url. Pro only. |
How to clean it
Quick Link
| Display Status bar Button | Select to show a button in the status bar. Options: No, Yes |
| Display Toolbar Button | Select to show a button in the toolbar. Options: No, Yes |
| Add Button Text | Select to show text in the button. Options: No, Yes |
| Button Text | Set the text to show in the button. You can use a language string. |
| Button Classname | Enter a class name to add to the button. |
Frontend Secret URL
| Frontend secret | Enter or generate the secret used in a frontend URL, for example ...?cleancache=word-word. |
| Show message | Show a message after cache is cleaned through the frontend secret URL. Options: No, Yes |
Automatic cleaning on Save
Administrator
| Enable | Clean the cache after saving or applying something in the administrator. Options: No, Yes |
| Show message | Show a message after automatic administrator cleaning. Options: No, Yes |
Frontend
| Enable | Clean the cache after saving or applying something on the frontend. Options: No, Yes |
| Show message | Show a message after automatic frontend cleaning. Options: No, Yes |
| Clean on tasks | Enter a comma-separated list of tasks to consider a save. You can also add tasks such as publish, unpublish, remove, and delete. |
Automatic cleaning by Interval PRO
Administrator PRO
| Enable | Clean the administrator cache at the configured interval. Options: No, Yes Pro only. |
| Seconds | Set the administrator interval in seconds. Cleaning runs on page load when the previous clean is older than this interval. Pro only. |
| Show message | Show a message after interval cleaning in the administrator. Options: No, Yes Pro only. |
Frontend PRO
| Enable | Clean the frontend cache at the configured interval. Options: No, Yes Pro only. |
| Seconds | Set the frontend interval in seconds. Cleaning runs on page load when the previous clean is older than this interval. Pro only. |
| Show message | Show a message after interval cleaning on the frontend. Options: No, Yes Pro only. |
Advanced
| Show Size | Enable to show the total size of the cleaned cache in the message. Options: No, Yes |
| Ignore Files/Folders | Enter the paths of folders and files you don't want to be removed when cleaning cache. The path should be relative to the root of the site. One path per line. |
| Log Path | The path of the log file used to store the time of the last clean. The file 'cachecleaner_lastclean.log' will be stored in this folder. Make sure your Joomla! setup is able to write to this folder. Pro only. |