ini_get

(PHP 4, PHP 5)

ini_get — Gets the value of a configuration option

Description

string ini_get ( string $varname )

Returns the value of the configuration option on success.

Parameters

varname: The configuration option name.

Return Values

Returns the value of the configuration option as a string on success, or an empty string on failure or for null values.

Examples

Example #1 A few ini_get() examples


<?php
/*
Our php.ini contains the following settings:

display_errors = On
register_globals = Off
post_max_size = 8M
*/

echo 'display_errors = ' . ini_get('display_errors') . "\n";
echo 'register_globals = ' . ini_get('register_globals') . "\n";
echo 'post_max_size = ' . ini_get('post_max_size') . "\n";
echo 'post_max_size+1 = ' . (ini_get('post_max_size')+1) . "\n";
echo 'post_max_size in bytes = ' . return_bytes(ini_get('post_max_size'));

function return_bytes($val) {
    $val = trim($val);
    $last = strtolower($val[strlen($val)-1]);
    switch($last) {
        // The 'G' modifier is available since PHP 5.1.0
        case 'g':
            $val *= 1024;
        case 'm':
            $val *= 1024;
        case 'k':
            $val *= 1024;
    }

    return $val;
}

?>

The above example will output something similar to:


display_errors = 1
register_globals = 0
post_max_size = 8M
post_max_size+1 = 9
post_max_size in bytes = 8388608

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 integer 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.


Concerning the value retourned, it depends on how you set it.

I had the problem with horde-3 which test the safe_mode value.

THan :

- if you set the value with php_admin_value safe_mode Off (or On) ini_get returns the string

- if you set the value with php_admin_flag safe_mode Off (or On) ini_get returns the boolean.

01-Nov-2005 09:16


Important: The manual says that ini_get will return 0 or an empty string for boolean config values that are set to off in php.ini. 



This is technically correct, however when you use 



php_value register_globals off



in an .htaccess file, ini_get will return the string, which will "evaluate" to 1. So if you are using mod_php you have to check boolean config values against the strings (upper/lowercase etc.) anyhow or you will get wrong results.

david dot tulloh at infaze dot com dot au
22-Jun-2005 05:01


You can set custom entries in the ini file to provide globals such as database details.

However these must be retrieved with get_cfg_var, ini_get won't work.

Der Graph
16-Aug-2004 09:59


It might be useful for included scripts that include other files to extend the 'include_path' variable:





<?php ini_set('include_path',ini_get('include_path').':../includes:');  ?>





Sometimes, it may also be useful to store the current 'include_path' in a variable, overwrite it, include, and then restore the old 'include_path'.

fbeyer at <nospam>clickhand dot de
13-Aug-2002 05:29


If you want to test ini flags (eg. On/Off), I recommend to explicitly cast the value returned by ini_get() to boolean - it is cleaner as you only get true or false, not 0 or 1 or "" as described above.



<?php

    $register_globals = (bool) ini_get('register_gobals');

?>



C fans may of course also cast it to (int) to play with 0 and 1 - that's also cleaner to print().

add a note

ini_restore

ini_get_all

Last updated: Fri, 05 Sep 2008