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

Description

This function converts an image to a new file format. The function uses ImageMagick's convert function and is subject to the same file type limitations.

When you call this function, the system creates a new file with the same filename and specified file extension. If the function does not recognize the output format, the function copies and renames the file and does not generate a failure message.

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.

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 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$image_convert = $cpanel->api1('ImageManager','convert',array('public_html/images','jpg')); // 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_convert = $cpliveapi->api1('ImageManager','convert',['public_html/images','jpg'] ); # 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::convert($FORM('target','newtype'))">
 Command Line
cpapi1 --user=username ImageManager convert public_html/images jpg


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.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (plaintext)
Converting /home/user/test1.jpg to /home/user/test1. gif...........Done

Parameters

ParameterTypeDescriptionPossible ValuesExample
targetstring

Required

The image or directory with images to convert.

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

Required

The format to which to convert the images.

A valid image format (for example, jpg or gif).jpg

Returns

This function returns a confirmation message.