We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • WHM API 1 Functions - php_get_system_default_version
Skip to end of metadata
Go to start of metadata

Description

This function returns the system default 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 Web Server role, the system disables this function.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/php_get_system_default_version?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/php_get_system_default_version?api.version=1
 Command Line
whmapi1 php_get_system_default_version


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
   "data":{
      "version":"ea-php56"
   },
   "metadata":{
      "version":1,
      "reason":"Ok",
      "result":1,
      "command":"php_get_system_default_version"
   }
}
 Output (XML)
<result>
    <data>
        <version>ea-php56</version>
    </data>
    <metadata>
        <version>1</version>
        <reason>Ok</reason>
        <result>1</result>
        <command>php_get_system_default_version</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample

version

stringThe server's default PHP version.


Important:

We deprecated PHP 5.6 and PHP 7.0 in cPanel & WHM version 84. We will remove them in a future version. For more information, read our cPanel Deprecation Plan documentation.

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

ea-php56