Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - php_ini_set_content - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - php_ini_set_content
Skip to end of metadata
Go to start of metadata

Description

This function changes the contents of a PHP version's php.ini file.

Notes:

  • This document only applies to systems that run EasyApache 4.
  • Due to the limited field length of HTTP GET method calls, we strongly recommend that you use the HTTP POST method.

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 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/php_ini_set_content?api.version=1&content=%5BPHP%5D%0A%3B%20About%20php.ini%0A%3B%20php.ini%20is%20responsible%20for%20configuring%20many%20of%20the%20aspects%20of%20PHP%27s%20behavior.%0Apcre.backtrack_limit%3D100000&version=ea-php70
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/php_ini_set_content?api.version=1&content=%5BPHP%5D%0A%3B%20About%20php.ini%0A%3B%20php.ini%20is%20responsible%20for%20configuring%20many%20of%20the%20aspects%20of%20PHP%27s%20behavior.%0Apcre.backtrack_limit%3D100000&version=ea-php70
 Command Line
whmapi1 php_ini_set_content content=%5BPHP%5D%0A%3B%20About%20php.ini%0A%3B%20php.ini%20is%20responsible%20for%20configuring%20many%20of%20the%20aspects%20of%20PHP%27s%20behavior.%0Apcre.backtrack_limit%3D100000 version=ea-php70


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":{
   },
   "metadata":{
      "version":1,
      "reason":"Ok",
      "result":1,
      "command":"php_ini_set_content"
   }
}
 Output (XML)
<result>
    <data/>
    <metadata>
        <version>1</version>
        <reason>Ok</reason>
        <result>1</result>
        <command>php_ini_set_content</command>
    </metadata>
</result>


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample

content

string

Required

The contents of the php.ini file that you wish to change.

Any valid URI-encoded php.ini file contents.

 Click to view...

%5BPHP%5D%0D%0A%3B+About+php.ini%0D%0A%3B+php.ini+is+responsible+for+configuring+many+of+the+aspects+of+PHP%27s+behavior.%0D%0Apcre.backtrack_limit%3D100000

versionstring

Required

The version of PHP for which you wish to change the php.ini file.


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-php70

Returns

This function only returns metadata.