UAPI Functions - LangPHP::php_ini_get_user_content

Description

This function returns the contents of a virtual host's php.ini file.

Note:

This document only applies to systems that run EasyApache 4.

 

Examples 


 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/LangPHP/php_ini_get_user_content?type=vhost&vhost=clearly.com

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Retrieve the contents of a user's php.ini file.
$php_ini_get_user_content $cpanel->uapi(
    'LangPHP''php_ini_get_user_content',
    array(
        'type'     => 'vhost'
        'vhost'   => 'clearly.com',
        )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Retrieve the contents of a user's php.ini file.
my $php_ini_get_user_content $cpliveapi->uapi(
    'LangPHP''php_ini_get_user_content',
    (
        'type'     => 'vhost',
        'vhost'   => 'clearly.com',
        )
);

 cPanel Template Toolkit

<!-- Get a hash of the content data. -->
[% execute('LangPHP', 'php_ini_get_user_content', 
{
        'type' => 'vhost',
        'vhost' => 'clearly.com', 
     }
);
 %]

 Command Line

uapi --user=username LangPHP php_ini_get_user_content type=vhost vhost=clearly.com

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

{
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{
      "LangPHP":{
         "vhost":"clearly.com",
         "phpversion":"ea-php55",
         "type":"vhost",
         "path":"/home/allthethings/public_html/php.ini"
      }
   },
   "data":{
      "content":"allow_url_fopen = On\nallow_url_include = On\nasp_tags = Off\ndisplay_errors = On\nenable_dl = Off\nfile_uploads = On\ninclude_path = &quot;.;/path/to/php/pear&quot;\nmax_execution_time = 30\nmax_input_time = 60\nmax_input_vars = 1050\nmemory_limit = 32M\nupload_max_filesize = 2M\n"
   }
}

Note:

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

 

Parameters

 Parameter 

Type

Description

Possible values

Example

type

 string 

Required

The type of php.ini file.

Important:

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

  • home
  • vhost

vhost

vhost

string

The name of a virtual host.

Important:

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

 A virtual host on the system. 

 clearly.com 

 

Returns

Return
Type
Description
Possible values
Example

content

string The contents of the requested user's php.ini file.

A list of PHP directives.

 Click to view...
  • 4 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....