# cPanel API 2 Functions - PHPINI::getoptions Warning: The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2. ## Description This function retrieves PHP directive configuration information. Warning: We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists. Important: When you disable the [*Web Server* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function. ## Examples WHM API (JSON) ```undefined syntaxhighlighter-pre 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](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation. LiveAPI PHP Class ```undefined syntaxhighlighter-pre $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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). LiveAPI Perl Module ```undefined syntaxhighlighter-pre 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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). cPanel Tag System (deprecated) Warnings: - cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system). - 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation. Command Line ```undefined syntaxhighlighter-pre cpapi2 --user=username PHPINI getoptions dirlist=engine%7Coutput_buffering%7Cshort_open_tag getnull=1 php_prefix=%2Fusr%2Flocal%2Fcpanel%2F3rdparty%2F ``` div 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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command. - If you run CloudLinux™, you **must** use the full path of the `cpapi2` command: ```undefined syntaxhighlighter-pre /usr/local/cpanel/bin/cpapi2 ``` br Output (JSON) ```undefined syntaxhighlighter-pre { "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 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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls. ## Parameters table thead tr th strong Parameter th strong Type th strong Description th strong Possible values th strong Example tbody tr td code dirlist td em string td div p strong Required p The list of directives to query. p This function will not fail if you do not include the code dirlist parameter. However, a code dirlist value is required in order to return configuration information. td p One or more a code php.ini directives . ul li Separate multiple directives with the pipe character ( code | ). li In WHM API calls, replace each pipe character with code %7C . td code engine|short_open_tag|output_buffering tr td code getnull td em Boolean td p Whether to include null values in the return data. p This parameter defaults to code 0 . td ul li code 1 — Include null values. li code 0 — Skip null values. td code 1 tr td code php_prefix td em string td p The PHP installation location to query. td ul li code /usr/local/ li code /usr/local/php4/ li code /usr/local/cpanel/3rdparty/ p In WHM API calls, replace each forward slash character with code %2F . td code /usr/local/cpanel/3rdparty/ ## Returns table thead tr th strong Return th strong Type th strong Description th strong Possible values th strong Example tbody tr td code info td em string td Information from the code php.ini file about the directive, if it exists. td A span valid string. td code Enable the PHP scripting language engine under Apache. tr td code dirvalue td em string td The directive's current option. td A span valid string. td code On tr td code commented td em Boolean td Whether the directive is disabled (commented out) in the code php.ini file. td ul li code 1 — Commented out. li code 0 — strong Not commented out. td code 0 tr td code subsection td em string td The code php.ini file subsection that contains the directive. td A valid string. td code Language Options tr td code directive td em string td The PHP directive. td A PHP directive that you included in the code dirlist input parameter. td code engine tr td code section td em string td The code php.ini file section. td A span valid string. td code PHP tr td code reason td em string td div p A reason for failure. p This function only returns a code reason value if it failed. td p A string that describes the error. td code This is an error message. tr td code result td em Boolean td p Whether the function succeeded. td ul li code 1 — The function succeeded. li code 0 — The function failed. td code 1