Knowledgebase

nvarglist

or

arglist

 string 

The order in which to sort the groups.

 If you do not supply a value, the function does not sort the groups. 

 A pipe-separated (|) list of group names. 

 pref|software|domains 

index

hash of arrays

A hash of arrays that contain the order in which applications appear in the cPanel interface.

This hash includes theapp_name array.

app_name

array

An array that contains the order in which the application appears in the cPanel interface.

Note:

This parameter's name is the application's name.

 The function returns this value in the index hash.

Two comma-separated non-negative integers.

• The first integer represents the group in which the application appears.
• The second integer represents the order in which the application appears in the group.

7,1

grouporder

array

An array that contains the order in which the groups appear.

A comma-separated list of group IDs.

 "files","databases","domains","email","metrics","security","software","advanced","preferences","pref" 

groups

 array of    hashes 

 An array that contains  information about the  groups in the cPanel  interface.

This array includes thegroup and descreturns and the itemsarray.

group

string

The group's ID.

 The function returns this value in the groups array.

A valid string.

files

desc

string

 The group's description.

 The function returns this value in the groups array.

A valid string.

Files

items

array of hashes

 An array of hashes that contain group information.

 The function returns this array in the groups array.

This array includes thewidth, itemorder,  file,itemdesc, feature,subtype, target,group, acontent,searchtext, imgtype,base64_png_image,url, implements,height, onclick,feature, if, touch  and module returns.

width

integer

 The application's icon's width.

 The function returns this value in the items array.

The application icon width, in pixels.

48

itemorder

integer

The application's order in  thedynamicui.conffile.  

 The function returns this  value in the items array.

A positive integer that represents the application's display order in cPanel'sHome interface.

For example, the first item in the cPanelHome interface'sitemorder value is 1.

4

file

string

 The application's icon's  filename.

 The function returns this value in the items array.

An image's filename.

addon_domains

itemdesc

string

 The application's display name.

 The function returns this value in the items array.

A string value.

Addon Domain

height

 integer 

The application icon height.

 The function returns this value in the items array.

The application icon height, in pixels.

48

feature

string

A feature name. The icon onlydisplays if the cPanel user can access this feature.

 The function returns this value in the items array.

A feature name.

addondomains

target

string

The target of the application's link.

 The function returns this value in the items array.

A valid string.

file_manager

acontent

string

 The content of a tag in  the application's link.

 The function returns this value in the items array.

A valid string.

target=\"file_manager\"

base64_png_image

string

 The application's icon in Base64 format.

 The function returns this value in the items array.

A valid Base64-encoded image file.

group

string

The item's group.

 The function returns this value in the items array.

A string value.

advanced

subtype

string

The item's subtype.

 The function returns this value in the items array.

img is the only possible value.

img

imgtype

string

The item's image type.

 The function returns this value in the items array.

icon is the only possible value.

icon

searchtext

string

One or more search terms. The icon will display when users enter these search terms in the Quick Find text box in the cPanel interface.

 The function returns this value in the items array.

A space-separated list of search terms.

Domains Addon domain

url

string

The location to which the application's icon links.

 The function returns this  value in the items array.

A valid filepath or URL.

addon/index.html

type

string

The application's type.

 The function returns this value in the items array.

image is the only possible value.

image

implements

string

The app_key that the function overwrote.

 The function returns this value in the items array.

An application name.

WHM API 1'screate_user_sessionand get_users_linksfunctions use this value.

Domains_AddonDomains

onclick

string

A JavaScript function that the browser calls  before or instead of URL navigation.

 The function returns this value in the items array.

A valid string.

function

module

string

The Perl module that  the application requires.

 The function returns this value in the items array.

A valid string.

My::Module

touch

string

Conditional arguments  that determine whether    to display the item, if  a specified touch file exists.

 The function returns this value in the items array.

A valid string.

ftp

if

string

Conditional arguments that determine whether to display the item, if any exist.

 The function returns this value in the items array.

A valid string that contains cPanel variables.

For example,$isreseller indicates that the item onlydisplays for reseller accounts.

For more information, read our Guide to cPanel Variablesdocumentation.

implements

hash

A hash that contains information about the applications and  alternative names under which the cPanel  interface displays them.

This hash includes theapp_name return.

app_name

string

The name of the application.

Note:

This return's name is the application's name.

 The function returns this value in the implementshash.

A valid application name.

"Email_BoxTrapper":"boxtrapper",