cPanel API 2 Functions - PHPINI::getoptions

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function retrieves PHP directive configuration information.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:

In cPanel & WHM version 76 and later, when you disable the Web Server role, the system disables this function.


Examples


WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=PHPINI&cpanel_jsonapi_func=getoptions&dirlist="engine%7coutput_buffering%7cshort_open_tag%7c"&getnull="1"&php_prefix="%2Fusr%2Flocal%2Fcpanel%2F3rdparty%2F"
Note:

For more information, read our Calls from the WHM API documentation.


LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Get info about PHP directives.
$get_php_directive_info = $cpanel->api2(
    'PHPINI', 'getoptions',
    array(
        'dirlist'       => 'engine|output_buffering|short_open_tag',
        'getnull'       => '1',
        'php_prefix'    => '/usr/local/cpanel/3rdparty/',
    )
);
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.

# Get info about PHP directives.
my $get_php_directive_info = $cpliveapi->api2(
    'PHPINI', 'getoptions',
    {
        'dirlist'       => 'engine|output_buffering|short_open_tag',
        'getnull'       => '1',
        'php_prefix'    => '/usr/local/cpanel/3rdparty/',
    }
);
Note:

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


cPanel Tag System (deprecated)

Warnings:
  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username PHPINI getoptions dirlist=engine%7Coutput_buffering%7Cshort_open_tag getnull=1 php_prefix=%2Fusr%2Flocal%2Fcpanel%2F3rdparty%2F
Notes:
  • You must URI-encode values.
  • username represents your account-level username.
  • You must include the --user=username option.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:
    /usr/local/cpanel/bin/cpapi2

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getoptions",
    "data": [
      {
        "info": "Enable the PHP scripting language engine under Apache.",
        "dirvalue": "On",
        "commented": 0,
        "subsection": "Language Options",
        "directive": "engine",
        "section": "PHP"
      },
      {
        "info": "Output buffering allows you to send header lines (including cookies) even\n after you send body content, at the price of slowing PHP's output layer a\n bit.  You can enable output buffering during runtime by calling the output\n buffering functions.  You can also enable output buffering for all files by\n setting this directive to On.  If you wish to limit the size of the buffer\n to a certain size - you can use a maximum number of bytes instead of 'On', as\n a value for this directive (e.g., output_buffering=4096).",
        "dirvalue": "Off",
        "commented": 0,
        "subsection": "Language Options",
        "directive": "output_buffering",
        "section": "PHP"
      },
      {
        "info": "Allow the <? tag.  Otherwise, only <?php and <script> tags are recognized.  \n NOTE: Using short tags should be avoided when developing applications or\n libraries that are meant for redistribution, or deployment on PHP\n servers which are not under your control, because short tags may not\n be supported on the target server. For portable, redistributable code,\n be sure not to use short tags.",
        "dirvalue": "On",
        "commented": 0,
        "subsection": "Language Options",
        "directive": "short_open_tag",
        "section": "PHP"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "PHPINI"
  }
}
Note:

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


Parameters

Parameter Type Description Possible values Example
dirlist string

Required

The list of directives to query.

This function will not fail if you do not include the dirlist parameter. However, a dirlist value is required in order to return configuration information.

One or more php.ini directives.

  • Separate multiple directives with the pipe character (|).
  • In WHM API calls, replace each pipe character with %7C.
engine|short_open_tag|output_buffering
getnull Boolean

Whether to include null values in the return data.

This parameter defaults to 0.

  • 1 — Include null values.
  • 0 — Skip null values.
1
php_prefix string

The PHP installation location to query.

  • /usr/local/
  • /usr/local/php4/
  • /usr/local/cpanel/3rdparty/

In WHM API calls, replace each forward slash character with %2F.

/usr/local/cpanel/3rdparty/

Returns

Return Type Description Possible values Example
info string Information from the php.ini file about the directive, if it exists. A valid string. Enable the PHP scripting language engine under Apache.
dirvalue string The directive's current option. A valid string. On
commented Boolean Whether the directive is disabled (commented out) in the php.ini file.
  • 1 — Commented out.
  • 0Not commented out.
0
subsection string The php.ini file subsection that contains the directive. A valid string. Language Options
directive string The PHP directive. A PHP directive that you included in the dirlist input parameter. engine
section string The php.ini file section. A valid string. PHP
reason string

A reason for failure.

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
result Boolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1