cPanel API 2 Functions - PHPINI::getoptions - Knowledgebase

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.

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=

 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/',
    ) 
);

 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/',
    }
);

cPanel Tag System (deprecated)

Warning:

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.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

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.

Output (JSON)

Note:

Use cPanel's API Shell interface (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. Note: This function will not fail if you do not include thedirlistparameter. However, adirlist value is required in order to return configuration information.	One or more php.ini directives. Notes: 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/ Note: 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 thephp.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. 0 — Notcommented 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 thedirlist input parameter.	engine
section	string	The php.ini file section.	A valid string.	PHP
reason	string	A reason for failure. Note: This function only returns a reasonvalue 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

Knowledgebase

Categories

Categories