UAPI Functions - LangPHP::php_ini_set_user_content

Description

This function changes 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_set_user_content?type=vhost&vhost=clearly.com&content=%5BPHP%5D%0D%0A%3B+About+php.ini%0D%0A%3B+php.ini+is+responsible+for+configuring+many+of+the+aspects+of+PHP%27s+behavior.%0D%0Apcre.backtrack_limit%3D100000

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Change the contents of a user's php.ini file.
$php_ini_set_user_content $cpanel->uapi(
    'LangPHP''php_ini_set_user_content',
    array(
        'type'     => 'vhost'
        'vhost'    => 'clearly.com',
        'content'  => '%5BPHP%5D%0D%0A%3B+About+php.ini%0D%0A%3B+php.ini+is+responsible+for+configuring+many+of+the+aspects+of+PHP%27s+behavior.%0D%0Apcre.backtrack_limit%3D100000'
        )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Set the contents of a user's php.ini file.
my $php_ini_set_user_content $cpliveapi->uapi(
    'LangPHP''php_ini_set_user_content',
    (
        'type'     => 'vhost',
        'vhost'    => 'clearly.com',
        'content'  => '%5BPHP%5D%0D%0A%3B+About+php.ini%0D%0A%3B+php.ini+is+responsible+for+configuring+many+of+the+aspects+of+PHP%27s+behavior.%0D%0Apcre.backtrack_limit%3D100000'
        )
);

 cPanel Template Toolkit

<!-- Get the content data. -->
[% execute('LangPHP', 'php_ini_set_user_content', {'type'     => 'vhost',
        'vhost'    => 'clearly.com',
        'content'  => '%5BPHP%5D%0D%0A%3B+About+php.ini%0D%0A%3B+php.ini+is+responsible+for+configuring+many+of+the+aspects+of+PHP%27s+behavior.%0D%0Apcre.backtrack_limit%3D100000'
           }
        )
 %]

 Command Line

<!-- Get the content data. -->
[% execute('LangPHP', 'php_ini_set_user_content', {'type'     => 'vhost',
        'vhost'    => 'clearly.com',
        'content'  => '%5BPHP%5D%0D%0A%3B+About+php.ini%0D%0A%3B+php.ini+is+responsible+for+configuring+many+of+the+aspects+of+PHP%27s+behavior.%0D%0Apcre.backtrack_limit%3D100000'
           }
        )
 %]

 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":null
}

 

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 the vhost parameter.  

  • home
  • vhost

vhost

content

string

Required

The content of the php.ini file to change.

 Any valid URL-encodedphp.ini file contents. 

 

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

This function returns only metadata. 

  • 10 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....