Child pages
  • UAPI Functions - LangPHP::php_get_installed_versions
Skip to end of metadata
Go to start of metadata

Description

This function lists the system's PHP versions.


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_get_installed_versions


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.
 
// List PHP versions installed on the system.
$php_get_installed_versions = $cpanel->uapi(
    'LangPHP', 'php_get_installed_versions'
   );


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.
 
# List PHP versions installed on the system.
my $php_get_installed_versions = $cpliveapi->uapi(
    'LangPHP', 'php_get_installed_versions',
  );


Note:

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

 cPanel Template Toolkit
<!-- List PHP versions installed on the system. -->
[% execute( 'LangPHP', 'php_get_installed_versions' ) %]


Note:

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

 Command Line
uapi --user=username LangPHP php_get_installed_versions


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":null,
   "status":1,
   "metadata":{
   },
   "data":{
      "versions":[
         "ea-php54",
         "ea-php55",
         "ea-php56"
      ]
   }
}


Note:

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

Parameters

This function does not accept parameters.

Returns

Return
Type
Description
Possible values
Example

versions

array

The available PHP versions.

Note:

In cPanel & WHM version 70 we updated this return to only show a virtual host's available PHP versions. In cPanel & WHM version 68 and earlier, this return displayed a virtual host's installed PHP versions.

  • ea-php54
  • ea-php55
  • ea-php56
  • ea-php70
  • ea-php71
  • ea-php72
  • Any custom PHP package name.
ea-php56