Child pages
  • WHM API 1 Functions - php_set_vhost_versions
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.

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/LangPHP/php_set_vhost_versions?php-fpm=1&version=ea-php55&vhost=example.com&vhost-1=example1.com


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(
		'php-fpm'	  => '1'
		'version'	  => 'ea-php-54',
        'vhost-1'     => 'example.com', 
        'vhost-2'	  => 'example1.com'
         )
);


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',
    (
		'php-fpm'	  => '1'
		'version'	  => 'ea-php-54',
        'vhost-1'     => 'example.com', 
        'vhost-2'	  => 'example1.com'
    )
);


Note:

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

 cPanel Template Toolkit
<!-- Set the PHP version of a vhost. -->
[% data = execute( 'LangPHP', 'php_set_vhost_version'{ 'php-fpm' => '1','version' => 'ea-php-54','vhost-1' => 'example.com','vhost-2' => 'example.com' } ); %]


Note:

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

 Command Line
uapi --user=username LangPHP php_set_vhost_versions php-fpm=1 version=ea-php55 vhost=example.com vhost-1=example1.com


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)
{
   "messages":null,
   "errors":[
      "No users correspond to the domain "example1.com"."
   ],
   "status":0,
   "metadata":{
   },
   "data":{
      "vhosts":[
         "example.com"
      ]
   }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
php-fpmBoolean

Whether to enable the PHP FastCGI Process Manager (PHP-FPM) service.

Note:

We added this parameter in cPanel & WHM version 60.

  • 1 — Enable the service.
  • 0 — Disable the service.
1

version

string

Required

The PHP version of a virtual host.

A valid PHP version on the system.

 

ea-php54

vhost

string

Required

The virtual host's name.

Note:

To change the PHP version of multiple virtual hosts, duplicate or increment the parameter name. For example, to change three virtual hosts, you can:

  • Use the vhost parameter multiple times.
  • Use the vhost-1, vhost-2, and vhost-3 parameters.

A valid virtual host on the system.

example.com

Returns

Return
Type
Description
Possible values
Example

vhosts

arrayThe names of the changed virtual hosts.

A virtual host on the system.

example.com