Development Guides Home >> Guide to the LiveAPI System >> LiveAPI Methods
Guide to the LiveAPI System - The cpanelfeature() Method
The cpanelfeature()
method is a wrapper for the feature
tag, which checks whether the authenticated user has access to a feature.
Example
LiveAPI PHP Class
// Check whether the cPanel user has access to the SSL Manager.
$cpanel->cpanelfeature (sslmanager);
LiveAPI Perl Module
# Check whether the cPanel user has access to the SSL Manager.
$cpliveapi->cpanelfeature(sslmanager);
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
feature |
string | The feature to query. | A valid cPanel & WHM feature name. You can use WHM API 1's get_feature_names function to access a list of available feature names. |
sslmanager |
Returns
This method returns a Boolean value:
-
1
— The cPanel user has access to the feature. -
0
— The cPanel user does not have access to the feature.