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

Description

This function creates an HTML redirect string.

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','redirect', array('http://www.example.com/') ); // 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','redirect', ['http://www.example.com/'] ); # 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::redirect($FORM('url'))">
 Command Line
cpapi1 --user=username UI redirect http://www.example.com/


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)
<meta http-equiv="refresh" content="0;url=http://www.example.com">

   

Parameters

This function does not accept parameters.

Form Data

ParameterTypeDescriptionPossible valuesExample
url string

Required

The redirect URL.

A valid URL.

Warning:

We strongly recommend that you do not redirect users to the same page, because this would trap your users in an endless loop.

http://www.example.com/


Returns

This function returns the HTML redirect string.