Page tree
Skip to end of metadata
Go to start of metadata

Description

This function returns the user's current style.

Note:

In cPanel & WHM version 66 and later, the /scripts/modify_accounts script allows you to modify the style and theme for many or all accounts on the server. For more information, read our The modify_accounts Script documentation. 

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Styles/current

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.
 
// Return current user's style. 
$current = $cpanel->uapi(
    'Styles', 'current'
);

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.
 
# Return current user's style.
my $current = $cpliveapi->uapi(
    'Styles', 'current',
);

Note:

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

 cPanel Template Toolkit
<!-- Display all the attributes for the current style. -->
[% data = execute( 'Styles', 'current' ).data; %]
[% FOREACH q = data %]
    <p>
		<br>Preview: [% q.preview %]</br>
        <br>Name: [% q.name %]</br>
		<br>Default: [% q.default %]</br>
        <br>Type: [% q.type %]</br>
		<br>Selected: [% q.selected %]</br>
        <br>Display Name: [% q.display_name %]</br>
        
    </p>
[% END %]

Note:

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

 Command Line
uapi --user=username Styles current 

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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":{  
      "preview":1,
      "name":"basic",
      "default":1,
      "type":"default",
      "selected":1,
      "display_name":"Basic"
   }
}

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
previewBooleanWhether the style contains a preview image.
  • 1 — Present.
  • 0 — Absent.
1
namestringThe folder that contains the style.A valid filename.basic
defaultBooleanWhether the style is the default style.
  • 1 — The default style.
  • 0 — Not the default style.
1
typestringThe style type.
  • default
  • global
  • reseller
  • user
default
selectedBooleanWhether the style is the current style.
  • 1 — The current style.
  • 0 — Not the current style.
1
display_namestring

The style name.

A style name.

The style's directory name determines this name.

Basic