Cpanel::WebDisk::listwebdisks

This article documents the usage of the Cpanel::WebDisk::listwebdisks function in relation to the cPanel interface. This tag can be used inside cPanel pages.

SYNOPSIS

DESCRIPTION

This function will list all web disks associated with a domain / account and it's associated domains(addon, sub, parked).

VARIABLES

INPUT

NONE

OUTPUT

reldir (string): Root directory the web disk has access to. Relative to /home/username/
domain (string): Domain the web disk is associated with. Format: domain.com or sub.domain.com
login (string): Username associated with the web disk. Format: user@domain.com or user@sub.domain.com
homedir (string): Home directory of the root domain / account the web disk is associated with. Fromat: /home/username
user (string): Username prefix associated with the web disk. Format: username

EXAMPLES

<?cp WebDisk::listwebdisks(% % % ,login,reldir,domain)?>

This example will list the username, relative home directory and domain associated with each web disk on an account.