Child pages
  • cPanel API 1 Functions - Branding::setupdirs

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function creates an account's /cpanelbranding directory and subdirectories, and sets its permissions.

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$branding_dir = $cpanel->api1('Branding', 'setupdir', array('public_html') ); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $branding_dir = $cpliveapi->api1('Branding', 'setupdirs', ['public_html'] ); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Branding::setupdirs( $FORM('ownerhomedir') )">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username Branding setupdirs public_html x3 package1

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote

Expand
titleOutput (URL)

This function does not return output.

 

Parameters

ParameterTypeDescriptionPossible valuesExample
ownerhomedirstring

Required

The account owner's /home directory's filepath.

A valid directory name.public_html
themestringThe account's theme.

 

 

A valid theme.

x3
brandingpkgstring

The branding package name.

A valid branding package name.

package1

Returns

This function does not return output.