# WordPress® Toolkit

https://hostcarts.qa/knowledgebase/article/wordpress-toolkit

## Overview

The *WordPress Toolkit* feature allows you to easily install, configure, and manage WordPress®. This feature is available in both a *Lite* and *Deluxe* version. The *WordPress Toolkit Lite* version installs by default, while the *WordPress Toolkit Deluxe* version requires that you [purchase a license](https://docs.cpanel.net/knowledge-base/cpanel-developed-plugins/wordpress-toolkit/#add-or-modify-a-wordpress-toolkit-license).

After you install the *WordPress Toolkit* plugin, you can access this feature in WHM’s [*WordPress Toolkit*](https://docs.cpanel.net/whm/plugins/wordpress-toolkit-for-whm) interface (*WHM >> Home >> Plugins >> WordPress Toolkit*). If enabled, cPanel users can access this feature in cPanel’s [*WordPress Toolkit*](https://docs.cpanel.net/cpanel/applications/wordpress-toolkit-for-cpanel) 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](https://docs.plesk.com/release-notes/obsidian/change-log/) documentation.

## Feature comparison

The following table shows the differences between the *WordPress Toolkit Lite* and *WordPress Toolkit Deluxe* version features:

| Feature | 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* |  |  |

## Server software requirements

For information about software versions WordPress requires to run properly, read [WordPress’ Requirements](https://wordpress.org/about/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*](https://docs.cpanel.net/whm/sql-services/mysql-or-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*](https://docs.cpanel.net/whm/software/easyapache-4-interface/) interface (*WHM >> Home >> Software >> EasyApache 4*).
- To enable any required WordPress PHP extensions, use the [*PHP Extensions*](https://docs.cpanel.net/ea4/php/php-options/#php-extensions) section of WHM’s [*EasyApache 4*](https://docs.cpanel.net/whm/software/easyapache-4-interface/) interface (*WHM >> Home >> Software >> EasyApache 4*). For a list of these PHP extensions in [WordPress’ Server Environment](https://make.wordpress.org/hosting/handbook/handbook/server-environment/#php-extensions) documentation.

## Install WordPress Toolkit

Important:

- When you upgrade a server to cPanel & WHM version 92, [the nightly cPanel & WHM update process](https://docs.cpanel.net/whm/scripts/the-upcp-script/) detects whether *WordPress Manager* is installed on the server. If *WordPress Manager* is installed, the update process will install *WordPress Toolkit*.
- 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 8 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*](https://docs.cpanel.net/whm/software/multiphp-ini-editor) interface (*WHM >> Home >> Software >> MultiPHP INI Editor*).

### Feature Showcase

When a `root` user or a `root`-enabled reseller logs in to the server, the *WordPress Toolkit* plugin will appear in the *Feature Showcase*. To install the *WordPress Toolkit* plugin via the *Feature Showcase*, perform the following steps:

1. Click *Enable* in the *Install WordPress Toolkit* section of the WHM *Feature Showcase* interface.
2. Click *Save Settings*.

### WHM Marketplace

Note:

You **must** be `root`-enabled to access the [*WHM Marketplace*](https://docs.cpanel.net/whm/server-configuration/whm-marketplace) interface (*WHM >> Home >> Server Configuration >> WHM Marketplace*).

To install the *WordPress Toolkit* plugin in the [*WHM Marketplace*](https://docs.cpanel.net/whm/server-configuration/whm-marketplace) interface (*WHM >> Home >> Server Configuration >> WHM Marketplace*), perform the following steps:

1. Navigate to the [*WHM Marketplace*](https://docs.cpanel.net/whm/server-configuration/whm-marketplace) interface (*WHM >> Home >> Server Configuration >> WHM Marketplace*).
2. Locate the *WordPress Toolkit* listing under *Manage Your Extensions* and click *Install*.

### Manual installation

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

```bash
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:

```bash
rpm -e wp-toolkit-cpanel
```

## Add or modify a WordPress Toolkit license

To use the *WordPress Toolkit Deluxe* feature, you **must** purchase a *WordPress Toolkit* license in [Manage2](https://docs.cpanel.net/manage2) or the [cPanel Store](https://store.cpanel.net). You can select from the following licenses:

- *WordPress Toolkit Autoscale* — This license is **only** for partners in [Manage2](https://docs.cpanel.net/knowledge-base/cpanel-developed-plugins/wordpress-toolkit/#manage2). Direct customers **cannot** purchase this license.
- *WordPress Toolkit Fixed* — This license is available for partners and direct customers in the [cPanel Store](https://docs.cpanel.net/knowledge-base/cpanel-developed-plugins/wordpress-toolkit/#cpanel-store).

### Manage2

You can manage your *WordPress Toolkit* license via the [*Manage2*](https://docs.cpanel.net/manage2/admin/the-manage2-dashboard/) dashboard.

- To add a *Wordpress Toolkit* license, use Manage2’s [*Add License*](https://docs.cpanel.net/manage2/licenses/add-license/) interface (*Manage2 >> Dashboard >> Licenses >> Add License*).
- To modify a *Wordpress Toolkit* license, use Manage2’s *Modify a License* interface (*Manage2 >> Dashboard >> Billing >> Modify a License*).

### cPanel Store

Warning:

- You **must** have an active cPanel license to purchase a *WordPress Toolkit Deluxe* 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 purchase a *WordPress Toolkit* license in the cPanel Store, perform the following steps:

1. Navigate to the [cPanel Store](https://store.cpanel.net/cart/) and click *Account Log In* to log in to your cPanel Store account.
2. Click *Add a Product* to display the available product types.
3. In the menu, select *Partner Add Ons*. The interface will refresh and display the *Select a Product* menu.
4. 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.
5. Under *IP Address*, enter your server’s IP address in the text box.
6. Enter the desired number of accounts in the *Number of Accounts* text box.
7. Click *Review and Checkout*. A new interface will appear.
8. Proceed through the checkout process.

Modify a license

Important:

- License upgrades occur immediately. The cPanel Store charges you the prorated upgrade cost at the time of the upgrade.
- License 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 modify a *WordPress Toolkit Deluxe* license in the cPanel Store, perform the following steps:

1. Navigate to the [cPanel Store](https://store.cpanel.net/cart/) and click *Account Log In* to log in to your cPanel Store account.
2. Navigate to the [*Manage License*](https://store.cpanel.net/my/licenses) interface (*My Account >> Manage Licenses*).
3. Locate your *WordPress Toolkit Deluxe* license.
4. Under *Actions*, click the arrow icon () to display the menu.
5. Click *View/Modify Account Limit*. A new 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*](https://store.cpanel.net/cart/) interface.
10. Proceed through the checkout process.

## Update a license on the server

After you add or make changes to a *WordPress Toolkit* license, the system runs the [`/usr/local/cpanel/bin/wpt_license`](https://docs.cpanel.net/whm/scripts/the-wpt_license-script/) script. This script immediately retrieves and refreshes the license to apply those changes.

If the script does **not** apply the license changes, run the following script as the `root` user:

```bash
/usr/local/cpanel/scripts/wpt_license --update
```

## Manage account access

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

- WHM’s [*Feature Manager*](https://docs.cpanel.net/whm/packages/feature-manager/#selectable-features) 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* The *WordPress Toolkit Deluxe* feature requires the *WordPress Toolkit* and *WordPress Toolkit Deluxe* features, as well as a valid *WordPress Toolkit* license.
- WHM’s [*Edit a Package*](https://docs.cpanel.net/whm/packages/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*](https://docs.cpanel.net/whm/packages/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*](https://docs.cpanel.net/whm/account-functions/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 Lite* feature and a similar package for the *WordPress Toolkit Deluxe* feature.

## Configure WordPress Toolkit Deluxe purchases

Some *WordPress Toolkit* interface features require the *WordPress Toolkit Deluxe* feature. Partners and server administrators can set custom URLs from which resellers and cPanel users can purchase an upgrade to the *WordPress Toolkit Deluxe* feature.

- Partners can set custom URLs in the *Sales Options* section of Manage2’s [*Update Company Information*](https://docs.cpanel.net/manage2/company/update-company-information/) interface (*Dashboard >> Company >> Update Company Information*). Note: This custom URL sets the *WordPress Toolkit Deluxe* purchase URL for **all** the servers in Manage2’s [*Update Company Information*](https://docs.cpanel.net/manage2/company/update-company-information/) interface (*Dashboard >> Company >> Update Company Information*)
- Server administrators can set custom URLs in the *Settings* section of WHM’s [*WordPress Toolkit*](https://docs.cpanel.net/whm/plugins/wordpress-toolkit-for-whm/#configure-wordpress-toolkit-deluxe-upgrade-purchase-urls) interface (*WHM >> Home >> Plugins >> WordPress Toolkit*).

## Updates to WordPress Toolkit

Updates to the *WordPress Toolkit* run nightly.

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

```bash
systemctl status wp-toolkit-scheduled-tasks
```

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

```bash
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:

```bash
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:

```bash
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.