wp_die()

Завершает выполнение WordPress и отображает HTML-страницу с сообщением об ошибке
Функция WordPress
INT 2.0.4
WordPress Icon

Описание функции

Функция wp_die() используется для прекращения выполнения WordPress и отображения HTML-страницы с сообщением об ошибке. Она убивает выполнение WordPress и выводит страницу с сообщением об ошибке.

Использование

wp_die( string|WP_Error $message = '', string|int $title = '', string|array|int $args = array() )

Функция wp_die() принимает три параметра: $message, $title и $args. Они определяют сообщение об ошибке, заголовок ошибки и дополнительные аргументы для управления поведением функции.

  • $message (строка|WP_Error, необязательно): Сообщение об ошибке. Если это объект WP_Error и не является запросом Ajax или XML-RPC, то используются сообщения об ошибке. По умолчанию: пустая строка.
  • $title (строка|число, необязательно): Заголовок ошибки. Если $message является объектом WP_Error, то данные об ошибке с ключом ‘title’ могут использоваться для указания заголовка. Если $title является числом, то оно рассматривается как код ответа. По умолчанию: пустая строка.
  • $args (строка|массив|число, необязательно): Аргументы для управления поведением. Если $args является числом, то оно рассматривается как код ответа. Возможные параметры:
    • response (число): Код ответа HTTP. По умолчанию 200 для запросов Ajax, 500 в противном случае.
    • link_url (строка): URL для включения ссылки. Работает только в сочетании с link_text. По умолчанию: пустая строка.
    • link_text (строка): Метка для включения ссылки. Работает только в сочетании с link_url. По умолчанию: пустая строка.
    • back_link (логическое): Определяет, нужно ли включать ссылку для возврата. По умолчанию: false.
    • text_direction (строка): Направление текста. Полезно только внутренне, когда WordPress еще загружается и локаль сайта еще не настроена. Принимает значения ‘rtl’ и ‘ltr’. По умолчанию: значение функции is_rtl().
    • charset (строка): Набор символов для HTML-вывода. По умолчанию: ‘utf-8’.
    • code (строка): Код ошибки для использования. По умолчанию: ‘wp_die’, или основной код ошибки, если $message является объектом WP_Error.
    • exit (логическое): Определяет, нужно ли завершить процесс после выполнения функции. По умолчанию: true.

// Пример использования функции wp_die()
$message = 'Произошла ошибка!';
$title = 'Ошибка';
$args = array(
  'response' => 500,
  'link_url' => 'https://example.com',
  'link_text' => 'Подробнее',
  'back_link' => true,
  'text_direction' => 'ltr',
  'charset' => 'utf-8',
  'code' => 'custom_error_code',
  'exit' => true
);
wp_die( $message, $title, $args );

В этом примере функция wp_die() вызывается с сообщением об ошибке «Произошла ошибка!», заголовком «Ошибка» и дополнительными аргументами для управления поведением функции. Код ответа HTTP установлен на 500, включена ссылка на https://example.com с меткой «Подробнее», добавлена ссылка для возврата, направление текста установлено на «ltr», набор символов установлен на «utf-8», код ошибки установлен на «custom_error_code» и процесс завершается после выполнения функции.

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

Прерывание выполнения и отображение сообщения об ошибке


// Пример использования функции wp_die() с сообщением об ошибке
$message = 'Произошла ошибка!';
wp_die( $message );

Функция wp_die() используется для прерывания выполнения WordPress и отображения HTML-страницы с сообщением об ошибке. В примере выше, переменная $message содержит текст сообщения об ошибке. После вызова функции wp_die(), выполнение скрипта будет прервано и пользователю будет показана страница с указанным сообщением.

Установка HTTP-кода ответа и отображение ссылки


// Пример использования функции wp_die() с HTTP-кодом ответа и ссылкой
$message = 'Произошла ошибка!';
$response_code = 404;
$link_url = 'https://example.com';
$link_text = 'Перейти на сайт';
$args = array(
    'response' => $response_code,
    'link_url' => $link_url,
    'link_text' => $link_text
);
wp_die( $message, '', $args );

В данном примере, помимо сообщения об ошибке, мы также устанавливаем HTTP-код ответа на 404 и добавляем ссылку на внешний сайт. Параметры response, link_url и link_text передаются в виде ассоциативного массива $args. После вызова функции wp_die(), страница с сообщением об ошибке будет содержать указанный HTTP-код и ссылку.

Включение обратной ссылки для навигации


// Пример использования функции wp_die() с обратной ссылкой
$message = 'Произошла ошибка!';
$back_link = true;
wp_die( $message, '', $back_link );

В данном примере, помимо сообщения об ошибке, мы также включаем обратную ссылку для навигации. Параметр back_link устанавливается в значение true. После вызова функции wp_die(), страница с сообщением об ошибке будет содержать ссылку для возврата на предыдущую страницу.

Установка направления текста


// Пример использования функции wp_die() с установкой направления текста
$message = 'Произошла ошибка!';
$text_direction = 'rtl';
wp_die( $message, '', '', $text_direction );

В данном примере, помимо сообщения об ошибке, мы также устанавливаем направление текста на «rtl» (справа налево). Параметр text_direction устанавливается в значение 'rtl'. После вызова функции wp_die(), страница с сообщением об ошибке будет отображаться справа налево.

Установка кодировки символов и кода ошибки


// Пример использования функции wp_die() с установкой кодировки символов и кода ошибки
$message = 'Произошла ошибка!';
$charset = 'windows-1251';
$code = 'custom_error_code';
wp_die( $message, '', '', '', $charset, $code );

В данном примере, помимо сообщения об ошибке, мы также устанавливаем кодировку символов на «windows-1251» и код ошибки на «custom_error_code». Параметры charset и code передаются напрямую в функцию wp_die(). После вызова функции wp_die(), страница с сообщением об ошибке будет отображаться с указанной кодировкой символов и кодом ошибки.

Выход из процесса после завершения


// Пример использования функции wp_die() с выходом из процесса после завершения
$message = 'Произошла ошибка!';
$exit = false;
wp_die( $message, '', '', '', '', '', $exit );

В данном примере, помимо сообщения об ошибке, мы также отключаем выход из процесса после завершения. Параметр exit устанавливается в значение false. После вызова функции wp_die(), скрипт будет продолжать выполнение после отображения страницы с сообщением об ошибке.

Вопросы и ответы

Как изменить текст сообщения об ошибке?

Функция wp_die() используется для завершения выполнения WordPress и отображения HTML-страницы с сообщением об ошибке. По умолчанию, текст сообщения об ошибке пустой.

Чтобы изменить текст сообщения об ошибке, вы можете передать строку с сообщением в качестве параметра $message при вызове функции wp_die().

Пример:


wp_die( 'Это сообщение об ошибке.' );

Как изменить заголовок сообщения об ошибке?

Заголовок сообщения об ошибке по умолчанию также пустой.

Чтобы изменить заголовок сообщения об ошибке, вы можете передать строку или целое число в качестве параметра $title при вызове функции wp_die().

Пример:


wp_die( 'Это сообщение об ошибке.', 'Заголовок ошибки' );

Как изменить HTTP-код ответа?

HTTP-код ответа по умолчанию равен 200 для Ajax-запросов и 500 для остальных случаев.

Чтобы изменить HTTP-код ответа, вы можете передать целое число в качестве параметра $args при вызове функции wp_die().

Пример:


wp_die( 'Это сообщение об ошибке.', 'Заголовок ошибки', 404 );

Как добавить ссылку на страницу в сообщение об ошибке?

Для добавления ссылки на страницу в сообщение об ошибке используйте параметры link_url и link_text функции wp_die().


$message = 'Ошибка! Нажмите на ссылку для перехода на главную страницу.';
$link_url = home_url();
$link_text = 'Главная страница';
wp_die( $message, '', array(
    'link_url'  => $link_url,
    'link_text' => $link_text,
) );

Как добавить обратную ссылку в сообщение об ошибке?

Для добавления обратной ссылки в сообщение об ошибке используйте параметр back_link функции wp_die().


$message = 'Ошибка! Нажмите на ссылку для возврата на предыдущую страницу.';
wp_die( $message, '', array(
    'back_link' => true,
) );

Как изменить направление текста в сообщении об ошибке?

Для изменения направления текста в сообщении об ошибке используйте параметр text_direction функции wp_die().


$message = 'Ошибка! Текст сообщения справа налево.';
wp_die( $message, '', array(
    'text_direction' => 'rtl',
) );

Как изменить кодировку HTML-вывода в сообщении об ошибке?

Для изменения кодировки HTML-вывода в сообщении об ошибке используйте параметр charset функции wp_die().


$message = 'Ошибка! Кодировка сообщения windows-1251.';
wp_die( $message, '', array(
    'charset' => 'windows-1251',
) );

Функция wp_die() в WordPress используется для прекращения выполнения кода и отображения страницы с сообщением об ошибке. Она позволяет добавлять ссылки на страницы, обратные ссылки, изменять направление текста и кодировку HTML-вывода в сообщении об ошибке.

Связанные элементы

  • Хук wp_die_ajax_handler: позволяет изменить функцию, которая обрабатывает вывод ошибок Ajax, вызываемых функцией wp_die.
  • Хук wp_die_handler: позволяет изменить функцию, которая обрабатывает вывод ошибок, вызываемых функцией wp_die.
  • Хук wp_die_xmlrpc_handler: позволяет изменить функцию, которая обрабатывает вывод ошибок XML-RPC, вызываемых функцией wp_die.
  • Класс WP_Error: представляет объект ошибки, содержащий коды и сообщения ошибок.
Обсуждение