WP Toolkit | cPanel & WHM Documentation

Overview

The WP Toolkit plugin offers a streamlined solution for installing, configuring, and managing WordPress® effortlessly.

Note: The system automatically installs the WP Toolkit plugin in cPanel & WHM versions 102 and later.

You can install the WP Toolkit plugin using the following methods:

• The WHM Marketplace
• Manual installation

To confirm that WP Toolkit is installed, navigate to WHM’s WP Toolkit interface (WHM » Home » Plugins » WP Toolkit). If enabled, cPanel users can also access this plugin via cPanel’s WP Toolkit interface (cPanel » Home » Domains » WP Toolkit).

When you install WP Toolkit, the system automatically installs the PHP-FPM Service for cPanel Daemons. This service also remains enabled when you update or remove WP Toolkit from the server.

Installation via WHM Marketplace

To install the WP Toolkit plugin through the WHM Marketplace interface (WHM » Home » Server Configuration » WHM Marketplace), follow these 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 via the command line, execute 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 Requirements

To ensure proper functionality of the WP Toolkit plugin, the following requirements must be met:

• MySQL Version: WordPress requires MySQL version 5.7 or later. To update your server’s MySQL version, use WHM’s Upgrade Database Version interface (WHM » Home » Database Services » Upgrade Database Version).
• PHP-FPM Service: The PHP-FPM Service for cPanel Daemons option must be enabled in WHM’s Service Manager interface (WHM » Home » Service Configuration » Service Manager). This service must remain enabled for WP Toolkit to function.
• PHP Extensions: Enable any required WordPress PHP extensions through the PHP Extensions section of WHM’s EasyApache 4 interface (WHM » Home » Software » EasyApache 4). For a comprehensive list of necessary PHP extensions, refer to the WordPress Server Environment documentation. To update your server’s PHP version, use WHM’s EasyApache interface (WHM » Home » Software » EasyApache 4).
• PHP Memory Limit: The WP Toolkit plugin requires a PHP memory_limit value of 128 MB or higher. You can adjust this setting in WHM’s MultiPHP INI Editor interface (WHM » Home » Software » MultiPHP INI Editor).
• Feature Manager Settings: In WHM’s Feature Manager interface (WHM » Home » Packages » Feature Manager), ensure the following features are enabled:
  • WP Management
  • MySQL
  • Subdomains
  • MIME Types
  • Cronjobs
  • Directory Privacy
  • Password & Security
  • File Manager
  • Redirects

For more details on WordPress software version requirements, consult the WordPress Requirements documentation.

Enabling Deluxe Features

WP Toolkit is available in both a standard and a Deluxe version. To access WP Toolkit Deluxe features, you must enable both the WP Management and WP Toolkit Deluxe features within WHM’s Feature Manager interface (WHM » Home » Packages » Feature Manager).

The table below illustrates the distinctions between the standard 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 and Troubleshooting

Updates for WP Toolkit run automatically every night.

To check the current auto-update status, execute the following command as the root user:

systemctl status wp-toolkit-scheduled-tasks

To manually initiate an auto-update, 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'

WP Toolkit log files are located in the /usr/local/cpanel/3rdparty/wp-toolkit/var/logs/ directory.

To troubleshoot WP Toolkit issues, use the following command, replacing filename with the name of the relevant log file:

grep -A1 ERROR /usr/local/cpanel/3rdparty/wp-toolkit/var/logs/filename.log

Enabling Enhanced Logging

Warning: We strongly recommend enabling enhanced logging only when actively troubleshooting WP Toolkit. This feature can significantly impact performance by generating large log files automatically.

To enable enhanced logging, add the following line to the /usr/local/cpanel/3rdparty/wp-toolkit/var/etc/config.ini file:

logCommandsAndFileOperations = true

Uninstalling WP Toolkit

To uninstall the WP Toolkit plugin from the command line, run the appropriate command below as the root user:

• For Ubuntu®-based servers:

apt-get purge wp-toolkit-cpanel