Child pages
  • cPanel API 1 Functions - ImageManager::dimensions
Skip to end of metadata
Go to start of metadata

Description

This function returns the dimensions of the image file that you specify.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$image_dimensions = $cpanel->api1('ImageManager','dimensions',array('images','200','300')); // Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $image_dimensions = $cpliveapi->api1('ImageManager','dimensions',['images','200','300'] ); # Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="ImageManager::dimensions($FORM('dir','file','re'))">
 Command Line
cpapi1 --user=username ImageManager dimensions images image.jpg 0


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command. 

 Output (plaintext)
/home/user/test1.jpg JPEG 250x250 250x250+0+0 8-bit DirectClass 20.5kb

   

Parameters

ParameterTypeDescriptionPossible ValuesExample
dirstring

Required

The directory that contains the file to measure.

A valid directory path, relative to the cPanel account's home directory.
images
filestring

Required

The name of the file to measure.

A valid filename.image.jpg
restring

Required

Whether to return just the dimensions, or return additional information available through the identify command.

  • 1 — Return additional information.
  • 0 — Return just the dimensions.
0

Returns

This function returns a confirmation message.