Child pages
  • Guide to the LiveAPI System - The header() Method
Skip to end of metadata
Go to start of metadata

 

Description

The header() method calls the cPanel interface's header. Use this method to add the necessary header buttons at the top of the interface.

Note:

This method is available in cPanel & WHM version 11.46 and later. The app_key parameter is only available in cPanel & WHM version 11.52 and later. This method is only compatible with cPanel's Paper Lantern theme.

Example


LiveAPI PHP Class

// Inject the title page and application icon into the header element.
$cpanel->header(title , app_key);

LiveAPI Perl Module

# Inject the title page and application icon into the header element.
$cpliveapi->header(title , app_key);

Parameters

ParameterTypeDescriptionPossible valuesExample
titlestringThe title of the page to inject into the cPanel interface's <header> element.A valid HTML page's title value.title
app_keystring

The app_key value for the application interface that you want to inject into the cPanel interface's <header> element.

Note:

This parameter is only available in cPanel & WHM version 11.52 and later. To find a valid value for this parameter, use UAPI's Branding::get_applications function or read our Guide to cPanel Interface Customization - Appkeys documentation.

A valid app_key value.mx_entry

Returns

This method returns a string value that contains the contents of the interface page before the <header> element.