Valid for versions 102 through the latest version
Last modified: December 21, 2022
The WP Toolkit plugin allows you to easily install, configure, and manage WordPress®.
Install WP Toolkit
The system automatically installs the WP Toolkit plugin in cPanel & WHM versions 102 and later.
You can install the WP Toolkit plugin with the following methods:
You may confirm WP Toolkit installation by accessing WHM’s WP Toolkit interface (WHM » Home » Plugins » WP Toolkit). If enabled, cPanel users can also access this plugin in cPanel’s WP Toolkit interface (cPanel » Home » Domains » WP Toolkit).
When you install the WP Toolkit, the system automatically installs the PHP-FPM Service for cPanel Daemons. The system also enables the PHP-FPM Service for cPanel Daemons when you update or remove WP Toolkit from the server.
To install the WP Toolkit plugin in the WHM Marketplace interface (WHM » Home » Server Configuration » WHM Marketplace), perform the following steps as the
- Navigate to the WHM Marketplace interface (WHM » Home » Server Configuration » WHM Marketplace).
- Locate the WP Toolkit listing under Add Extensions and click Install.
To install the WP Toolkit plugin on the command line, run the following command as the
sh <(curl https://wp-toolkit.plesk.com/cPanel/installer.sh || wget -O - https://wp-toolkit.plesk.com/cPanel/installer.sh)
You must fulfill these requirements to use the WP Toolkit plugin:
WordPress only supports MySQL® version 5.7 and later. To update your server’s version of MySQL to 5.7 and later, use WHM’s MySQL/MariaDB Upgrade interface (WHM » Home » SQL Services » MySQL/MariaDB Upgrade).
Enable the PHP-FPM Service for cPanel Daemons, which must remain enabled to use the WP Toolkit.
To enable any required WordPress PHP extensions, use the PHP Extensions section of WHM’s EasyApache 4 interface (WHM » Home » Software » EasyApache 4). For a list of these PHP extensions, read WordPress’ Server Environment documentation. To update your server’s PHP version, use WHM’s EasyApache interface (WHM » Home » Software » EasyApache 4).
The WP Toolkit plugin requires a PHP
memory_limitvalue of 128 MB or higher. You can set this limit in WHM’s MultiPHP INI Editor interface (WHM » Home » Software » MultiPHP INI Editor).
In the Feature Manager, enable the following features:
- WP Toolkit
- MIME Types
- Directory Privacy
- Password & Security
- File Manager
For information about software versions WordPress requires to run properly, read WordPress’ Requirements documentation.
Enable Deluxe features
WP Toolkit is available in a standard version and a Deluxe version. To use WP Toolkit Deluxe features, enable both the WP Toolkit and WP Toolkit Deluxe features in the Feature Manager.
The following table shows the differences between the WP Toolkit and WP Toolkit Deluxe version features:
|WP Toolkit||WP Toolkit Deluxe|
|Manage Existing Installations|
|Change Admin Password|
|Change DB Password|
|Open DB in phpMyAdmin|
|Manage Plugins and Themes|
|Upload Plugins and Themes|
|WordPress Integrity Check|
|Plugin and Theme Sets|
|Automatic Updates (Single Site)|
|Search Engine Indexing Management|
|Staging and Cloning|
|Mass Site Management|
Updates to WP Toolkit
Updates to the WP Toolkit run nightly.
To check the system’s auto-update status, run the following command as the
systemctl status wp-toolkit-scheduled-tasks
To force an auto-update run, run the following command as the
su wp-toolkit --shell=/bin/bash -c '/usr/bin/sw-engine -d auto_prepend_file=/usr/local/cpanel/3rdparty/wp-toolkit/scripts/scheduled-task-prepend-file.php /usr/local/cpanel/3rdparty/wp-toolkit/plib/scripts/instances-auto-update.php'
Troubleshoot WP Toolkit
The log files for the WP Toolkit reside in the
To troubleshoot the WP Toolkit, run the following command, where
filename represents the log file’s name:
grep -A1 ERROR /usr/local/cpanel/3rdparty/wp-toolkit/var/logs/filename.log
You can also enable enhanced logging to debug and troubleshoot the WP Toolkit.
We strongly recommend that you only enable enhanced logging when you need to troubleshoot the WP Toolkit. Enhanced logging may slow down WP Toolkit’s performance significantly.
To enable enhanced logging, add the following line to the
logCommandsAndFileOperations = true
Uninstall WP Toolkit
To uninstall the WP Toolkit plugin on the command line, run one of the following commands as the
Red Hat®-based servers
rpm -e wp-toolkit-cpanel
apt-get purge wp-toolkit-cpanel