WordPress Toolkit

Valid for versions 100 through the latest version

Version:

86

92

94

100


Last modified: September 22, 2021

Overview

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

After you install the WordPress Toolkit plugin, you can access this feature in WHM’s WordPress Toolkit interface (WHM >> Home >> Plugins >> WordPress Toolkit). If enabled, cPanel users can access this feature in cPanel’s WordPress Toolkit interface (cPanel >> Home >> Applications >> WordPress Toolkit).

Note:

For the most current updates and improvements to the WordPress Toolkit plugin, read Plesk’s WordPress Toolkit change log documentation.

Feature comparison

Wordpress Toolkit is available in a standard version and a Deluxe version. The following table shows the differences between the WordPress Toolkit and WordPress Toolkit Deluxe version features:

Feature WordPress Toolkit WordPress Toolkit Deluxe
Customizable Installation
Manage Existing Installations
Website Dashboard
Change Admin Password
Change DB Password
Restore Backups
Manual Updates
1-Click Login
Open DB in phpMyAdmin
Single Site Auto Updates
Search Engine Indexing Management
Automatic Hardening
Password Protection
Maintenance Mode
Debug Management
Plugin & Theme Sets Management
Cloning
Staging
1-Click Hardening
Mass Hardening
Mass Updates
Security Rollback
Smart Updates

Server software requirements

For information about software versions WordPress requires to run properly, read WordPress’ Requirements documentation.

Configure server software requirements

You can use the following interfaces to configure your server’s WordPress Toolkit plugin software requirements:

  • 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).

    Important:

    WordPress only supports MySQL version 5.7 and later.

  • To update your server’s PHP version, use WHM’s EasyApache interface (WHM >> Home >> Software >> EasyApache 4).

  • 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 in WordPress’ Server Environment documentation.

Install WordPress Toolkit

As of cPanel & WHM version 92, the nightly cPanel & WHM update process detects whether WordPress Manager is installed on the server. If WordPress Manager is installed, the update process will install WordPress Toolkit.

The system automatically installs the PHP-FPM Service for cPanel Daemons when the WordPress Toolkit is installed. The system also sets the PHP-FPM Service for cPanel Daemons to enabled when the WordPress Toolkit is installed, updated, or removed from the server.

Important:
  • The WordPress Toolkit plugin is only compatible with the following operating systems and cPanel & WHM versions:

    • The CentOS 7, CentOS 8, CloudLinux™ 6, CloudLinux 7, CloudLinux 8, AlmaLinux OS 8, and Ubuntu® operating systems.
    • cPanel & WHM versions 86 Long Term Support (LTS), 90 and newer.
  • The WordPress 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).

  • You must install the PHP-FPM Service for cPanel Daemons, which must remain enabled to use the WordPress Toolkit.

WHM Marketplace

Note:

You must be root-enabled to access the WHM Marketplace interface (WHM >> Home >> Server Configuration >> WHM Marketplace).

To install the WordPress Toolkit plugin in the WHM Marketplace interface (WHM >> Home >> Server Configuration >> WHM Marketplace), perform the following steps:

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

Manual installation

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

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

Uninstall WordPress Toolkit

To uninstall the WordPress Toolkit plugin on the command line, run the following command as the root user:

rpm -e wp-toolkit-cpanel

Manage account access

To manage account access to the WordPress Toolkit or WordPress Toolkit Deluxe feature, use the following interfaces:

  • WHM’s Feature Manager interface (WHM >> Home >> Packages >> Feature Manager >> Feature Lists) lets you manage the features your feature lists.

    Important:
    • Server administrators must enable the following features to allow users access the WordPress Toolkit interface:

      • WordPress Toolkit
      • MySQL
      • Subdomains
      • MIME Types
      • Cronjobs
      • Directory Privacy
      • Password & Security
      • File Manager
      • Redirects
    • The WordPress Toolkit Deluxe feature requires the WordPress Toolkit and WordPress Toolkit Deluxe features.

  • WHM’s Edit a Package interface (WHM >> Home >> Packages >> Edit a Package) lets you manage the feature list that existing packages use.

  • WHM’s Add a Package interface (WHM >> Home >> Packages >> Add a Package) lets you create a new package with new feature lists. Use this interface if you plan to offer new packages to customers and resellers with these WordPress Toolkit features.

  • WHM’s Modify an Account interface (WHM >> Home >> Account Functions >> Modify an Account) lets you change the package that each account uses.

Note:

We recommend that you create and use a package for the WordPress Toolkit feature and a similar package for the WordPress Toolkit Deluxe feature.

Updates to WordPress Toolkit

Updates to the WordPress Toolkit run nightly.

To check the system’s auto-update status, run the following command:

systemctl status wp-toolkit-scheduled-tasks

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

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 WordPress Toolkit

The log files for the WordPress Toolkit reside in the /usr/local/cpanel/3rdparty/wp-toolkit/var/logs/ directory.

To troubleshoot the WordPress 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 WordPress Toolkit. To do this, add the following line to the /usr/local/cpanel/3rdparty/wp-toolkit/var/etc/config.ini file:

logCommandsAndFileOperations = true
Warning:

We strongly recommend that you only enable enhanced logging when you need to troubleshoot the WordPress Toolkit. Enhanced logging may slow down WordPress Toolkit’s performance significantly.

Additional Documentation