wp-toolkit: WordPress Toolkit

The wp-toolkit utility allows you to perform certain action on WordPress installations.

Note: This utility is available when the WordPress toolkit extension is installed in Plesk and is used with the plesk ext utility.

Additionally, WP-CLI (official WordPress command-line interface) is integrated into wp-toolkit utility. You can invoke it with the wp-cli command and use it to manage WordPress websites.

Read more about WP-CLI.

Usage
plesk ext wp-toolkit <command> [options]
Example

The following command provides main data for all WordPress installations existing on the server:

plesk ext wp-toolkit --list
Commands
Command Parameter Description Example

--clear-cache

[option]

Clears the cache of the selected WordPress installation.

To clear the cache of the WordPress installation with the ID = 1:

plesk ext wp-toolkit --clear-cache -instance-id 1

--register

[option]

Adds the WordPress installation to WordPress Toolkit.

To add the WordPress installation on the domain with the ID = 1 to WordPress toolkit:

plesk ext wp-toolkit --register -main-domain-id 1 -path httpdocs

--info

[option]

Provides data on the selected WordPress installation.

To provide data on the WordPress installation with the ID = 1:

plesk ext wp-toolkit -info -instance-id 1

--wp-cli

[option]

Executes a wp-cli command on the selected WordPress installation.

To display the WordPress version of the WordPress installation with the ID = 1:

plesk ext wp-toolkit --wp-cli -instance-id 1 -- core version

--list

[option]

Provides main data for all WordPress installations existing on the server.

To provide main data for all WordPress installations existing on the server:

plesk ext wp-toolkit --list

 

--help or -h

[option]

Displays help on the use of this utility.

To view the help info on the use of this utility:

plesk ext wp-toolkit --help

or

plesk ext wp-toolkit -h

Options
Command Parameter Description Example

-instance-id

 

WordPress installation ID.

To activate plugin “hello” on the WordPress installation with the ID = 1:

plesk ext wp-toolkit --wp-cli -instance-id 1 -- plugin activate hello

-main-domain-id

 

Main domain ID.

To provide data on the WordPress installation with the ID = 1:

plesk ext wp-toolkit --info -main-domain-id 1 -path httpdocs

-path

 

The relative path from the main domain's root directory. Example: /httpdocs/subdirectory

To add the WordPress installation on the domain with the ID = 1 to WordPress toolkit:

plesk ext wp-toolkit --register -main-domain-id 1 -path httpdocs

-plugins

 

Adds information about the number of plugins on WordPress installations when the list command is executed.

To display main data (including the number of plugins) on all WordPress installations existing on the server:

plesk ext wp-toolkit --list -plugins

-themes

 

Adds information about the number of plugins on WordPress installations. when the list command is executed.

To display main data (including the number of themes) on all WordPress installations existing on the server:

plesk ext wp-toolkit --list -themes

-format

 

Renders output in a particular format. Supported formats: JSON, raw. By default all data is shown in the raw format.

To display main data on all WordPress installations existing on the server in the JSON format:

plesk ext wp-toolkit --list -format json

 

-domain-id

 

Main domain ID. Deprecated and works for the register command only. Use main-domain-id instead.

 

 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.