Получить заголовки ответа HttpResponse::getHeaders

Модуль: main — подключать отдельно не нужно

Метод HttpResponse::getHeaders возвращает коллекцию заголовков ответа. Методы коллекции читают, заменяют и удаляют заголовки.

Сигнатура метода в классе Bitrix\Main\HttpResponse:

public function getHeaders()

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

Метод возвращает сам объект Bitrix\Main\Web\HttpHeaders из ответа, а не его копию. Изменения в объекте сразу попадают в ответ.

Основные методы коллекции:

  • get($name, $returnArray = false) — возвращает первое значение заголовка, а при returnArray, равном true, — массив всех значений. Если заголовка нет, возвращает null,
  • set($name, $value) — заменяет значения заголовка,
  • delete($name) — удаляет заголовок,
  • getReasonPhrase() — возвращает текст статуса, например Not Found.

В цикле foreach коллекция возвращает имя заголовка и массив его значений.

Примеры

Пример. Код заменяет значение заголовка и выводит все заголовки ответа:

<?php
use Bitrix\Main\HttpResponse;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$response = new HttpResponse();
$response->addHeader('X-Unit', 'kg');
$response->getHeaders()->set('X-Unit', 'g');

foreach ($response->getHeaders() as $name => $values)
{
    echo $name . ': ' . implode(', ', $values);
}

Код выведет X-Unit: g.

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