Child pages
  • cPanel API 1 Functions - ImageManager::thumbnail

Versions Compared

Key

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

Description

Excerpt

This function creates thumbnails from images.

 The function saves the new thumbnail images in a thumbnails subdirectory inside the original directory. The system prepends thumbnail filenames with tn_ (for example, tn_picture.jpg).

Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended)None.
  • cPanel API 2 ImageManager::thumbnail
    Excerpt Include
    DD:cPanel API 2 Functions - ImageManager::thumbnailDD:
    cPanel API 2 Functions - ImageManager::thumbnail
    nopaneltrue

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

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.
$image_thumbnail = $cpanel->api1('ImageManager','thumbnail',array('images.jpg','10','10')); // 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 $image_thumbnail = $cpliveapi->api1('ImageManager','thumbnail',['images.jpg','10','10'] ); # 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="ImageManager::thumbnail($FORM('dir','wperc','hperc'))">



Expand
titleCommand Line


Code Block
languagebash
cpapi1 --user=username ImageManager thumbnail public_html/images 10 10

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (plaintext)


Code Block
Thumbnailing.../home/user/test.jpg (250x250)...wrote.../home/user/thumbnails/tn_test.jpg (25x25)...Done 
Thumbnailing.../home/user/t2.jpg (250x250)...wrote.../home/user/thumbnails/tn_t2.jpg (25x25)...Done




Parameters

ParameterTypeDescriptionPossible ValuesExample
dirstring

Required

The file to convert, or a directory that contains the files to convert.

A valid file or directory path, relative to the cPanel account's home directory.public_html/images
wpercinteger

Required

The percentage by which to reduce the thumbails' width.

A valid integer.10
hpercinteger

Required

The percentage by which to reduce the thumbails' height.

A valid integer.10

Returns

This function returns a confirmation message.