getenv

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

    getenv — Получает значение одной или всех переменных окружения

    Описание

    getenv(?string$name = null, bool$local_only = false): string|array|false

    Функция получает значение одной или всех переменных окружения.

    Список переменных окружения также выводит функция phpinfo(). Многие из этих переменных описывает раздел 4.1. Request Meta-Variables стандарта » RFC 3875.

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

    name

    Имя переменной в виде строки (string) или null.

    local_only

    Функция возвращает только локальные переменные окружения, которые установила операционная система или команда putenv, если для этого параметра установили значение true. Параметр повлияет на результат работы функции, только если значение параметра name — строка (string).

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

    Функция возвращает значение переменной окружения name или false, если переменная окружения name не существует. Если значение параметра name равно null, функция возвращает все переменные окружения в виде ассоциативного массива (array).

    Список изменений

    ВерсияОписание
    8.0.0 Параметр name теперь принимает значение null.
    7.1.0 Теперь, чтобы получить ассоциативный массив (array) всех переменных окружения, параметр name можно не указывать.
    7.0.9 Добавлен параметр local_only.

    Примеры

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

    <?php

    // Пример вызова функции getenv()
    $ip = getenv('REMOTE_ADDR');

    // Или просто получаем значение из суперглобальной переменной $_SERVER или $_ENV
    $ip = $_SERVER['REMOTE_ADDR'];

    // Надёжно получаем значение переменной окружения независимо от того,
    // установили ли или нет значение через интерфейс SAPI или изменили командой putenv
    $ip = getenv('REMOTE_ADDR', true) ?: getenv('REMOTE_ADDR');

    ?>

    Примечания

    Внимание

    Если PHP запустили через интерфейс SAPI наподобие Fast CGI, эта функция будет возвращать значения переменных окружения, которые установили через SAPI, даже если локальную переменную с таким же именем установили функцией putenv(). Устанавливайте параметр local_only, чтобы функция возвращала значение локальных переменных окружения.

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

    To Top