Child pages
  • cPanel API 1 Functions - Htaccess::del_user

Versions Compared

Key

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

Description

Excerpt

This function removes a user's access to a password-protected directory.

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.
$delete_user = $cpanel->api1('Htaccess','del_user', array('protectedfolder','user') ); // 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 $delete_user = $cpliveapi->api1('Htaccess','del_user', ['protectedfolder','user'] ); # 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="Htaccess::del_user( $FORM('dir','user') )">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username Htaccess del_user protectedfolder user

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote

Expand
titleOutput (none)
This function does not return output.

   

Parameters

ParameterTypeDescriptionPossible valuesExample

dir

string

Required

The directory name.

A valid directory name.protectedfolder
userstring

Required

The username.

A valid username.user

Returns

This function does not return output.