Child pages
  • UAPI Functions - Locale::get_attributes
Skip to end of metadata
Go to start of metadata

 

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


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.
 
// List the attributes of the current locale.
$get_attributes = $cpanel->uapi(
    'Locale', 'get_attributes'
);


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.
 
# List the attributes of the current locale.
my $get_attributes = $cpliveapi->uapi(
    'Locale', 'get_attributes',
);


Note:

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

 

 cPanel Template Toolkit
<!-- List the attributes of the current locale. -->
[% data = execute( 'SSH', 'get_attributes' ); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 

 Command Line
uapi --user=username Locale get_attributes


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)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": {
    "direction": "ltr",
    "name": "English",
    "locale": "en",
    "encoding": "utf-8"
  }
}


Note:

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

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
portstring

The locale's text direction.

  • ltr — left to right.
  • rtl — right to left.
ltr
namestringThe locale's full name. A valid string.English
localestringThe locale's abbreviated name. A valid locale abbreviation.en
encodingstringThe user's character set. A valid character set abbreviation.utf-8