ini_get

(PHP 4, PHP 5, PHP 7, PHP 8)

ini_get — Получает значение настройки конфигурации

Описание

ini_get(string $option): string|false

Функция в случае успешного выполнения возвращает значение настройки конфигурации.

Список параметров

option: Имя настройки конфигурации.

Возвращаемые значения

Функция возвращает значение настройки конфигурации в виде строки. Для значений null будет возвращаться пустая строка. Функция вернёт false, если настройка не существует.

Примеры

Пример #1 Несколько примеров использования функции ini_get()

<?php

/*
Наш файл php.ini содержит следующие настройки:

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) {
        // Модификатор 'G' доступен
        case 'g':
            $val *= 1024;
        case 'm':
            $val *= 1024;
        case 'k':
            $val *= 1024;
    }

    return $val;
}

?>

Вывод приведённого примера будет похож на:

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

Примечания

Замечание: Возвращаемые логические значения

Логическое значение ini-настройки off возвращается в виде пустой строки или строки "0", в то время как значению on будет соответствовать строка "1". Функция также умеет возвращать сороковый литерал значения INI-настройки.

Замечание: Возвращаемые значения количества памяти

Многие ini-настройки, значения которых измеряются количеством памяти, например директива upload_max_filesize, сохраняются в файле php.ini в сокращённом виде. Функция ini_get() вернёт именно то, что записано в файле php.ini, а НЕ целочисленный (int) эквивалент этой величины. Попытка использовать полученную величину в арифметических операциях не даст желаемого результата. Приведённый пример показывает, как перевести сокращённую запись в число байтов.

Замечание:
Функция ini_get() не умеет читать опции типа «массив» наподобие pdo.dsn.* и возвращает для таких знаний false.

Смотрите также

get_cfg_var() - Извлекает значение настройки конфигурации PHP
ini_get_all() - Получает все настройки конфигурации
ini_restore() - Восстанавливает значение настройки конфигурации
ini_set() - Устанавливает значение настройки конфигурации