Return basic PHP directives

This function lists a virtual host's basic PHP directives. The Basic Mode section of cPanel's MultiPHP INI Editor interface (Home >> Software >> MultiPHP INI Editor) also lists these directives.

Note:

This document only applies to systems that run EasyApache 4 with MultiPHP enabled.

Important:

When you disable the WebServer role, the system disables this function.

SecurityBasicAuth
Request
query Parameters
type
required
string

The type of php.ini file.

  • home
  • vhost

Important:

If you set this parameter to vhost, you must also include the vhost parameter.

Enum: "home" "vhost"
Example: type=vhost
vhost
string <domain>

The name of a virtual host.

Important:

If the type value is vhost, you must use this parameter.

Example: vhost=clearly.com
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/LangPHP/php_ini_get_user_basic_directives
Request samples
uapi --output=jsonpretty \
  --user=username \
  LangPHP \
  php_ini_get_user_basic_directives \
  type='vhost'
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "php_ini_get_user_basic_directives",
  • "module": "LangPHP",
  • "result": {
    • "data": {
      • "directives": [
        • {
          • "default_value": 1,
          • "info": "This option enables the URL-aware fopen wrappers that enable accessing URL object like files. Default wrappers are provided for the access of remote files using the ftp or http protocol, some extensions like zlib may register additional wrappers.",
          • "key": "allow_url_fopen",
          • "php_ini_mode": "PHP_INI_SYSTEM",
          • "type": "integer",
          • "value": "On"
          }
        ]
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}