ini_get

PHP 4, PHP 5, PHP 7, PHP 8
ini_get - Gets the value of a configuration option
Manual
Code Examples

ini_get( string$option ): string|false

Returns the value of the configuration option on success.

Parameters

option

The configuration option name.

Return Values

Returns the value of the configuration option as a string on success, or an empty string for null values. Returns false if the configuration option doesn't exist.

Notes

Note:
When querying boolean values

A boolean ini value of off will be returned as an empty string or "0" while a boolean ini value of on will be returned as "1". The function can also return the literal string of INI value.

Note:
When querying memory size values

Many ini memory size values, such as upload_max_filesize, are stored in the php.ini file in shorthand notation. ini_get will return the exact string stored in the php.ini file and NOT its int equivalent. Attempting normal arithmetic functions on these values will not have otherwise expected results. The example above shows one way to convert shorthand notation into bytes, much like how the PHP source does it.

Note:

ini_get can't read "array" ini options such as pdo.dsn.*, and returns false in this case.

Related Functions

  • get_cfg_var - Gets the value of a PHP configuration option
  • ini_get_all - Gets all configuration options
  • ini_restore - Restores the value of a configuration option
  • ini_set - Sets the value of a configuration option

Example of ini_get

Show all examples for ini_get

Edit/Test in Sandbox
PHP Version:


Function ini_get:

PHP Options and Information Functions

Most used PHP functions