UAPI Functions - Locale::get_attributes - Knowledgebase

Description

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

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Locale/get_attributes

LiveAPI PHP Class

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

// List the attributes of the current locale.

$get_attributes = $cpanel->uapi(

'Locale', 'get_attributes'

);

LiveAPI Perl Module

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

# List the attributes of the current locale.

my $get_attributes = $cpliveapi->uapi(

'Locale', 'get_attributes',

);

cPanel Template Toolkit

[% data = execute( 'SSH', 'get_attributes' ); %]

Command Line

uapi --user=username Locale get_attributes

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
      
  },
  "data": {
    "direction": "ltr",
    "name": "English",
    "locale": "en",
    "encoding": "utf-8"
  }
}

Note:

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

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
port	string	The locale's text direction.	ltr — left to right. rtl — right to left.	ltr
name	string	The locale's full name.	A valid string.	English
locale	string	The locale's abbreviated name.	A valid locale abbreviation.	en
encoding	string	The user's character set.	A valid character set abbreviation.	utf-8

Knowledgebase

Categories

Categories