Задать несколько заголовков запроса HttpClient::setHeaders

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

Метод HttpClient::setHeaders задает несколько заголовков запроса. Для каждого элемента массива метод вызывает setHeader с заменой прежнего значения.

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

public function setHeaders(array $headers)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
headers* array Задает заголовки. Ключ — имя, значение — строка

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

Метод возвращает тот же объект HttpClient.

Исключения

Исключение Когда возникает
\InvalidArgumentException Имя или значение заголовка содержит недопустимые символы

Примеры

Пример. Код задает заголовки для API:

<?php
use Bitrix\Main\Web\HttpClient;

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

$client = new HttpClient();
$client->setHeaders([
    'Accept' => 'application/json',
    'X-Api-Key' => 'units-demo-key',
]);

echo $client->getRequestHeaders()->toString();

Код выведет:

Accept: application/json
X-Api-Key: units-demo-key

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