UAPI Functions - Themes::get_theme_base - Knowledgebase

Description

This function returns the cPanel account's base theme. If you have modified the current theme, this function returns the name of the theme that you modified. For example, if you have modified the x3 theme to create your own custom version, the function would return x3.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Themes/get_theme_base

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List the account's current theme.

$get_theme_base = $cpanel->uapi(

'Themes', 'get_theme_base'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List the account's current theme.

my $get_theme_base = $cpliveapi->uapi(

'Themes', 'get_theme_base',

);

cPanel Template Toolkit

[% data = execute( 'Themes', 'get_theme_base' ); %]

[% FOREACH q = data %]

<p>

[% q %]

</p>

[% END %]

Command Line

api --user=username Themes get_theme_base

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
    "messages": null,
    "errors": null,
    "status": 1,
    "metadata": {},
    "data": "paper_lantern"
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
data	string	The cPanel account's base theme.	The function returns only one of the following strings: paper_lantern x3 unknown Note: The function returns unknown when it cannot determine the base theme that you modified to create the custom theme.	paper_lantern

Return

Type

Description

Possible values

Example

data

string

The cPanel account's base theme.

The function returns only one of the following strings:

paper_lantern
x3
unknown

Note:

The function returns unknown when it cannot determine the base theme that you modified to create the custom theme.

paper_lantern

Knowledgebase

Categories

Categories