WordPress at a glance

wp_die() WP 1.0

Kill WordPress execution and display HTML message with error message.

This function complements the die() PHP function. The difference is that HTML will be displayed to the user. It is recommended to use this function only when the execution should not continue any further. It is not recommended to call this function very often, and try to handle as many errors as possible silently or more gracefully.

As a shorthand, the desired HTTP response code may be passed as an integer to the $title parameter (the default title would apply) or the $args parameter.

  • Since 4.1.0 The $title and $args parameters were changed to optionally accept an integer to be used as the response code.
Hooks from function:
Return

Nothing (null).

Usage

wp_die( $message, $title, $args );
$message(string/WP_Error)
Error message. If this is a WP_Error object, and not an Ajax or XML-RPC request, the error's messages are used.
Default: ''
$title(string/int)
Error title. If $message is a WP_Error object, error data with the key 'title' may be used to specify the title. If $title is an integer, then it is treated as the response code.
Default: ''
$args(string/array/int)

Arguments to control behavior. If $args is an integer, then it is treated as the response code.

  • $response (int)
    The HTTP response code.
    Default: 200 for Ajax requests, 500 otherwise

  • $back_link (true/false)
    Whether to include a link to go back.
    Default: false

  • $text_direction (string)
    The text direction. This is only useful internally, when WordPress is still loading and the site's locale is not set up yet. Accepts 'rtl'.
    Default: value of is_rtl()

Default: empty array

Code of wp_die: wp-includes/functions.php VER 4.9.8

<?php
function wp_die( $message = '', $title = '', $args = array() ) {

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

	if ( wp_doing_ajax() ) {
		/**
		 * Filters the callback for killing WordPress execution for Ajax requests.
		 *
		 * @since 3.4.0
		 *
		 * @param callable $function Callback function name.
		 */
		$function = apply_filters( 'wp_die_ajax_handler', '_ajax_wp_die_handler' );
	} elseif ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) {
		/**
		 * Filters the callback for killing WordPress execution for XML-RPC requests.
		 *
		 * @since 3.4.0
		 *
		 * @param callable $function Callback function name.
		 */
		$function = apply_filters( 'wp_die_xmlrpc_handler', '_xmlrpc_wp_die_handler' );
	} else {
		/**
		 * Filters the callback for killing WordPress execution for all non-Ajax, non-XML-RPC requests.
		 *
		 * @since 3.0.0
		 *
		 * @param callable $function Callback function name.
		 */
		$function = apply_filters( 'wp_die_handler', '_default_wp_die_handler' );
	}

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

Related Functions

From tag: Supporting (helper utility auxiliary)

More from category: Uncategorized

No comments
    Hello, !     Log In . Register