getenv

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

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

Описание

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

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

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

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

name

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

local_only

Если установлено значение true, возвращаются только локальные переменные окружения, установленные операционной системой или командой putenv. Это имеет значение только в том случае, если параметр name является строкой (string).

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

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

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

Версия Описание
8.0.0 Параметр name теперь допускает значение null.
7.1.0 Параметр name теперь может быть опущен для получения ассоциативного массива (array) всех переменных окружения.
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 для получения установленных локально переменных.

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