cPanel API 2 Functions - SetLang::setlocale


This function sets the account's locale.


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




 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
// Sets the "en" locale for the account
$stickthisfishinyourear $cpanel->api2(
        '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(
        'locale' => 'en',
 cPanel Tag System (deprecated)


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"


  • 9 Users Found This Useful
  • Was this answer helpful?

    Related Articles

    The cPanel Interface

    For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

    User Preferences

    For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

    Manage External Authentications

    For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

    What is cPanelID?

    In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

    Guide to cPanel Interface Customization - cPanel Style Development

    Introduction You can develop custom styles that modify the appearance of the cPanel interface....