Page tree
Skip to end of metadata
Go to start of metadata

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 cPanel plugin.  

To use this script to uninstall a plugin to cPanel, run the following command:

/usr/local/cpanel/scripts/uninstall_plugin plugin_file --theme=theme_name
In this command, plugin_file represents the plugin installation file (a .tar.gz.bzip, or .zip file, or an uncompressed directory), and theme represents the cPanel theme to uninstall from (paper_lantern or another valid theme on the server).

 

Note:

If you do not specify the --theme option and a theme, the script attempts to uninstall the plugin from the Paper Lantern theme only. If the compressed plugin installation file does not contain an install.json file, the uninstallation 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:

  1. Remove all of the files for the plugin that you want to uninstall.
  2. Navigate to the /usr/local/cpanel/base/frontend/paper_lantern/dynamicui/ directory.

    1. Delete the dynamicui_name.conf file, where name represents the name of the plugin to remove.

    2. Delete the dynamicui_group.conf file, where group represents the name of the group that contains the plugin.

  3. Run the /usr/local/cpanel/bin/rebuild_sprites --quiet script to rebuild the cPanel interface's sprites.