GET_STATUS_HEADER_DESC() │ WP 2.3.0

Функция get_status_header_desc() используется для получения описания HTTP-статуса. Давайте разберёмся, как это работает.

Зачем нужна функция?

Эта функция помогает вам узнать, что обозначает тот или иной код статуса HTTP. Она возвращает строку с описанием статуса, например, "OK" или "Not Found".

Использование функции

get_status_header_desc( $code );

• $code (int, обязательный) — это код статуса HTTP, для которого вы хотите получить описание.

Примеры использования

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

echo get_status_header_desc( 200 ); //> OK
echo get_status_header_desc( 404 ); //> Not Found
echo get_status_header_desc( 301 ); //> Moved Permanently
echo get_status_header_desc( 500 ); //> Internal Server Error

Эти примеры показывают, как получить описания некоторых распространённых кодов статусов.

2. Обработка ошибок при загрузке

Если ваш код работает с загрузкой медиафайлов, вы можете использовать get_status_header_desc() для возврата ошибки:

function upload_handler( $update_media_item = false ) {
    if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
        return new WP_Error( 405, get_status_header_desc( 405 ), 405 );
    }

    if ( ! is_user_logged_in() ) {
        return new WP_Error( 403, get_status_header_desc( 403 ), 403 );
    }

    // Здесь можно добавить код обработки загрузки
}

3. Возврат ошибки, если код не 200

Если ваш код делает запрос по удалённому URL и получает статус, отличный от 200, можно вернуть ошибку:

if ( $code !== 200 ) {
    unlink( $upload['file'] );

    return new WP_Error(
        'import_file_error',
        sprintf(
            __( 'Удалённый сервер вернул %1$d %2$s для %3$s', 'wordpress-importer' ),
            $code,
            get_status_header_desc( $code ),
            $url
        )
    );
}

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

Функция возвращает строку с описанием статуса, если он найден, или пустую строку, если статус неизвестен.

Статусы HTTP

Вот список основных кодов статусов, которые поддерживает WordPress:

Заключение

Функция get_status_header_desc() полезна для разработки и отладки. Она предоставляет информативные описания статусов, которые могут помочь в анализе ответов от сервера. Используйте её в своих проектах WordPress для улучшения обработки ошибок и ясности кода.

Примечания

• Глобальный массив $wp_header_to_desc используется для хранения описаний статусов.
• Функция была добавлена в версии 2.3.0 и с тех пор обновлялась для добавления новых статус-кодов.

Эта информация должна помочь вам использовать функцию get_status_header_desc() эффективно и понятно!