WordPress.org

Function Reference/wp die

Description

Kill WordPress execution and display HTML message with error message.

A call to 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 siliently.

Usage

<?php wp_die( $message, $title, $args ) ?>

Parameters

$message

(mixed) (required) Error message or a complete WP_Error object.

Default: None

$title

(string) (optional) Error title, If you use a WP_Error object, the title will be by default the one you added in $data['title'].

Default: ''

$args

(string|array) (optional) Optional arguments to control behaviour.

Default: None

Arguments

response

(integer) (optional) HTML status code returned.

Default: 500

back_link

(boolean) (optional) Whether to display a back link in the returned page.

Default: false

text_direction

(string) (optional) Whether to set ltr or rtl as the text direction

Default: ltr

Return Values

(void): This function does not return a value.

Examples

Test to see what is in the $post variable in a filter:

add_filter( 'body_class', 'add_body_class_cb' );
/**
 * Add new body class.
 *
 * Testing what is in the $post variable.
 */
function add_body_class_cb( $classes ) {
    global $post;

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

Notes

Uses global: (object) $wp_locale Handles the date and time locales.

You can add a WP_Error object. If you've done so, you can add $data['title'] to the error object and it will automatically be taken as (default/overwriteable) title for the die page.

[example missing here]

Change Log

Since: 2.0.4

Source File

wp_die() is located in wp-includes/functions.php.

WordPress.org

Codex