関数リファレンス/wp die

提供: WordPress Codex 日本語版
< 関数リファレンス
2015年6月10日 (水) 00:35時点におけるMiccweb (トーク | 投稿記録)による版 (新規作成)

(差分) ← 古い版 | 最新版 (差分) | 新しい版 → (差分)
移動先: 案内検索

説明

WordPressのエラー画面にメッセージをHTMLで表示する。

Kill WordPress execution and conditionally 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 in the case of a typical web request. 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.

If you really want to stop execution and exit the PHP script without outputting anything (and let the response time out) use exit;, the modern version of die(). The function wp_die() is designed to give output just before it dies to avoid empty or time-outing responses.

使い方

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

パラメータ

$message
mixed) (オプション) エラーメッセージまたは a complete WP_Errorオブジェクト。
初期値: なし
$title
string) (オプション) Error title, If you use a WP_Error object, the title will be by default the one you added in $data['title'] (ignored when DOING_AJAX is true).
初期値: ''
$args
string|array) (オプション) Optional arguments to control behavior (ignored when DOING_AJAX is true).
初期値: なし

引数

response
integer) (オプション) HTML ステータスコードを返します。
初期値: 500
back_link
boolean) (オプション) Whether to display a back link in the returned page.
初期値: false
text_direction
文字列) (オプション) Whether to set ltr or rtl as the text direction
初期値: 'ltr'

返り値

(void) 
この関数は値を返しません。

用例

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>' );
}


  • Uses: apply_filters() - To filter the name of the die handler function:
    • Calls 'wp_die_ajax_handler' with the default AJAX die handler function ('_ajax_wp_die_handler') if the DOING_AJAX constant is set to true.
    • Calls 'wp_die_xmlrpc_handler' with the default XML-RPC die handler function ('_xmlrpc_wp_die_handler') if the XMLRPC_REQUEST constant is set to true.
    • Calls 'wp_die_handler' in every other case, with the default die handler function ('_default_wp_die_handler').
  • 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]

更新履歴

ソースファイル

wp_die()wp-includes/functions.phpにあります。

関連


関数リファレンステンプレートタグ目次もご覧ください。


このページ「関数リファレンス/wp die」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

最新英語版: WordPress Codex » Function Reference/get_adjacent_post最新版との差分