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

 

Description

This function checks whether an account can access a feature.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Features/has_feature?name=fantastico

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.
 
// Does the account have the feature "fantastico" ?
$Features_has_feature = $cpanel->uapi(
    'Features', 'has_features',    array(
        'name'    => 'fantastico',
    )
);

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.
 
# Does the account have the feature "fantastico" ?
my $Features_has_feature = $cpliveapi->uapi(
    'Features', 'has_feature',    {
        'name'    => 'fantastico',
    }
);

Note:

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

 

 cPanel Template Toolkit
<!-- Does the account have the feature "fantastico" ? -->
[% data = execute( 'Features', 'has_feature', { name => 'fantastico'}  ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

Note:

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

 

 Command Line
uapi --user=username Features has_feature name=fantastico

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)

If the feature does not exist:

{
  "messages": [
    null
  ],
  "errors": null,
  "status": 0,
  "metadata": {
    
  },
  "data": null
}

If the feature exists and is enabled:

{
  "messages": [
    null
  ],
  "errors": null,
  "status": 1,
  "metadata": {
    
  },
  "data": null
}

If the feature exists and is not enabled:

{
  "messages": [
    "The feature "fantastico" exists but is not enabled."
  ],
  "errors": null,
  "status": 0,
  "metadata": {
    
  },
  "data": null
}


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
namestringThe feature's name.A valid string.
fantastico

Returns

Note:

The function returns a hash of boolean values that use the name of each of the account's features and their statuses. 

ReturnTypeDescriptionPossible valuesExample
messagesstringWhether the feature exists, and its status.
  • A confirmation message.
  • A null value.
The feature "fantastico" exists but is not enabled.