WordPress Toolkit

Valid for versions 86 through 90

Version:

86

92


Last modified: December 18, 2020

Overview

The WordPress Toolkit interface allows you to easily install, configure, and manage WordPress®. WordPress Toolkit is available in both a Lite and Deluxe version. WordPress Toolkit Deluxe requires that you purchase a license. For the most current updates and improvements to the WordPress Toolkit, read the change log for Plesk’s WordPress Toolkit.

How to use WordPress Toolkit

For more information about how to use WordPress Toolkit, read Plesk’s WordPress Toolkit documentation.

Note:

Plesk and cPanel, L.L.C. are working together to bring WordPress Toolkit to cPanel & WHM.

Feature comparison

The following chart shows the differences between WordPress Toolkit Lite, WordPress Toolkit Deluxe, and WordPress Manager.

Feature WordPress Manager WordPress Toolkit Lite 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

Add or modify a license

To use WordPress Toolkit Deluxe, you must first add a WordPress Toolkit license on our Manage2 or cPanel Store site. You can select either of the following licenses:

  • WordPress Toolkit Autoscale — This license is only for partners. Direct customers cannot select this license.

  • WordPress Toolkit Fixed — This license is for partners and direct customers.

Warning:

You must be a partner to add a WordPress Toolkit Deluxe license via the Manage2 site.

Manage2

To add a Wordpress Toolkit license in Manage2, use Manage2’s Add License interface (Dashboard >> Licenses >> Add License).


To upgrade or downgrade a Wordpress Toolkit license in Manage2, use Manage2’s Modify a License interface (Dashboard >> Billing >> Modify a License).


cPanel Store

Warning:
  • You cannot purchase a WordPress Toolkit Deluxe license without an active cPanel license.
  • The cPanel Store sells WordPress Toolkit Deluxe accounts as a set of one, five, 10, or multiples of 10. You may purchase a maximum of 4,000 accounts.
  • A service disruption will occur at the start of the next month if you reduce the account limit below the number of active users.

To add a WordPress Toolkit license in the cPanel Store, perform the following steps:

  1. Navigate to the cPanel Store and click Account Log In to log in to your cPanel Store account.

  2. After you successfully log in, click Add a Product to display the product types. In the menu, select Partner Add Ons. The interface will refresh and display the Select a Product menu.

  3. Under Product Type, select WordPress Toolkit Deluxe from the Select a Product menu. The interface will refresh and display the required WordPress Toolkit Deluxe information.

  4. Under IP Address, enter your server’s IP address in the text box.

  5. Enter the desired number of accounts in the Number of Accounts text box.

  6. Click Review and Checkout. A new interface will appear.

  7. Proceed through the checkout process.


Note:
  • Upgrades occur immediately. The cPanel Store charges you the prorated upgrade cost at the time of the upgrade.
  • Downgrades occur on the first day of the next month. The cPanel Store will charge you the new amount at the time of the next invoice.

To upgrade or downgrade a WordPress Toolkit Deluxe license in the cPanel Store, perform the following steps:

  1. Navigate to the cPanel Store and click Account Log In to log in to your cPanel Store account.

  2. Navigate to the Manage License interface (My Account >> Manage Licenses).

  3. Locate your WordPress Toolkit Deluxe license.

  4. Under Actions, click the icon ( ) to display the menu.

  5. Click View/Modify Account Limit. A window will appear.

  6. Click Yes to modify your account limit.

  7. Enter the desired number of accounts.

  8. Click OK. The interface will automatically add the new license count to the cart.

  9. Navigate to the Cart interface.

  10. Proceed through the checkout process.


Update a license on the server

The /usr/local/cpanel/bin/wpt_license script retrieves the Wordpress Toolkit license information from Manage2 and refreshes the license on the server. This script runs during the nightly cPanel & WHM update (upcp) process.

To immediately retrieve any license changes and refresh the license, perform the following steps as the root user:

  1. To download the license, run the /usr/local/cpanel/bin/wpt_license --download script.

  2. To apply the license, run the /usr/local/cpanel/bin/wp-toolkit --apply-license script.

For more information, read our The wpt_license Script documentation.

Install WordPress Toolkit

Note:
  • WordPress Toolkit is compatible with the following operating systems and cPanel & WHM versions:

    • Operating Systems: CentOS 7, CloudLinux™ 6, and CloudLinux 7 (CloudLinux 8 and CentOS 8 coming soon).
    • cPanel & WHM versions: 86 Long Term Support (LTS), 90 and newer.
  • WordPress Toolkit requires that you set a PHP Memory limit of 128MB or higher. You can set this limit in WHM’s MultiPHP INI Editor interface (WHM >> Home >> Software >> MultiPHP INI Editor).

Installation through Feature Showcase

To install WordPress Toolkit from the WHM’s Feature Showcase interface, perform the following steps:

  1. Click Enable in the Install WordPress Toolkit section of the WHM Feature Showcase interface.
    • The next time root or a root-enabled reseller logs in to the server, WordPress Toolkit will appear in Feature Showcase.
  2. Click Save Settings.

Manual installation

To install WordPress Toolkit manually from 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)

Configure server software

Read WordPress’ Requirements document to see which software versions WordPress requires to run properly.

  • Use WHM’s EasyApache interface (WHM >> Home >> Software >> EasyApache 4) to configure the necessary version of PHP on your server.
  • Use WHM’s MySQL/MariaDB Upgrade interface (WHM >> Home >> SQL Services >> MySQL/MariaDB Upgrade) to configure the necessary version of MySQL on your server.
Important:

WordPress also requires several PHP extensions to function properly and smoothly. You can find a list of these PHP extensions in the PHP Extensions section of WordPress’ Server Environment documentation.

Use the PHP Extensions section of WHM’s EasyApache interface (WHM >> Home >> Software >> EasyApache 4) to enable the necessary PHP Extensions on your server.

Managing account access

Note:

The following Feature Manager items are required to manage WordPress Toolkit Lite and WordPress Toolkit Deluxe.

  • WordPress Toolkit Lite requires WordPress Toolkit.
  • WordPress Toolkit Deluxe requires WordPress Toolkit and WordPress Toolkit Deluxe, as well as a WordPress Toolkit license.

To manage account access to WordPress Toolkit Lite and WordPress Toolkit Deluxe, use the following interfaces to manage features, packages, and accounts:

  • WHM’s Feature Manager interface (WHM >> Home >> Packages >> Feature Manager >> Feature Lists) to manage the features in existing feature lists or create new feature lists.

    Note:

    You must enable the following features for users to run WordPress Toolkit:

    • MySQL
    • Subdomains
    • Mime
    • Cronjobs
    • Directory Privacy
    • Password & Security
    • File Manager

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

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

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

Note:

We recommend creating a package for WordPress Toolkit Lite and a similar package for WordPress Toolkit Deluxe.

Additional Documentation