Page tree
Skip to end of metadata
Go to start of metadata

 

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.

Note:

In cPanel & WHM version 66 and later, the /scripts/modify_accounts script allows you to modify the style and theme for many or all accounts on the server. For more information, read our The modify_accounts Script documentation. 

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Themes/get_theme_base

 

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 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'
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 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',
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Template Toolkit
 <!-- List the account's current theme. -->
[% data = execute( 'Themes', 'get_theme_base' ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Themes get_theme_base

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
 {
    "messages": null,
    "errors": null,
    "status": 1,
    "metadata": {},
    "data": "paper_lantern"
}


Note:

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

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
datastringThe cPanel account's base theme.

The function returns only one of the following strings:

  • paper_lantern
  • unknown

    Note:

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

paper_lantern