WP Toolkit

Overview

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

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:

• WHM Marketplace
• Manual Installation

To confirm the WP Toolkit installation, access 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).

Upon installation of the WP Toolkit, the system automatically installs and enables the PHP-FPM Service for cPanel Daemons. This service also remains enabled when you update or remove WP Toolkit from the server.

WHM Marketplace

To install the WP Toolkit plugin via 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 using 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

The following requirements must be met to effectively use the WP Toolkit plugin:

• WordPress exclusively supports MySQL® version 5.7 and newer. To update your server's MySQL version, utilize WHM’s Upgrade Database Version interface (WHM » Home » Database Services » Upgrade Database Version).
• The PHP-FPM Service for cPanel Daemons option in WHM’s Service Manager interface (WHM » Home » Service Configuration » Service Manager) must be enabled and remain active for WP Toolkit functionality.
• To enable any necessary WordPress PHP extensions, use the PHP Extensions section within WHM’s EasyApache 4 interface (WHM » Home » Software » EasyApache 4). A comprehensive list of these extensions can be found in WordPress' Server Environment documentation. To update your server's PHP version, also use WHM’s EasyApache 4 interface.
• The WP Toolkit plugin requires a PHP memory_limit value of 128 MB or higher. This limit can be adjusted in WHM’s MultiPHP INI Editor interface (WHM » Home » Software » MultiPHP INI Editor).
• Within 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 detailed information on the software versions required for WordPress to operate correctly, refer to WordPress’ Requirements documentation.

Enable Deluxe Features

WP Toolkit is available in both a standard version 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 highlights the feature differences between the standard WP Toolkit and WP Toolkit Deluxe versions:

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

Troubleshooting and Maintenance

Updates

WP Toolkit updates run nightly. To verify the system’s auto-update status, execute the following command as the root user:

systemctl status wp-toolkit-scheduled-tasks

To manually force 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'

Logging

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

To troubleshoot WP Toolkit issues, you can run 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

Enhanced logging can also be enabled for more detailed debugging and troubleshooting.

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

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

logCommandsAndFileOperations = true

Uninstallation

To uninstall the WP Toolkit plugin from the command line, run the following command as the root user on Ubuntu®-based servers:

apt-get purge wp-toolkit-cpanel