cPanel API 2 Functions - SetLang::setlocale - Knowledgebase

Description

This function sets the account's locale.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=SetLang&cpanel_jsonapi_func=setlocale&locale=en

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Sets the "en" locale for the account
$stickthisfishinyourear = $cpanel->api2(
    'SetLang', 'setlocale', 
    array(
        'locale' => 'en',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Sets the "en" locale for the account
my $stickthisfishinyourear = $cpliveapi->api2(
    'SetLang', 'setlocale',
    {
        'locale' => 'en',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use theLiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

 
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "setlocale",
    "data": [
       
    ],
    "event": {
      "result": 1
    },
    "module": "SetLang"
  }
}