wp_die() WP 2.0.4

Зупиняє виконання PHP скрипта та виводить відформатоване HTML повідомлення.

Аналог базової функції PHP die(). Різниця в тому, що wp_die() виводить відформатовану сторінку HTML помилки. Рекомендується використовувати цю функцію, коли потрібно повністю припинити роботу PHP. Не рекомендується користуватися цією функцією часто – намагайтеся не показувати помилки користувачам.

З версії 5.3 повідомлення обрамляється тегом <div class="wp-die-message">, а чи не <p>. Таким чином, в нього можна вкладати інші блокові елементи (наприклад, <h1> ) і є зручна можливість стилізувати блок через CSS.

Повертає

null. Нічого не повертає, а обриває роботу PHP.

Використання

wp_die($message, $title, $args);
$message
(змішаний)
Повідомлення про помилку або повний об’єкт класу WP_Error.


За замовчуванням: ”
$title
(рядок/масив/число/об’єкт/логічний)
Заголовок помилки. Якщо використовуєте об’єкт WP_Error, то заголовок буде взято з
$ data[‘title’] , цей параметр можна заздалегідь змінити під себе.


За замовчуванням: ”
$args
(рядок/масив)

Різні аргументи контролюють поведінку. _wp_die_process_input () .

$defaults = array(
	'response' => 0,
	'code' => '',
	'exit' => true,
	'back_link' => false,
	'link_url' => '',
	'link_text' => '',
	'text_direction' => '',
	'charset' => 'utf-8',
	'additional_errors' => array(),
);
  • response (число)
    Код стану HTTP. 500 – внутрішня помилка сервера. Весь список дивіться тут .
    Типово: 500

  • back_link (логічний)
    Виводити чи ні зворотне посилання на попередню сторінку.
    Типово: false

  • text_direction (рядок)
    Напрямок тексту: ltr (зліва направо) або rtl (справа наліво).
    За замовчуванням: ‘ltr’

  • link_url (рядок) (WP 5.1)
    URL посилання, яке буде додано до повідомлення (message). Використовується разом із link_text .
    За замовчуванням: ”

  • link_text (рядок) (WP 5.1)
    Текст (анкор) посилання, яке буде додано до повідомлення (message). Використовується разом із link_url .
    За замовчуванням: ”

  • exit (true/false) (WP 5.1)
    Чи потрібно переривати роботу die() .
    За замовчуванням:

  • charset (рядок) (WP 5.3)
    Кодування.
    За замовчуванням: ‘utf-8’

За замовчуванням: array()

Приклади

0

#1 Демонстрація використання

Використовуючи функцію wp_die() , подивимося, що знаходиться в глобальній змінній $post в даний момент:

add_filter( 'body_class', 'add_body_class_cb');
function add_body_class_cb( $classes ) {
	global $post;

	wp_die( '<pre>' . var_export( $post, true ) . '</pre>' );
}
0

#2 Стилізація wp_die блоку

Якщо на сайті потрібно змінити дизайн цього блоку, можна скористатися хуком wp_die_handler :

<?php

## Замінимо назву функції обробника блоку wp_die
add_filter( 'wp_die_handler', function(){
	return 'my_wp_die_handler';
});

## Функція обробника блоку wp_die.
## На основі функції https://wp-doc.com/function/_default_wp_die_handler
function my_wp_die_handler( $message, $title = '', $args = array() ){

	$defaults = array( 'response' => 500);
	$r = wp_parse_args($args, $defaults);

	$have_gettext = function_exists('__');

	if ( function_exists( 'is_wp_error' ) && is_wp_error( $message ) ) {
		if (empty($title)) {
			$error_data = $message->get_error_data();
			if ( is_array( $error_data ) && isset( $error_data['title'] ) )
				$title = $error_data['title'];
		}
		$errors = $message->get_error_messages();
		switch ( count ( $ errors ) ) {
		case 0 :
			$message = '';
			break;
		case 1 :
			$message = "<p>{$errors[0]}</p>";
			break;
		default :
			$message = "<ul>ntt<li>" . join( "</li>ntt<li>", $errors ) . "</li>nt</ul>";
			break;
		}
	} elseif ( is_string( $message ) ) {
		$message = "<p>$message</p>";
	}

	if ( isset( $r['back_link'] ) && $r['back_link'] ) {
		$back_text = $have_gettext? __('«Back') : '«Back';
		$message .= "n<p><a href='javascript:history.back()'>$back_text</a></p>";
	}

	if ( ! did_action( 'admin_head' ) ) :
		if ( !headers_sent() ) {
			status_header ($ r ['response']);
			nocache_headers();
			header( 'Content-Type: text/html; charset=utf-8');
		}

		if ( empty($title) )
			$title = $have_gettext? __('WordPress › Error') : 'WordPress › Error';

		$text_direction = 'ltr';
		if ( isset($r['text_direction']) && 'rtl' == $r['text_direction'] )
			$text_direction = 'rtl';
		elseif ( function_exists( 'is_rtl' ) && is_rtl() )
			$text_direction = 'rtl';
?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" <?php if ( function_exists( 'language_attributes' ) && function_exists( 'is_rtl' ) ) language_attributes(); else echo "dir='$text_direction'"; ?>>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="viewport" content="width=device-width">
	<?php
	if ( function_exists( 'wp_no_robots' ) ) {
		wp_no_robots();
	}
	?>
	<title><?php echo $title ?></title>
	<style type="text/css">
		html {
			background: #f1f1f1;
		}
		body {
			background: #fff;
			color: #444;
			font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;
			margin: 2em auto;
			padding: 1em 2em;
			max-width: 700px;
			-webkit-box-shadow: 0 1px 3px rgba(0,0,0,0.13);
			box-shadow: 0 1px 3px rgba(0,0,0,0.13);
		}
		h1 {
			border-bottom: 1px solid #dadada;
			clear: both;
			color: #666;
			font-size: 24px;
			margin: 30px 0 0 0;
			padding: 0;
			padding-bottom: 7px;
		}
		#error-page {
			margin-top: 50px;
		}
		#error-page p {
			font-size: 14px;
			line-height: 1.5;
			margin: 25px 0 20px;
		}
		#error-page code {
			font-family: Consolas, Monaco, monospace;
		}
		ul li {
			margin-bottom: 10px;
			font-size: 14px;
		}
		a {
			color: #0073aa;
		}
		a:hover,
		a:active {
			color: #00a0d2;
		}
		a:focus {
			color: #124964;
			-webkit-box-shadow:
				0 0 0 1px #5b9dd9,
				0 0 2px 1px rgba(30, 140, 190, .8);
			box-shadow:
				0 0 0 1px #5b9dd9,
				0 0 2px 1px rgba(30, 140, 190, .8);
			outline: none;
		}
		.button {
			background: #f7f7f7;
			border: 1px solid #ccc;
			color: #555;
			display: inline-block;
			text-decoration: none;
			font-size: 13px;
			line-height: 26px;
			height: 28px;
			margin: 0;
			padding: 0 10px 1px;
			cursor: pointer;
			-webkit-border-radius: 3px;
			-webkit-appearance: none;
			border-radius: 3px;
			white-space: nowrap;
			-webkit-box-sizing: border-box;
			-moz-box-sizing: border-box;
			box-sizing: border-box;

			-webkit-box-shadow: 0 1px 0 #ccc;
			box-shadow: 0 1px 0 #ccc;
			vertical-align: top;
		}

		.button.button-large {
			height: 30px;
			line-height: 28px;
			padding: 0 12px 2px;
		}

		.button:hover,
		.button:focus {
			background: #fafafa;
			border-color: #999;
			color: #23282d;
		}

		.button:focus {
			border-color: #5b9dd9;
			-webkit-box-shadow: 0 0 3px rgba(0, 115, 170, .8);
			box-shadow: 0 0 3px rgba(0, 115, 170, .8);
			outline: none;
		}

		.button:active {
			background: #eee;
			border-color: #999;
			-webkit-box-shadow: inset 0 2px 5px -3px rgba(0, 0, 0, 0.5);
			box-shadow: inset 0 2px 5px -3px rgba(0, 0, 0, 0.5);
			-webkit-transform: translateY(1px);
			-ms-transform: translateY(1px);
			transform: translateY(1px);
		}

		<?php
		if ( 'rtl' == $text_direction ) {
			echo 'body { font-family: Tahoma, Arial; }';
		}
		?>
	</style>
</head>
<body id="error-page">
<?php endif; //! did_action( 'admin_head' ) ?>
	<?php echo $message; ?>
</body>
</html>
<?php
	die();
}

нотатки

  • Global. WP_Query. $wp_query WordPress Query object.

список змін

З версії 2.0.4Введено.
З версії 4.1.0$title and $args parameters були змінені, щоб optionally accept integer to be used as the response code.
З версії 5.1.0$link_url , $ link_text , і $exit arguments були added.
З версії 5.3.0The $charset argument був added.
З версії 5.5.0У $text_direction argument є priority over get_language_attributes() в послідовному handler.

Код wp_die() WP 6.0.2

function wp_die( $message = '', $title = '', $args = array() ) {
	global $wp_query;

	if ( is_int( $args ) ) {
		$args = array( 'response' => $args );
	} elseif (is_int($title)) {
		$args = array( 'response' => $title);
		$title = '';
	}

	if ( wp_doing_ajax() ) {
		/**
		 * Filters callback for killing WordPress execution for Ajax requests.
		 *
		 * @ Since 3.4.0
		 *
		 * @param callable $callback Callback function name.
		 */
		$callback = apply_filters( 'wp_die_ajax_handler', '_ajax_wp_die_handler' );
	} elseif (wp_is_json_request()) {
		/**
		 * Filters callback for killing WordPress execution для JSON requests.
		 *
		 * @ Since 5.1.0
		 *
		 * @param callable $callback Callback function name.
		 */
		$callback = apply_filters( 'wp_die_json_handler', '_json_wp_die_handler' );
	} elseif ( defined( 'REST_REQUEST' ) && REST_REQUEST && wp_is_jsonp_request() ) {
		/**
		 * Filters callback for killing WordPress execution для JSONP REST requests.
		 *
		 * @ Since 5.2.0
		 *
		 * @param callable $callback Callback function name.
		 */
		$callback = apply_filters( 'wp_die_jsonp_handler', '_jsonp_wp_die_handler' );
	} elseif ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) {
		/**
		 * Filters callback for killing WordPress execution for XML-RPC requests.
		 *
		 * @ Since 3.4.0
		 *
		 * @param callable $callback Callback function name.
		 */
		$callback = apply_filters( 'wp_die_xmlrpc_handler', '_xmlrpc_wp_die_handler' );
	} elseif ( wp_is_xml_request()
		|| isset( $wp_query ) &&
			( function_exists( 'is_feed' ) && is_feed()
			|| function_exists( 'is_comment_feed' ) && is_comment_feed()
			|| function_exists( 'is_trackback' ) && is_trackback() ) ) {
		/**
		 * Filters callback for killing WordPress execution for XML requests.
		 *
		 * @ Since 5.2.0
		 *
		 * @param callable $callback Callback function name.
		 */
		$callback = apply_filters( 'wp_die_xml_handler', '_xml_wp_die_handler' );
	} else {
		/**
		 * Filters callback for killing WordPress execution для all non-Ajax, non-JSON, non-XML requests.
		 *
		 * @ Since 3.0.0
		 *
		 * @param callable $callback Callback function name.
		 */
		$callback = apply_filters( 'wp_die_handler', '_default_wp_die_handler' );
	}

	call_user_func($callback, $message, $title, $args);
}

Залишити відповідь

Ваша e-mail адреса не оприлюднюватиметься. Обов’язкові поля позначені *