Development Guides Home >> Guide to cPanel Plugins in the Paper Lantern Theme

Guide to cPanel Plugins - The dynamicui Files


cPanel's Home interface uses the dynamicui file system to display features and groups. This system controls the items that display in the cPanel interface. You can add custom plugin features and groups to these files.


In cPanel & WHM version 54, we updated the dynamicui file system to use JSON. We previously offered a cPanel plugin registration file generator. This generator is now deprecated.

Installation methods

The cPanel interface's theme determines the best method for you to use to add items to the dynamicui file system.

  • For Paper Lantern theme plugins, we recommend that you use the install.json file method with the install_plugin script to automatically add icons and groups.


Groups are subsections of the cPanel Home interface that display sets of icons.


The Files group in the Paper Lantern theme

When you add or modify groups manually, add the group's information to the dynamicui_group.conf file, where group represents the group name. For example, add the Support group's information to the dynamicui_support.conf file.


In each group, individual icons and associated text serve as links. These links can point to cPanel interfaces or to other locations.

When you add or edit features manually, add the feature's information to the group's dynamicui_group.conf file, where group represents the group name. For example, add the Contact Support feature's information to the Support group in the dynamicui_support.conf file.

File load order


In the file paths below, resellerhomedir represents the reseller account's home directory, theme represents the cPanel theme (for example, paper_lantern), and package represents the name of the current branding package.

cPanel loads dynamicui files in the following order:

  1. /usr/local/cpanel/base/frontend/theme/dynamicui.conf
  2. /usr/local/cpanel/base/frontend/theme/dynamicui/dynamicui_*.conf
  3. resellerhomedir/cpanelbranding/theme/dynamicui.conf
  4. /usr/local/cpanel/base/frontend/theme/package/dynamicui.conf
  5. resellerhomedir/cpanelbranding/theme/package/dynamicui.conf

As cPanel loads each dynamicui file, it checks for identical features or groups. If a subsequent file contains the same feature or group as a previous dynamicui file, it will overwrite the previous file's information with the new file's settings for that item.

Hide an icon


We strongly recommend that you do not edit the dynamicui.conf file directly. Instead, create a dynamicui_*.conf include file. When you upgrade cPanel & WHM, you will lose all customizations to the dynamicui.conf file.

To hide an icon or group from the cPanel Home interface, add a skipobj entry to the dynamicui include file. In the following example, item_to_hide represents the icon or group you wish to hide: