Description

This function lists available themes.

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


https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Themes&cpanel_jsonapi_func=get_available_themes

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List available themes.
$list_themes = $cpanel->api2(
    'Themes', 'get_available_themes'
);

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List available themes.
my $list_themes = $cpliveapi->api2(
    'Themes', 'get_available_themes',
);

 

This function is deprecated.

 {
  "cpanelresult": {
    "apiversion": 2,
    "func": "get_available_themes",
    "data": [
      "paper_lantern"
    ],
    "event": {
      "result": 1
    },
    "module": "Themes"
  }
}

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
data array A list of available themes.
  • paper_lantern
  • The name of a valid cPanel theme that exists on the server.
paper_lantern
reasonstring

A reason for failure.

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1