Introduction
cPanel's Home interface uses the dynamicui file system to display icons and groups. This system controls the items that display in both the x3 and Paper Lantern themes. You can add custom plugin icons and groups to these files.
Notes:
- In cPanel & WHM version 54, we updated the
dynamicuifile 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 x3 theme plugins, you must create your own
dynamicuientries and files manually. - For Paper Lantern theme plugins, we recommend that you use the
install.jsonfile method with theinstall_pluginscript to automatically add icons and groups.
Groups
Groups are subsections of the cPanel Home interface that display sets of icons.
The Files group in the x3 theme
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 is 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.
The File Manager icon in the x3 theme
The File Manager icon in the Paper Lantern theme
When you add or edit icons manually, add the icon's information to the icon's group's dynamicui_group.conf file, where group is 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 (x3 or paper_lantern), and package represents the name of the current branding package.
cPanel loads dynamicui files in the following order:
|
1
2
3
4
5
|
/usr/local/cpanel/base/frontend/theme/dynamicui.conf/usr/local/cpanel/base/frontend/theme/dynamicui/dynamicui_*.confresellerhomedir/cpanelbranding/theme/dynamicui.conf/usr/local/cpanel/base/frontend/theme/package/dynamicui.confresellerhomedir/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:
|
1
2
3
4
|
{ "file":"item_to_hide", "skipobj":"1"}, |