Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
UAPI Functions - Locale::set_locale - Developer Documentation - cPanel Documentation
Child pages
  • UAPI Functions - Locale::set_locale
Skip to end of metadata
Go to start of metadata

Description

This function sets the account's locale.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess###########/execute/Locale/set_locale?locale=en


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 the "en" locale for the account.
$set_locale = $cpanel->uapi(
    'Locale', 'set_locale', 
    array(
        'locale' => 'en',
    ) 
);


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 the "en" locale for the account.
my $set_locale = $cpliveapi->uapi(
    'Locale', 'set_locale',
    { 
        'locale' => 'en',
    }
);


Note:

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


 Command Line
uapi --user=username Locale set_locale locale=en


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. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "metadata":{  

   },
   "data":null,
   "status":1,
   "errors":null,
   "messages":null,
   "warnings":null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
localestring

Required

The locale's abbreviated name.

A two-letter ISO-3166 code.en

Returns

This function only returns metadata.