Skip to end of metadata
Go to start of metadata

Overview

The documents in this section describe advanced functions and procedures to help you customize cPanel & WHM's user interfaces. This includes advanced tasks, such as style development, as well as simpler customizations, such as branding adjustments.

For the purposes of cPanel, Inc.'s products and documentation, we use the following terms:

  • Branding — Modifications to the cPanel interface in order to match your company's logo and brand. 
    • Branding changes include updates to image assets or text labels.
    • For more information, read our Branding documentation.
  • Includes — UI includes add custom content to the header or footer of the cPanel interface (but not the WHM interface). 
    • You can create UI includes for specific cPanel interfaces, or global UI includes that display on all of cPanel's interfaces. 
    • For more information, read our UI Includes documentation.
  • Plugin — A plugin modifies an interface's features or functionality, and may also include changes to the interface's appearance.
    • You can write plugins for the cPanel or WHM interfaces.
    • For more information, read our Guide to cPanel Plugins documentation.
  • Style  — A style uses CSS, images, and other assets to modify the appearance of the entire cPanel interface  without  changes to its functionality or features. 
    • You can create and apply styles to an entire server or a specific reseller's accounts, or you can create them for distribution. 
    • For more information, read our cPanel Style Development documentation.
  • Theme — A skeletal framework of interfaces, over which the system applies one of that theme's styles.
    • cPanel & WHM currently ships with one default cPanel theme and one default WHM theme.
    • The Webmail and login interfaces also use themes.

For more information, read our Guide to cPanel Interface Customization and Branding and Guide to Testing Custom Code - Branding documentation.

If you need help with any of these processes, open a technical support ticket.

Important information

Before you execute the steps in any of this section's documents, we strongly recommend that you understand the following information:

  • These documents do not account for any additional changes or customizations to your server.
  • We only tested the instructions in these documents on default installations of CentOS and Red Hat® Enterprise Linux®.

Warning:

Some of these documents describe dangerous procedures or unsupported workarounds that we do not guarantee will work in the future. Exercise caution when you execute the steps in these documents.

Additional documentation