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

Description

This function displays the $Cpanel::FORM elements and values in HTML input tags.

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.
$ui_display = $cpanel->api1('UI','confirm', array('1') ); // 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 $ui_display = $cpliveapi->api1('UI','confirm', ['1'] ); # 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="UI::confirm($FORM('version'))">
 Command Line
cpapi1 --user=username UI confirm 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.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (HTML)
<input type="hidden" name="$element" value="$value">

   

Parameters


ParameterTypeDescriptionPossible valuesExample
version string

Required

An arbitrary hash value.

A string value.

Warning:

Do not use an empty value.

0


Returns

This function returns the elements and tags.