Introduction
To uninstall plugins from cPanel & WHM, choose the uninstallation process according to your system's version.
Important:
While you can also uninstall plugins manually, we strongly recommend that you use the uninstall_plugin script.
Uninstall a plugin in 11.50 and later
cPanel & WHM version 11.50 introduced the uninstall_plugin script, which eliminates the need to manually remove plugins. This file passes information to cPanel's dynamicui files when you uninstall your plugin. This method allows the user to uninstall a plugin for the x3 and Paper Lantern themes.
To use this script to uninstall a plugin to cPanel, run the following command:
/usr/local/cpanel/scripts/uninstall_plugin /tmp/plugin_example.tar --theme=theme_name
example.tar represents the compressed plugin installation file, and theme represents the cPanel theme to uninstall from, either x3 or Paper Lantern.
Note:
If you do not specify the --theme option and a theme, the script attempts to uninstall the plugin from the Paper Lantern interface only. If the file does not contain an install.json file, the uninstall will fail.
Manually uninstall a plugin in 11.48 and earlier
In cPanel & WHM version 11.48 and earlier, an uninstall script does not ship with Paper Lantern.
To manually uninstall a plugin, perform the following steps:
- Remove all of the files for the plugin that you want to uninstall.
-
Navigate to the
/usr/local/cpanel/base/frontend/paper_lantern/dynamicui/directory and delete thedynamicui_$name.conffile.Note:
The
$namevariable represents the name of the plugin that you wish to remove. -
Delete the
dynamicui_$group.conffile.Note:
The
$groupvariable represents the name of the group where the plugin resides. - Use the
/usr/local/cpanel/bin/rebuild_sprites --quietscript to rebuild the sprites.