cPanel API 1 Functions - ImageManager::thumbnail - Knowledgebase

Description

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:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — None.
cPanel API 2 — ImageManager::thumbnail — This function is deprecated and does not return useful output.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$image_thumbnail = $cpanel->api1('ImageManager','thumbnail',array('images.jpg','10','10')); // Call the function.

LiveAPI Perl Module

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.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="ImageManager::thumbnail($FORM('dir','wperc','hperc'))">

Output (plaintext)

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

Parameter	Type	Description	Possible Values	Example
dir	string	Required The file to convert, or a directory that contains the files to convert.	A valid filename or directory name.	public_html/images
wperc	integer	Required The percentage by which to reduce the thumbails' width.	A valid integer.	10
hperc	integer	Required The percentage by which to reduce the thumbails' height.	A valid integer.	10

Returns

This function returns a confirmation message.

Knowledgebase

Categories

Categories