WordPress Toolkit is a single management interface that enables you to easily install, configure, and manage WordPress. It is available if the WordPress Toolkit extension is installed in Plesk.
Note: WordPress Toolkit can install, configure, and manage WordPress version 3.7 or later.
Note: The WordPress Toolkit extension is free with the Web Pro and the Web Host Plesk editions and is available for a fee for the Web Admin edition.
To install a new WordPress instance, go to WordPress and click Install. The following installation options are available:
Note: Installation of WordPress via the WordPress Toolkit is performed from the wordpress.org site.
The installation path of the installed WordPress site has the https prefix by default.
To view a list of all installations attached to the WordPress Toolkit, go to Websites & Domains > WordPress.
All WordPress installations added using the WordPress Toolkit or through the Applications page appear in the WordPress Toolkit automatically; those installed manually need to be attached to the WordPress Toolkit. If you have upgraded from an earlier version of Plesk and you used WordPress, we recommend that you attach all existing WordPress installations to the WordPress Toolkit. To attach WordPress installations to the WordPress Toolkit, go to Websites & Domains > WordPress and click Scan. Note that if you install new copies of WordPress manually after the scan, these WordPress installations will not be attached to the WordPress Toolkit.
To detach a WordPress installation from the WordPress Toolkit, go to Websites & Domains > WordPress, click the WordPress installation name, and then click Detach. Note that a detached WordPress installation will be attached to the WordPress Toolkit again after you perform a new scan for WordPress installations.
You can completely remove any installation, no matter how it was installed: using the WordPress Toolkit, through the Applications page, or manually. To remove a WordPress installation from the WordPress Toolkit, go to Websites & Domains > WordPress, click the WordPress installation name, and then click Remove.
You can use the "Web Site Migration" feature to migrate WordPress websites owned by you but hosted elsewhere to Plesk. When you migrate a WordPress website, Plesk copies all its files and the database to your server. Once a website has been migrated, you can manage it using WordPress Toolkit.
To migrate an existing WordPress website, go to Websites & Domains > WordPress, click Import, and then follow the instructions here.
To install a new WordPress instance, go to WordPress and click Install. The following installation options are available:
Note: To install WordPress, WordPress Toolkit retrieves data from wordpress.org
. By default, if WordPress Toolkit cannot establish connection in 15 seconds, wordpress.org
is considered to be unavailable. If you experience connectivity issues (for example, due to the poor quality of the Internet connection), consider increasing the timeout value. To do so, go to WordPress, go to the "Global Settings" tab, specify the desired value in the “HTTP timeout for retrieving data from wordpress.org (in seconds)” field, and then click OK.
The installation path of the installed WordPress site has the https prefix by default.
To view a list of all installations attached to the WordPress Toolkit, go to Websites & Domains > WordPress.
All WordPress installations added using the WordPress Toolkit or through the Applications page appear in the WordPress Toolkit automatically; those installed manually need to be attached to the WordPress Toolkit. If you have upgraded from an earlier version of Plesk and you used WordPress, we recommend that you attach all existing WordPress installations to the WordPress Toolkit. To attach WordPress installations to the WordPress Toolkit, go to Websites & Domains > WordPress and click Scan. Note that if you install new copies of WordPress manually after the scan, these WordPress installations will not be attached to the WordPress Toolkit.
To detach a WordPress installation from the WordPress Toolkit, go to Websites & Domains > WordPress, click the WordPress installation name, and then click Detach. Note that a detached WordPress installation will be attached to the WordPress Toolkit again after you perform a new scan for WordPress installations.
You can completely remove any installation, no matter how it was installed: using the WordPress Toolkit, through the Applications page, or manually. To remove a WordPress installation from the WordPress Toolkit, go to Websites & Domains > WordPress, click the WordPress installation name, and then click Remove.
You can use the "Web Site Migration" feature to migrate WordPress websites owned by you but hosted elsewhere to Plesk. When you migrate a WordPress website, Plesk copies all its files and the database to your server. Once a website has been migrated, you can manage it using WordPress Toolkit.
To migrate an existing WordPress website, go to Websites & Domains > WordPress, click Import, and then follow the instructions here.
With Plesk WordPress Toolkit, you can have WordPress preinstalled on newly created domains. You can have predefined lists of plugins and themes installed on those domains. In addition, you can give your customers the ability to enable Smart Updates.
For every hosting plan, you can choose among the following options:
If you choose any of the last three options, WordPress will be automatically installed on the first domain of every subscription based on the hosting plan (main domain).
To preinstall WordPress on newly created domains:
Now every time you create a new subscription based on this hosting plan, WordPress will be installed automatically on that subscription's main domain. Existing subscriptions based on this hosting plan will not be affected.
A set is a predefined list of WordPress plugins and themes. When you configure a hosting plan to enable the preinstallation of WordPress, you can also choose to add a single set. If you do, all plugins and themes included in the set are installed together with WordPress. WordPress Toolkit comes with two preconfigured sets, and you can always create more.
By default, every set you create becomes available to customers. Customers can see which plugins and themes are included in a set, and they can select a set to install together with WordPress when performing a custom installation. If you do not want customers to install sets on their WordPress instances, go to WordPress > the "Global Settings" tab, and clear the “Allow customers to use sets when they install WordPress” checkbox.
To create a set:
Now you can select the set as a preinstallation option in the hosting plan.
To add plugins and themes to a set:
Adding plugins and themes to a set does not affect existing subscriptions to which this set has been applied.
To remove the selected plugins and themes from a set:
2 total
) to show the list of plugins or themes currently included in the set.To remove all plugins and themes from a set:
Removing plugins and themes from a set does not affect existing subscriptions to which this set has been applied.
To rename a set:
To remove a set:
Removing a set does not affect existing subscriptions to which this set has been applied. For all hosting plans that used the removed set, WordPress preinstall settings are reset (on the “Additional Services” tab, “WordPress Toolkit” is set to "None").
Go to WordPress to see all WordPress instances hosted on the server.
WordPress Toolkit groups information about each instance in blocks we call cards.
A card shows a screenshot of your website and features a number of controls that give you easy access to frequently used tools. The screenshot changes in real time to reflect the changes you make to your website. For example, if you switch the maintenance mode on or change the WordPress theme, the screenshot of the website will change immediately.
Note: Changes you make directly in WordPress are synchronized with WordPress Toolkit once every 24 hours. To sync manually, click the button.
When you move the mouse cursor over the screenshot of the website, the Open Site button appears. Click the button to open the website in a new browser tab.
WordPress websites are frequently targeted by hackers. WordPress Toolkit analyzes how safe your instance is by checking the following security aspects and showing the result below the screenshot of the website:
If you see “warning” or “danger” next to one of these aspects, click “View” and fix it.
In the “General Info” section, you see the WordPress website’s title and its WordPress version. Here you can:
In the “Tools” section, click to access the following WordPress Toolkit features:
The controls below give you easy access to the following settings and tools:
On the remaining three tabs you can manage the instance’s plugins, themes, and change the database username and password.
You can choose the way WordPress Toolkit shows cards. The default “Cards” view is best suited for a small number of instances. If you have a large number of instances, collapse cards , or switch to the “Tiles” or “List” view.
You can also Sort and Filter instances to manage them more easily.
You can detach WordPress instances that you do not want to see and manage in WordPress Toolkit. Detaching does not remove the instance, merely hides it from WordPress Toolkit. A detached instance will be attached to WordPress Toolkit again after you scan for WordPress instances. To detach a WordPress instance, go to WordPress, choose the instance you want to detach, click the button, and then click Detach.
Unlike detaching, removing completely deletes a WordPress instance. To remove a WordPress instance, go to WordPress, choose the instance you want to delete, click the button, and then click Remove.
By default, a newly created WordPress Toolkit website is shown in search results of search engines. If your website is not yet ready for public viewing, switch off Search engine indexing.
If you are installing WordPress for testing or development, you can enable Debugging to automatically find and fix errors in the website code. To do so, click "Setup" next to “Debugging”, select the WordPress debugging tools you want to activate, and then click OK.
To keep your website secure, you need to regularly update the WordPress core, as well as any installed plugins and themes. You can do this either automatically or manually:
For security reasons, we recommend that you configure automatic updates.
To update a WordPress instance manually:
Note: If an update of a WordPress core is available, you will see the “Restore Point” checkbox. Keep this checkbox selected to create a restore point you can use to roll back the update if something goes wrong.
The selected updates will be applied.
To configure automatic updates for a WordPress instance:
If you are concerned that WordPress automatic updates may break your website, use Smart Updates. With Smart Updates, WordPress instances are always updated safely without breaking your website.
Smart Updates is a premium feature available in WordPress Toolkit 3.x and later. It helps you keep your production websites up-to-date without the risk of breaking your website. Smart Updates analyses the potential consequences of installing updates and advises you whether doing so is safe.
To keep your websites secure, you need to regularly update WordPress: themes, plugins, and core. However, these updates can potentially break you websites. Manual updates require your attention and cannot guarantee that your websites will continue working.
To ensure a WordPress instance is always updated safely without breaking your website, we developed the Smart Updates feature, which does the following:
Smart Updates is a paid feature, which you buy on a per instance basis. You can use Smart Updates with both manual and automatic updates.
To enable Smart Update:
You have enabled Smart Update. Now you can use it with manual or automatic updates.
Note: Smart Update is not an alternative for backups. We recommend that you regularly backup your WordPress instances especially if you use automatic updates.
To use Smart Update manually:
If you do not want to update the production instance, click Discard.
To use Smart Update automatically:
A WordPress plugin is a type of third-party software that adds new functionality to WordPress. With WordPress Toolkit, you can install and manage plugins on one or more WordPress instances.
In WordPress Toolkit, you can install plugins on one or more WordPress instances.
You can search for and install plugins found in the wordpress.org plugins repository. You can also upload custom plugins, which is useful if:
Note that any plugins you upload become available for installation by customers.
To install plugins on a particular WordPress instance:
To install plugins on multiple WordPress instances:
Note: Selecting one or more plugins and then performing a new search without installing the selected plugins resets the selection.
To upload a plugin:
At this point, the uploaded plugin has become available for installation by customers. You can also install the uploaded plugin on your own WordPress instances.
To install an uploaded plugin:
You can remove plugins from a particular instance or from all instances hosted on the server.
To remove plugins from a particular instance:
To remove plugins from all instances hosted on the server:
You can activate or deactivate plugins installed on a particular instance or on all instances hosted on the server.
To activate or deactivate plugins for a particular instance:
To activate or deactivate plugins for all instances hosted on the server:
If a plugin needs updating, you will see “Updates” next to the plugin on the “Plugins” tab of an instance card.
You can do the following:
To update plugins on multiple instances:
Note: Before updating the plugin, WordPress Toolkit prompts you to back up your subscription. If you are concerned that the update may break your website, create a backup or use Smart Updates.
A WordPress theme determines the overall design of your website including colors, fonts, and layout. By selecting a different theme, you change the look and feel of your website without changing the content. With WordPress Toolkit, you can install and manage themes.
In WordPress Toolkit, you can install themes on one or all WordPress instances of the subscription. You can:
To install themes on a particular WordPress instance:
To install themes on all WordPress instances of the subscription:
Note: Selecting one or more themes and then performing a new search without installing the selected themes resets the selection.
To install themes uploaded by the Plesk administrator:
To upload a theme:
To install an uploaded theme:
You can activate a theme installed on a particular instance or on all instances hosted on the server. A WordPress instance can have only one active theme at a time.
To activate a theme for a particular instance:
To activate a theme for all instances hosted on the server:
You can remove themes from a particular instance or from all instances belonging to a subscription. Note that you cannot remove an active theme. Before removing a currently active theme, activate another theme first.
To remove themes from a particular instance:
To remove themes from all instances of the subscription:
If a theme needs updating, you will see “Updates” next to the theme on the “Themes” tab of an instance card. You can do the following:
To update themes on multiple instances:
Note: Before updating the theme, WordPress Toolkit will prompt you to back up your subscription. If you are concerned that the update may break your website, create a backup or use Smart Updates.
WordPress Toolkit can enhance the security of WordPress instances (for example, by turning off XML-RPC pingbacks, checking the security of the wp-content
folder, and so on). You can see an instance’s security status on its card, below the screenshot of the website. If you see “warning” or “danger” next to “Security status”, we recommend that you secure your instance.
We call individual improvements you can make to an instance’s security “measures”. We consider certain measures to be critical. For that reason, WordPress Toolkit applies them automatically to all newly created instances.
Caution: Some security measures, once applied, can be rolled back. Some cannot. We recommend that you back up the corresponding subscription before securing a WordPress instance.
To secure a WordPress instance:
All selected measures will be applied.
In rare cases, applying security measures can break your website. In this case, you can roll back the security measures you have applied.
To roll back applied security measures:
The applied security measures will be rolled back.
Cloning a WordPress site involves creation of a full website copy with all website files, the database, and settings.
You may want to clone your WordPress site in one of the following situations:
Clone a WordPress site:
Select one of the available options:
Note: You can change the default subdomain prefix. To do so, go to WordPress, go to the "Global Settings" tab, specify the desired prefix in the “Default subdomain prefix for cloning” text field, and then click OK.
Note: Make sure that the domain or subdomain selected as the destination is not being used by an existing website. During cloning, website data existing on the destination may be overwritten and irrevocably lost.
When the cloning is finished, the new clone will be displayed in the list of WordPress installations.
You can synchronize the content of your WordPress site including files and database with another WordPress site.
Let us say you maintain a non-public (staging) version of a WordPress site on a separate domain or subdomain and a publicly available (production) version of this site on a production domain. You may want to synchronize your WordPress sites in the following situations:
When performing the sync, keep in mind the following:
Caution: During synchronization, files and database tables copied from the source overwrite those present on the destination. Any changes made to the files and database tables on the destination prior to synchronization will be discarded and lost without warning.
Note: If you have caching plugins installed on a WordPress website you want to synchronize with, clear the cache on the source website before sync. Otherwise, the destination website might work incorrectly.
To synchronize a WordPress site data with another site:
htaccess
, web.config
, and wp-config.php
are not synchronized, as modifying these files may disrupt the operation of WordPress. You can have WordPress Toolkit synchronize the wp-config.php
file by selecting the "Synchronize wp-config.php" checkbox. To make the checkbox visible, go to WordPress, go to the "Global Settings" tab, select the "Allow to copy wp-config.php during file synchronization" checkbox, and then click OK.Note: Even if you choose to synchronize the wp-config.php
file, the information related to the database will not be synchronized. This prevents the target WordPress instance from corruption. Custom settings specified in the wp-config.php
file on the target instance will be overwritten with those from the source instance.
You can hide these options, making them unavailable to yourself and your customers. To do so, go to WordPress
, go to the "Global Settings" tab, clear the "Use rsync for file synchronization operations" checkbox, and then click OK.
Caution: Every WordPress instance can only have a single restore point. Creating a restore point overwrites the existing restore point, if any.
The synchronization of WordPress instances has started.
When the synchronization is finished, you will see a page displaying the settings of the source WordPress instance. On the page, you can see the last time synchronization was performed. You can click the “Visit the target instance.” link to see the target instance page opened in a new tab.
When you choose to synchronize databases (that is, you have selected either the Database Only or the Files and Database option), you need to specify which database tables you want to synchronize:
_postmeta
, _posts
, _username
, and _users
suffixes, by clicking the corresponding link.
When you update or synchronize a WordPress instance, WordPress Toolkit suggests creating a restore point before beginning the operation. If you are not happy with the results, you can use the restore point to roll back the changes and restore your instance to the state it was in before the operation.
By default, a restore point contains only the data that will be affected when synchronizing or updating. You can have WordPress include all the target instance data, both files and the database, in the restore point. To do so, go to WordPress, go to the "Global Settings" tab, select the "Always make full instance snapshots" checkbox, and then click OK. Full restore points provide the maximum chances of successful recovery, but take longer to create and take up more disk space than regular restore points.
To restore a WordPress instance from a restore point:
The restoration will begin. Your instance will be restored to the state it was in before the operation.
The restore point takes up disk space which is included in your allowed disk space quota. After you have restored your WordPress instance, or once you have determined that all is good and there is no need to restore, you can remove the restore point by clicking Remove the Restore Point.
Caution: Every WordPress instance can only have a single restore point. Creating a restore point overwrites the existing restore point, if any.
It is important to note that a restore point is not the same as a backup. Making any changes to the target instance after you synchronize or update it may make restoring from the restore point impossible. If you are synchronizing or updating a live production WordPress instance, consider backing up your subscription beforehand in addition to creating a restore point.
Note: WordPress Toolkit suggests creating a restore point only when you update a single WordPress instance. You can do this by clicking the Update to button from WordPress, the “Installations” tab
or from the WordPress instance page.
You can set a password to protect access to your WordPress website. Anyone visiting a password-protected website must enter the valid username and password to view the website content.
Password protection is useful in the following cases:
To protect a WordPress website with a password:
To disable “Password protection”, switch it off.
When a WordPress website enters maintenance mode, the website's content is hidden from visitors without being changed or otherwise affected. Visitors accessing your website when it is in maintenance mode see a maintenance screen webpage instead of the website content.
Your WordPress website enters maintenance mode automatically when you are:
If you are making changes to your website and want to temporarily hide it from visitors, you can manually put it into maintenance mode.
To put a WordPress website into maintenance mode:
To take your website out of maintenance mode, switch off “Maintenance mode”.
With WordPress Toolkit, you can change certain attributes of the maintenance page to make it more informative. For example you can:
To customize the maintenance page:
Note: The timer is only meant to inform visitors about the estimated duration of the remaining downtime. Your website is not taken out of maintenance when the countdown is finished; you must do that manually.
If you have coding skills, you can customize the maintenance page beyond the options described above. You can do this for a particular WordPress website or for all WordPress websites hosted on the server.
To customize the maintenance page for a particular website:
To customize the maintenance page for all WordPress websites hosted on the server:
(Plesk for Linux) /usr/local/psa/var/modules/wp-toolkit/maintenance/template.phtml
(Plesk for Windows) %plesk_dir%\var\modules\wp-toolkit\maintenance\template.phtml
The customized server-wide maintenance page template is applied only to WordPress websites that had never been put in maintenance mode before. To apply it to a WordPress website that had already been put in maintenance mode, do the following:
This replaces the website-specific maintenance page with a copy of the server-wide template.
If necessary, you can restore the default maintenance page. You do it differently depending on whether you have customized the server-wide template or not.
To restore the default maintenance page if the server-wide template has not been changed:
To restore the default maintenance page if the server-wide template has been changed:
(Plesk for Linux) /usr/local/psa/admin/plib/modules/wp-toolkit/resources/maintenance/template.phtml
(Plesk for Windows) %plesk_dir%\admin\plib\modules\wp-toolkit\resources\maintenance\template.phtml
with the following file:
(Plesk for Linux) usr/local/psa/var/modules/wp-toolkit/maintenance/template.phtml
(Plesk for Windows) %plesk_dir%\var\modules\wp-toolkit\maintenance\template.phtml
The default server-wide maintenance page template is applied only to WordPress websites that had never been put in maintenance mode before. To apply it to a WordPress website that had already been put in maintenance mode, do the following:
This replaces the website-specific maintenance page with a copy of the default server-wide template.
WP-CLI is the official WordPress command-line interface for managing WordPress sites. More information can be found here .
You can access WP-CLI directly from the Plesk command-line interface using the wp-toolkit
utility with no need to install WP-CLI on the server.
Read more about the wp-toolkit
utility.
To call a WP-CLI command via the Plesk command-line interface:
Connect to your Plesk server via SSH (on Linux) or via RDP (on Windows) and, in the command line, run the command:
plesk ext wp-toolkit --wp-cli -instance-id [ID] [command] [options]
where:
[ID]
is the ID of the WordPress installation in Plesk. To learn the ID, go to WordPress and click the name of the WordPress installation. The ID will be displayed at the end of the URL in the browser. For example, if the URL ends with /id/2
, then the ID=2.[command]
is a WP-CLI command prefixed by --
(for example, -- core
).[options]
is the list of the WP-CLI command's options.The full list of WP-CLI commands and their options can be found here .
To get the main WordPress information (a blog name, a web site URL, a version, an update version, plugins, and themes):
plesk ext wp-toolkit --wp-cli -instance-id 4 -- core info
To get help for the core
command:
plesk ext wp-toolkit --wp-cli -instance-id 4 -- help core
To install and activate the latest version of the bbPress plugin from wordpress.org:
plesk ext wp-toolkit --wp-cli -instance-id 4 -- plugin install bbpress --activate
Note: To make the changes performed by running a WP-CLI command visible in the Plesk user interface, go to WordPress, click the name of the WordPress installation, and then click Refresh.