Задать статус ответа HttpResponse::setStatus

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

Метод HttpResponse::setStatus задает статус ответа и возвращает тот же объект. Метод сохраняет код и текст статуса в коллекции заголовков.

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

public function setStatus($status)

Параметры

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

Параметр Тип Описание
status* string или int Задает код статуса и необязательный текст через пробел, например '404 Not Found' или 404

Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.

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

Метод возвращает текущий объект.

Если строка не начинается с цифр, метод не меняет статус и не выбрасывает исключение. Метод не проверяет код и принимает любое число.

Метод writeHeaders отправляет статус строкой протокола, например HTTP/1.1 404 Not Found. В режиме CGI без настройки http_status в конфигурации ядра метод отправляет заголовок Status: 404 Not Found.

Примеры

Пример. Код задает статус «не найдено» и выводит код и текст статуса:

<?php
use Bitrix\Main\HttpResponse;

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

$response = new HttpResponse();
$response->setStatus('404 Not Found');

echo $response->getStatus() . ' ' . $response->getHeaders()->getReasonPhrase();

Код выведет 404 Not Found.

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