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

 

Introduction

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

Notes:

  • 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.

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.

Icons  

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 icons manually, add the icon's information to the icon's group's  dynamicui_group.conf  file, where  group  represents the group name. For example, add the  Contact Support  icon's information to the  Support  group in the  dynamicui_support.conf  file.

File load order  

Note:

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:

/usr/local/cpanel/base/frontend/theme/dynamicui.conf
/usr/local/cpanel/base/frontend/theme/dynamicui/dynamicui_*.conf
resellerhomedir/cpanelbranding/theme/dynamicui.conf
/usr/local/cpanel/base/frontend/theme/package/dynamicui.conf
resellerhomedir/cpanelbranding/theme/package/dynamicui.conf 

As cPanel loads each dynamicui file, it checks for identical icons or groups. If a subsequent file contains the same icon 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  

To hide an icon or group from the cPanel Home interface, add a skipobj entry to the dynamicui file.

Select the tab for your version of cPanel & WHM to view an example, where item_to_hide represents the name of the icon or group:

{  
   "file":"item_to_hide",
   "skipobj":"1"
},
file=>item_to_hide,skipobj=>1