wp_instance: WordPress Toolkit
The wp_instance
utility is used to manage WordPress installations through CLI. By using this utility, you can perform the following tasks:
- activating, deactivating, installing, uninstalling, and updating plugins
- activating, installing, uninstalling, and updating themes
- setting up autoupdates, checking if updates are available, and updating WordPress installations
- viewing the list of WordPress installations
- searching plugins and themes by name
- viewing the list of plugins and themes installed on a WordPress installation
Usage
wp_instance <command>
Example
The following command activates the plugin with the ID 123 on the WordPress installation with the ID mycms.
plesk bin wp_instance --activate-plugin mycms -plugin-id 123
Commands
Command | Parameter | Description | Example |
---|---|---|---|
|
|
Activates the plugin specified by the option on the WordPress installation. Requires the |
To activate the plugin with the ID 123 on the WordPress installation with the ID mycms: plesk bin wp_instance --activate-plugin mycms -plugin-id 123 |
|
|
Deactivates the plugin specified by the option on the WordPress installation. Requires the |
To deactivate the plugin with the ID 123 on the WordPress installation with the ID mycms: plesk bin wp_instance --deactivate-plugin mycms -plugin-id 123 |
|
|
Uninstalls the plugin specified by the option on the WordPress installation. Requires the |
To uninstall the plugin with the ID 123 from the WordPress installation with the ID mycms: plesk bin wp_instance --uninstall-plugin mycms -plugin-id 123 |
|
|
Updates the plugin specified by the option on the WordPress installation. Requires the |
To update the plugin with the ID 123 on the WordPress installation with the ID mycms: plesk bin wp_instance --update-plugin mycms -plugin-id 123 |
|
|
Installs the plugin specified by the option on the WordPress installation. Requires the |
To install the plugin with the ID 123 on the WordPress installation with the ID mycms: plesk bin wp_instance --activate-plugin mycms -plugin-id 123 |
|
|
Activates the theme specified by the option on the WordPress installation. Requires the |
To activate the theme with the ID 123 on the WordPress installation with the ID mycms: plesk bin wp_instance --activate-theme mycms -theme-id 123 |
|
|
Uninstalls the theme specified by the option on the WordPress installation. Requires the |
To uninstall the theme with the ID 123 from the WordPress installation with the ID mycms: plesk bin wp_instance --uninstall-theme mycms -theme-id 123 |
|
|
Updates the theme specified by the option on the WordPress installation. Requires the |
To update the theme with the ID 123 on the WordPress installation with the ID mycms: plesk bin wp_instance --update-theme mycms -theme-id 123 |
|
|
Installs the theme specified by the option on the WordPress installation. Requires the |
To install the theme with the ID 123 on the WordPress installation with the ID mycms: plesk bin wp_instance --activate-theme mycms -theme-id 123 |
|
|
Switches on auto-updates on the WordPress installation. |
To switch on auto-updates on the WordPress installation with the ID mycms: plesk bin wp_instance --enable-auto-updates mycms |
|
|
Switches off auto-updates on the WordPress installation. |
To switch off auto-updates on the WordPress installation with the ID mycms: plesk bin wp_instance --disable-auto-updates mycms |
|
|
Updates the WordPress installation. |
To update the WordPress installation with the ID mycms: plesk bin wp_instance --update-core mycms |
|
|
Removes the WordPress installation. |
To remove the WordPress installation with the ID mycms: plesk bin wp_instance --remove-instance mycms |
|
|
Refreshes settings of the WordPress installation in WordPress toolkit after the settings were changed through WordPress. |
To refresh the settings of the WordPress installation with the ID mycms in WordPress toolkit after the settings were changed through WordPress: plesk bin wp_instance --clear-cache mycms |
|
|
Shows the list of WordPress installations. |
To view the list of WordPress installations: plesk bin wp_instance --get-list |
|
|
Shows names of plugins containing the specified symbols without versions. |
To search plugins containing the symbols example in their name: plesk bin wp_instance --search-plugins example |
|
|
Shows names of themes containing the specified symbols without versions. |
To search themes containing the symbols example in their name: plesk bin wp_instance --search-themes example |
|
|
Shows names and versions of plugins installed on the WordPress installation. |
To view the list of plugins installed on the WordPress installation with the ID mycms: plesk bin wp_instance --get-plugin-list mycms |
|
|
Shows names and versions of themes installed on the WordPress installation. |
To view the list of themes installed on the WordPress installation with the ID mycms: plesk bin wp_instance --get-theme-list mycms |
|
|
Returns the result of the last security check run on the WordPress installation. |
To return the result of the last security check run on the WordPress installation with the ID mycms: plesk bin wp_instance --get-security-status mycms |
Options
Option | Parameter | Description | Example |
---|---|---|---|
|
|
Specifies ID of a plugin. Required for For the |
To activate the plugin with the ID 123 on the WordPress installation with the ID mycms: plesk bin wp_instance --activate-plugin mycms -plugin-id 123 |
|
|
Specifies ID of a theme. Required for For the |
To activate the theme with the ID 123 on the WordPress installation with the ID mycms: plesk bin wp_instance --activate-theme mycms -plugin-id 123 |