1. cPanel & WHM Documentation
  2. cPanel Knowledge Base
  3. cPanel Developed Plugins
  4. WP Toolkit
wordpress

WP Toolkit

Valid for versions 120 through the latest version

Version:

102

120

Last modified: August 12, 2024

Overview

The WP Toolkit plugin allows you to easily install, configure, and manage WordPress®.

Install WP Toolkit

Note:

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:

  1. The WHM Marketplace
  2. Manual installation

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.

WHM Marketplace

To install the WP Toolkit plugin in the WHM Marketplace interface (WHM » Home » Server Configuration » WHM Marketplace), perform the following steps as the root user:

  1. Navigate to the WHM Marketplace interface (WHM » Home » Server Configuration » WHM Marketplace).
  2. Locate the WP Toolkit listing under Add Extensions and click Install.

Manual installation

To install the WP Toolkit plugin on the command line, run the following command as the root user:

bash <(curl https://wp-toolkit.plesk.com/cPanel/installer.sh || wget -O - https://wp-toolkit.plesk.com/cPanel/installer.sh)

WHM configuration

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 Upgrade Database Version interface (WHM » Home » Database Services » Upgrade Database Version).

  • 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_limit value 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
    • MySQL
    • Subdomains
    • MIME Types
    • Cronjobs
    • Directory Privacy
    • Password & Security
    • File Manager
    • Redirects

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:

Feature
 WP Toolkit WP Toolkit Deluxe
Customizable Installation
Manage Existing Installations
Website Dashboard
1-Click Login
Change Admin Password
Change DB Password
Open DB in phpMyAdmin
Backups
Manual Updates
Manage Plugins and Themes
Upload Plugins and Themes
Logs
WordPress Integrity Check
Plugin and Theme Sets
Automatic Updates (Single Site)
Maintenance Mode
Debug Management
Password Protection
Search Engine Indexing Management
Staging and Cloning
1-Click Hardening
Automatic Hardening
Multiple Hardening
Security Rollback
Mass Site Management
Smart Updates

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 root user:

systemctl status wp-toolkit-scheduled-tasks

To force an auto-update run, run the following command as the root user:

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 /usr/local/cpanel/3rdparty/wp-toolkit/var/logs/ directory.

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.

Warning:

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 /usr/local/cpanel/3rdparty/wp-toolkit/var/etc/config.ini file:

logCommandsAndFileOperations = true

Uninstall WP Toolkit

To uninstall the WP Toolkit plugin on the command line, run one of the following commands as the root user:

  • Red Hat®-based servers 

    rpm -e wp-toolkit-cpanel

  • Ubuntu®-based servers 

    apt-get purge wp-toolkit-cpanel

Additional Documentation