The customizable panels in the Client Area Homepage display quick information to clients when they log in. You can customize this part of the Client Area to suit your brand and your customers’ needs.

Panel Structure #

The panels on the Client Area homepage use a tree structure of objects.

Each panel is a child of an invisible root item. Many panels also render their own child items as lists of links inside the panel:

• root item
  • panel item
    • line item
    • line item
    • line item
  • panel item
    • line item
    • line item
  • panel item

Panel Layout #

Panels can appear in two layouts, Desktop Mode or Responsive Mode.

• Desktop Mode typically appears in desktop web browsers. It renders most Client Area homepage panels in two columns.
• Responsive Mode activates when the Client Area renders on a smaller screen like a phone or tablet. It renders all panels in a single column.

Formatting and Customizing Panels #

Client Area Homepage panels are similar to sidebar panels. They use the same underlying structure as menu item objects, but include a few unique changes.

Custom Colors #

Panels can render in a custom color when you define the color menu item attribute.

The following colors are available:

• gold
• green
• red
• blue
• orange
• pink
• purple
• lime
• magenta
• teal
• turquoise
• emerald
• amethyst
• wet-asphalt
• midnight-blue
• sun-flower
• pomegranate
• silver
• asbestos

Optional Button #

Each homepage panel has an optional button that renders to the right of the panel’s label and badge.

Define the following menu item extras to render a button in a homepage panel:

• btn-link — The URL to load in the user’s web browser when the viewer clicks the button.
• btn-text — The text within the button.
• btn-icon — An optional Font Awesome icon to display to the left of the button’s text.
• colspan — In WHMCS 8.5 and later, an optional Boolean value that causes the panel to span both columns.

Default Panels #

WHMCS defines several panels by default:

Interacting With Homepage Panels #

You can use the add_hook() function to call custom code when WHMCS is rendering homepage panels.

The ClientAreaHomepagePanels hook allows you to manipulate the Client Area homepage’s panels.

• Call this hook before you assign the panel object to the view template.
• This hook passes the Client Area home panel’s root item to the hook function.

Custom Actions #

In WHMCS 8.5 and later, you can use the CustomActions server module function to define items that perform a set function and then redirect the user to a specified URL.

• Customers can invoke items from within the Client Area.
• Use this to specifically add items to the My Active Products/Services panel in the Client Area home page.
• You can also use this to add custom actions to Client Area service sidebar menus.

Customization #

You can add, modify, or remove panels in the Client Area to suit your needs.

For examples of customizing Client Area Homepage panels, see:

• Add a Promotional Offer Panel
• Add an Informational Panel
• Create a Two-Column Panel
• Modify an Existing Panel
• Rearrange Panels
• Remove a Panel

Last modified: November 19, 2024