# cPanel API 2 Functions - Locale::get_locale_name

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](https://api.docs.cpanel.net/cpanel/introduction) instead of cPanel API 2.

## Description

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

Warning:
We **strongly** recommend that you use the following [UAPI](/cpanel/introduction/) function instead of this function:

- [`Locale::get_attributes`](/openapi/cpanel/operation/get_attributes)


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

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


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

// Display locale for "user."
$get_locale = $cpanel->api2(
    'Locale', 'get_locale_name'

);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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',

  );
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Locale get_local_name locale=French
```

div
Notes:

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

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


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

Note:
Use cPanel's [*API Shell*](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel) interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

table
colgroup
col
col
col
col
col
thead
tr
th
Parameter
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
code
locale
td
em
string
td
p
The locale's name.
p
This parameter defaults to the user's locale.
td
Any available locale.
td
code
French
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
name
td
em
string
td
p
The locale's name.
td
Any available locale, in the authenticated user's language.
td
code
French
tr
td
code
reason
td
em
string
td
div
p
A reason for failure.
p
This function only returns a 
code
reason
 value if there was an error. 
td
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
p
br
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1