Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function sets a virtual host's PHP version.

Note:

This document only applies to systems that run EasyApache 4.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/LangPHP/php_set_vhost_versions?vhost=blammo.com&vhost-1=failed.com&version=ea-php55

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.
 
// Set the PHP version of the virtual hosts.
$set_vhost_version = $cpanel->uapi(
    'LangPHP', 'php_set_vhost_version',
    array(
        'vhost-1'     => 'blammo.com', 
        'vhost-2'	  => 'failed.com',
		'version'	  => 'ea-php-54',
         )
);

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.
 
# Set the PHP version of the virtual hosts.
my $set_vhost_version = $cpliveapi->uapi(
    'LangPHP', 'php_set_vhost_version',
    (
        'vhost-1'     => 'blammo.com', 
        'vhost-2'	  => 'failed.com',
		'version'	  => 'ea-php-54',
    )
);

Note:

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

 cPanel Template Toolkit
<!-- Set the PHP version of a vhost. -->
[% execute( 'LangPHP', 'php_set_vhost_version' ); %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username LangPHP php_set_vhost_versions vhost=blammo.com vhost-1=failed.com version=ea-php55

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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
   "messages":null,
   "errors":[
      "No users correspond to the domain “failed.com”."
   ],
   "status":0,
   "metadata":{
   },
   "data":{
      "vhosts":[
         "blammo.com"
      ]
   }
}

Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample

vhost

string

Required

The name of the virtual host.

Note:

To change the PHP version of multiple virtual hosts, duplicate or increment the parameter name. For example, to change three virtual hosts, use the vhost parameter multiple times or use the vhost-1, vhost-2, and vhost-3 parameters.

A virtual host on the system.

blee.com

version

string

Required

The PHP version of a virtual host.

A PHP version on the system.

 

ea-php54

Returns

Return
Type
Description
Possible values
Example

vhosts

arrayThe names of the changed virtual hosts.

A virtual host on the system.

blee.com