Description
This function retrieves a directory's authorized users from the .htaccess
file.
Warning:
We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.
Examples
Note:
Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.
Parameters
Parameter |
Type |
Description |
Possible values |
Example |
dir |
string |
Required The directory's name. |
The absolute path to the directory. |
/home/example/public_html/heavensdoor |
Returns
Return |
Type |
Description |
Possible values |
Example |
|
array of hashes |
An array of hashes that contains information about each authorized user. |
This array of hashes includes the user return. |
|
user |
string |
The authorized user's username. The function returns this value in the unnamed hash. |
A valid cPanel username. |
bobdylan |
reason |
string |
A reason for failure. Note: This function only returns a reasonvalue if it failed. |
A string that describes the error. |
This is an error message. |
result |
Boolean |
Whether the function succeeded. |
|
1 |