cPanel API 2 Functions - Locale::get_locale_name - Knowledgebase

Description

This function displays a locale's name in the user's language.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Locale::get_attributes — This function retrieves information about the user's current locale setting.

Examples

WHM API (JSON)

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

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Display locale for "user."

$get_locale = $cpanel->api2(

'Locale', 'get_locale_name'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Display locale for "user."

my $get_locale = $cpliveapi->api2(

'Locale', 'get_locale_name',

);

cPanel Tag System (deprecated)

Warning:

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.

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

Command Line

cpapi2 --user=username Locale get_local_name locale=French

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "get_locale_name",
    "data": [
      {
        "name": "French"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Locale"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
locale	string	The locale's name. This parameter defaults to the user's locale.	Any available locale.	French

Parameter

Type

Description

Possible values

Example

locale

string

The locale's name.

This parameter defaults to the user's locale.

Any available locale.

French

Returns

Return	Type	Description	Possible values	Example
name	string	The locale's name.	Any available locale, in the authenticated user's language.	French
reason	string	A reason for failure. Note: This function only returns areason value if there was an error.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories