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 = ' . (int) ini_get('register_globals') . "\n";
echo 'post_max_size = ' . ini_get('post_max_size') . "\n";
echo 'post_max_size + 1 = ' . (rtrim(ini_get('post_max_size'), 'KMG') + 1) . "\n";
echo 'post_max_size in bytes = ' . return_bytes(ini_get('post_max_size'));

function return_bytes($val)
{
    $val = trim($val);
    $num = (int) rtrim($val, 'KMG');
    $last = strtolower($val[strlen($val) - 1]);

    switch ($last) {
        // Модификатор 'G' доступен
        case 'g':
            $num = $num * 1024 * 1024 * 1024;
            break;
        case 'm':
            $num = $num * 1024 * 1024;
            break;
        case 'k':
            $num *= 1024;
            break;
    }

    return $num;
}

?>

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

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

Примечания

Замечание: Логические значения

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

Замечание: Значения размера памяти

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

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

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

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