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

 

Description

This function applies a new style to the cPanel interface.

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/update?theme=paper_lantern

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.
 
// Set new theme for example.com.
$set_theme = $cpanel->uapi(
    'Styles', 'update',
		array(
		'theme'			=> 'paper_lantern',
	)
 );

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.
 
# Set new theme on example.com.
my $set_theme = $cpliveapi->uapi(
    'Styles', 'update',
	{
		'theme'			=> 'paper_lantern',

	}
 );

Note:

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

 

 cPanel Template Toolkit
<!-- Update the theme. -->
[% execute('Themes', 'update', { theme => 'paper_lantern', } ); %]

Note:

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

 Command Line
uapi --user=username Themes update theme=paper_lantern

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": null
}

Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
themestring

Required

The theme name.

An available cPanel theme.paper_lantern

Returns

ReturnTypeDescriptionPossible valuesExample
statusBoolean

Whether the theme changed.

  • 1 — Changed.
  • 0 — Did not change.
1