• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/wp die

提供: WordPress Codex 日本語版
移動先: 案内検索

説明

WordPress の処理を中断し、条件つきのエラーメッセージを HTML で出力します。

この関数は PHP 関数である die() を補完します。die() との違いは、典型的なリクエストが発生した場合、ユーザーに対し HTML が表示されることにあります。この関数は、これ以上継続すべきでない処理がある場合のみ使用を推奨します。この関数を頻繁に呼び出したり、大量のエラーをユーザーの見えない範囲で処理する行為は推奨しません。

もし本当に何も出力することなく処理を停止(および応答タイムアウト)させたい場合は exit; を使用してください。これは die() の今風バージョンです。wp_die() 関数は空の応答やタイムアウトを避けるために、本当に終了する直前に出力を実行するよう設計されています。

使い方

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

パラメータ

$message
mixed) (オプション) エラーメッセージまたは完全な WP_Error オブジェクト。
初期値: なし
$title
文字列) (オプション) エラーのタイトル。もし WP_Error オブジェクトを使うとタイトルのデフォルトは $data['title'] になる。(DOING_AJAX が true の場合は無視される。)
初期値: ''
$args
文字列|配列) (オプション) 動作を制御するオプションの引数(DOING_AJAX が true の場合は無視される)。
初期値: なし

引数

response
整数) (オプション) この HTML ステータスコードを返します。
初期値: 500
back_link
真偽値) (オプション) 返されるページでバックリンクを表示するかどうか。
初期値: false – 表示しない
text_direction
文字列) (オプション) テキスト方向。ltr(左から右)または rtl(右から左)。
初期値: 'ltr'

返り値

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

用例

テストを目的として、あるフィルターの中で $post 変数の内容を確かめます:

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

情報募集中 WP_Error オブジェクトの用例が不足しています。 該当部分を編集するか、このページのノートまたはフォーラム等で教えてください。


参考

  • この関数は apply_filters() を使用して、die 処理のハンドラー関数名をフィルターします:
    • 'wp_die_ajax_handler' - DOING_AJAX 定数が true のときデフォルトの AJAX die ハンドラー関数('_ajax_wp_die_handler')に適用。
    • 'wp_die_xmlrpc_handler' - XMLRPC_REQUEST 定数が true のときデフォルトの XML-RPC die ハンドラー関数('_xmlrpc_wp_die_handler')に適用。
    • 'wp_die_handler' - 上記を除くすべての場合、デフォルトの die ハンドラー関数('_default_wp_die_handler')に適用。
  • WP_Error オブジェクトを追加できます。そのときエラーオブジェクトに $data['title'] を入れておけば、自動的に最後のエラーページ(die ページ)のタイトル(デフォルト/上書き可能)になります。

変更履歴

ソースファイル

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

関連


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


最新英語版: WordPress Codex » Function_Reference/wp_die最新版との差分