1. Introduction
Quick User Cleaner is a simple plugin for Joomla! 3 and Joomla! 4 that helps you to delete inactive user accounts automatically. You can individually configure the account types to be deleted by specifying a time period. If user accounts match the type ('not activated', 'never visited' or 'idle account') and the selected period of time, they are automatically deleted when a certain event occurs.
2. Requirements
Quick User Cleaner is a Joomla extension, so you need to have a website that is built on Joomla. The plugin woorks with Joomla versions 3.9, 3.10 and 4.x. Please make sure that PHP 7.4+ is running on your webspace.
3. Installation & Updating
When you download Quick User Cleaner from my site, you get a file that is called quickusercleaner_VERSION.zip. VERSION stands for the current version of the plugin, so the latest version would be quickusercleaner_1.1.0.zip.
- Log in to the backend of your Joomla installation as a super administrator.
- Go to System and klick on Install → Extensions (in Joomla 3 use: Extensions → Manage → Install)
- Drag the file to the upload area or select the file via the upload button.
After the installation process is completed, you will be notified. Navigate to the plugin (System → Manage → Plugins or Extensions → Plugins in Joomla 3) and activate it.
If a newer version of the Quick User Cleaner plugin is available for download, you will be notified in the Joomla backend. You can then install the latest version directly from Extensions: Update. If you're using the Pro version of Quick User Cleaner, make sure you've entered a valid Download ID in the appropriate field. Alternatively, you can also download the latest versions from my website and install them as explained above.
Setup & Configuration
If you open the plugin settings you can configurate the plugin to your needs.
Test Mode / Live Mode
Select if you want to run the plugin in test mode (default setting). If running in test mode the plugin will show a list of deletable accounts based on the settings below. If you switch to live mode, the plugin will start working and delete accounts if there are any that are deletable.
Time period
Please select the desired period of time after which the different accounts will be deleted. You can configure the following account types:
Not activated accounts: These are accounts that have been awaiting activation for longer than the configured period.
For example: A user registered at your page on 01/08/2022 and did not activate his account yet. You set a period of 3 days for that type of account. If the user has not activated his account by 04/08/2022 his account will be deleted automatically by the plugin.
Never visited accounts: These are accounts that have been activated but never been visited; the user did not log in for a single time.
For example: A user registered at your page on 01/08/2022 and activated his account on 03/08/2022 but has never logged in to his account. You set a period of 1 week for that type of account. If the user does not log in to his account by 11/08/2022 (1 week after activation) his account will be deleted automatically by the plugin.
Idle accounts: These are accounts that have been activated and visited, but the last visit is too long ago.
For example: user registered at your page on 01/08/2022 and activated his account on 03/08/2022 and did log in in 10/07/2022 for the last time. You set a period of 3 months for that type of account. If the user does not log in to his account again by 11/10/2022 (3 months after his last login) his account will be deleted automatically by the plugin.
Plugin Trigger
Select at which event the plugin will act and delete accounts. You can select the following triggers:
- Login Backend Super User
- Login Backend Administrator *
- Login Backend Manager *
If an above mentioned user logs into the backend, the plugin and live mode are activated, the Quick User Cleaner plugin will delete accounts, that meet the settings. The trigger setting 'manager' also includes 'administrator' and 'super user', 'administrator' includes 'super user'.
5. Notifications *
In this tab you can set up the notifications that will be sent to administrators and users if an account is deleted.
E-Mail to administrator
Select if the administrator (super user) of the site should be notified via email when accounts are being deleted.
Email to users
Select it the users should be notified via email when their accounts are being deleted. You can enter different subjects and message texts for each type of accounts. If you leave the fields empty the users will receive a default message that is stored in the plugin's language files.
6. Download ID *
If you purchased the pro version of Quick User Cleaner please enter your download ID to get updates through the Joomla update system.
7. Uninstalling the plugin
To uninstall the plugin go to System and klick on Install → Extensions then choose Manage Extensions in the top bar. (in Joomla 3 use: Extensions → Manage → Manage) Select the plugin and click on uninstall to delete the plugin.
8.Support
If you need help, contact me via support ticket. Log into your user account and select Support from the top menu. You will receive an answer from me as soon as possible.
* only available in pro version