Child pages
  • UAPI Functions - ImageManager::get_dimensions
Skip to end of metadata
Go to start of metadata

Description

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

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/ImageManager/get_dimensions?image_file=images/myimage.jpg


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Return the dimensions for myimage.jpg.
$get_dimensions = $cpanel->uapi(
    'ImageManager', 'get_dimensions',
    array(
        'image_file'   => 'images/myimage.jpg',
    )
);


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.
 
# Return the dimensions for myimage.jpg.
my $get_dimensions = $cpliveapi->uapi(
    'ImageManager', 'get_dimensions',
    {
        'image_file'   => 'images/myimage.jpg',
    }
);


Note:

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

 Command Line
uapi --user=username ImageManager get_dimensions image_file=images/myimage.jpg


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
    {
       "module" : "ImageManager",
       "apiversion" : 3,
       "func" : "get_dimensions",
       "result" : {
          "metadata" : {},
          "data" : {
             "width" : "261",
             "height" : "300"
          },
          "messages" : null,
          "status" : 1,
          "warnings" : null,
          "errors" : null
       }
    }


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters 

ParameterTypeDescriptionPossible valuesExample
image_file
string

Required

The path to the file to measure.

  • An absolute filepath.
  • A filepath relative to the user's home directory.
image/myimage.jpg

Returns

ReturnTypeDescriptionPossible valuesExample
width integerThe image's width, in pixels.An integer value.261 
height integerThe image's height, in pixels.An integer value.300