Child pages
  • cPanel API 2 Functions - Themes::apply_new_theme
Skip to end of metadata
Go to start of metadata

 

Description

This function is deprecated and does not return useful output.

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. 

Warnings:

  • We strongly recommend that you use the following UAPI function instead of this function:
    • Themes::update — This function applies a new style to the cPanel interface.

  • We deprecated and removed this function in cPanel & WHM version 11.44. For help to update custom code that uses this function, send an email to  integration@cpanel.net.

Examples 


 WHM API (JSON)
This function is deprecated.


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
This function is deprecated.


Note:

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

 

 LiveAPI Perl Module
This function is deprecated.


Note:

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

 

 cPanel Tag System (deprecated)


Warnings:

  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
This function is deprecated.


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
 {
  "cpanelresult": {
    "apiversion": 2,
    "func": "apply_new_theme",
    "data": [
    ],
    "event": {
      "result": 1
    },
    "module": "Themes"
  }
}


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

This function does not return useful output.