Cache Cleaner

Clean cache fast in Joomla!

  • Last updated: 22-May-2018
  • Version: 6.3.0
  • Types: Admin module System plugin
  • Joomla rating: 100%
Joomla rating: 100%

Do you like Cache Cleaner?

Rate it!

Tutorial for Cache Cleaner

There is a Free and a Pro version of Cache Cleaner.
The parts in this tutorial that only concern the Pro version will be marked with: Pro only

Introduction

With Cache Cleaner you can clean your cache fast and easily via a link in your Joomla! Administrator.

Not only that, it also gives you the possibility to purge expired cache, do a global check-in, empty the temp folder, empty user-defined folders and database tables … all with just 1 click!

Cache Cleaner can clean your cache automatically when you save an article or other item. And it can clean your cache at preset intervals too.
So no more clickety-click to get to the core Joomla! Cache Manager and no more manually deleting files.

What is Cache Cleaner?

Cache Cleaner is a Joomla! administrator module (and system plugin).

On all your Joomla administator pages you will see a ‘Clean Cache’ module (icon & link) in the ‘status’ position (bottom bar). With just 1 click it will clean your cache and optionally a whole lot more.

If you are using Joomla! (or 3rd party) caching, you will need to clean your cache when making changes to your website. Normally this means having to go to the Joomla! Cache Manager, select all cache types and delete them. This is very annoying and requires a lot of clicks and waiting time.

With Cache Cleaner this is done with one click. It doesn't need to reload the page either because it uses ajax to do this in the background.

Additionally you can set Cache Cleaner up to clean a lot more stuff:

  • Purge Joomla cache
  • Purge expired cache
  • Global Check-In Pro only
  • Empty cache folder
  • Empty temp folder
  • Empty user-defined folders Pro only
  • Empty user-defined database tables Pro only
  • Purge JRE cache Pro only
  • Purge JotCache Pro only
  • Purge SiteGround Varnish Cache Pro only
  • Purge CDN77 cache Pro only
  • Purge KeyCDN cache Pro only
  • Purge MaxCDN cache Pro only
  • Purge CloudFlare cache Pro only
  • Purge cache on save
  • Purge cache by interval Pro only

You can switch these options on/off in the Cache Cleaner system plugin settings.

Status Bar

After clicking on the ‘Clean Cache’ link Cache Cleaner will show a status bar at the top of your screen. This will turn green when the cache is successfully cleaned.

Cache Cleaner will also show you how many KB or MB is cleaned.

Frontend Secret URL

You can make Cache Cleaner clean your cache without even having to log into the administrator.

By defining a secret word, you can simply add this to any frontend url of your website.

For instance, set your secret word to: mysecret

Now you can add ?cleancache=mysecret or &cleancache=mysecret to your url, like:

http://www.yourdomain.com?cleancache=mysecret
http://www.yourdomain.com/some-page?cleancache=mysecret
http://www.yourdomain.com/index.php?option=com_content&...&cleancache=mysecret

So use a ? for SEF urls and an & for urls that already have variables.

Cronjobs

You can use the above explained Frontend Secret URL to clean cache via a cronjob too.

To make the page load as fast as possible, and not have it load any frontend html, you can add &break=1 to the url.

http://www.yourdomain.com?cleancache=mysecret&break=1

You will probably need to use wget to call the url via the cronjob. But ask you host if they provide documentation on how to set it up.

The cronjob command will have to be something like:

wget -q -O /dev/null "http://www.yourdomain.com?cleancache=mysecret&break=1"

Or:

/usr/bin/wget -q -O /dev/null "http://www.yourdomain.com?cleancache=mysecret&break=1"

Settings

Here is the full list of the options you can find in the Cache Cleaner system plugin settings:

Basic Options

Purge Cache This will clean the cache stored by Joomla! (not the browser's cache)
Clear Expired Cache Enable to purge the expired cache when cleaning cache.
Purge Update Cache Enable to purge the cache in the updates table (used for checking updates for Joomla! and extensions) when cleaning cache.
Purge OPcache Enable to purge the servers OPcache when cleaning cache. This only works when your server is using OPcache.
Global Check-in Enable to do a global check-in. This will unlock any checked-out items.

Frontend secret URL

You can define a secret word that you can use in a frontend URL to be able to clean the cache from a frontend URL.
Place your secret word after cleancache=, like:
http://www.yourdomain.com/index.php?cleancache=your_word
http://www.yourdomain.com/index.php?option=com_content&...&cleancache=your_word

Frontend secret Enter a word that can be placed in a frontend URL to clean cache.
...&cleancache=your_word

Automatic cleaning on Save

Cleans the cache if you save (or apply) something

Show message Enable to show a message when cache is cleaned.
Clean on tasks Comma separated list of tasks to consider as a save. You can also add tasks like publish, unpublish, remove, etc.

Automatic cleaning by Interval Pro only

Cleans the cache every so many seconds

Seconds Enter the interval in seconds. The cache will be cleaned on pageload if it hasn't been cleaned for more than so many seconds.
Show message Enable to show a message when cache is cleaned.

Advanced Options

Clean Other Folders

Empty tmp folder Select to have the tmp folder emptied when cleaning cache
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 loose them when cache is cleaned!

Clean Other Database Tables 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 loose it when cache is cleaned!
Query Url

Options: No, Yes, Only via button
URL Enter the full url to query when purging the cache. This url will be queried in the background.

3rd Party Cache Pro only

JRE Cache Clean the cache made by the JRE Cached extension, if it is installed
JotCache Clean the cache made by the JotCache extension, if it is installed
SiteGround Cache Purge the SiteGround Varnish Cache. You can only use this if your site is running on a SiteGround server on which Varnish Cache is active.

MaxCDN

MaxCDN Purge the MaxCDN cache. You can only use this if your have an active MaxCDN account.

Options: No, Yes, Only via button
Authorization Key Enter the MaxCDN Authorization Key (see link above).
Zone IDs A comma separated list of MaxCDN pullzone IDs of which you want to purge the cache.

KeyCDN

KeyCDN Purge the KeyCDN cache. You can only use this if your have an active KeyCDN account.

Options: No, Yes, Only via button
API Authentication Key Enter the KeyCDN API Authentication Key (see link above).
Zone IDs A comma separated list of KeyCDN pullzone IDs of which you want to purge the cache.

CDN77

CDN77 Purge the CDN77 cache. You can only use this if your have an active CDN77 account.

Options: No, Yes, Only via button
API Password Enter the CDN77 API account username.
API Password Enter the CDN77 API Password (see link above).
CDN IDs A comma separated list of CDN77 CDN IDs of which you want to purge the cache.

CloudFlare

CloudFlare Purge the CloudFlare cache. You can only use this if your have an active CloudFlare account.

Options: No, Yes, Only via button
Username The CloudFlare account username
API Key Enter the CloudFlare API Key (see link above).
Domains A comma separated list of domains of which you want to purge the cache. Leave empty to use the current domain.

Other Options

Show Size Enable to show the total size of the cleaned cache in the message.
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.

Administrator Module Options

Display link How do you want the link to be displayed?

Options: Icon only, Text only, Both
Link Text The text to display as link.
Display Toolbar Button Select to show a button in the toolbar.

Installation

You can either install Cache Cleaner by using the core extension manager available in the Joomla! Administrator Control Panel, or by using the powerful Regular Labs Extension Manager.

Note: When updating Cache Cleaner, you do not need to uninstall it first. The package will update all the files automatically.

Keep in mind that when you update to a major new version (or uninstall first), you might lose some configuration settings.

Regular Labs Extension Manager

It is very easy to install/update any Regular Labs Extension using the Regular Labs Extension Manager.

Please see the Tutorial for the Regular Labs Extension Manager for more detailed information...

Joomla! Extension Manager

To install via the Joomla! Extension Manager, just follow these steps:

  1. Log into your Joomla administrator;
  2. In the menu, choose: Extensions >> Extensions;
  3. Choose the tab: Install from Web (or enable it if you haven't done so yet);
  4. Select the search field and enter Cache Cleaner and hit enter;
  5. Click on the Cache Cleaner listing;
  6. Click on Install;
  7. Click on Install to confirm.
Joomla! Installer - Install from Web

Or if you need to install the Pro version or cannot install via the 'Install via Web' method for some reason:

  1. Download the extension install file (.zip);
  2. Log into your Joomla administrator;
  3. In the menu, choose: Extensions >> Extensions;
  4. Choose the tab: Upload Package File;
  5. Click on the Choose File button and select the extension zip;
  6. Click on Upload & Install.
Joomla! Installer - Upload Package File

If you have problems installing Cache Cleaner, please try the manual installation process as described here: docs.joomla.org/Installing_an_extension