wp_die

（2.0.4以降）
wp_die - エラーメッセージを表示する

説明

void wp_die( string | WP_Error $message [ , string | int $title = '' [ , mixed $args = array() ] ] )
エラーメッセージ（ページ）を表示する。

パラメータ

  • $message
    エラーメッセージ。
  • $title
    ページタイトル（省略時は''）。
  • $args
    エラー処理を行う関数へ渡すパラメータ（省略時は空の配列）。

返り値

返り値はありません。

注意

テーマやプラグインにおいて、リクエストされたページを正常に表示（出力）できない場合に使用する。この関数が呼び出されると、リクエストされたページに関わらず強制的にエラーメッセージページを表示し、それ以降のプログラム（PHPスクリプト）は実行されない。

[5.1.0]第3パラメータ$argsが連想配列の場合、'link_url'、'link_text'、'exit'が指定可能となった。なお'link_url'を指定する場合は'link_text'に有効な文字列を指定する必要がある。

[5.2.0]'wp_die_jsonp_handler'フィルターと'wp_die_xml_handler'フィルターが追加され、各リクエスト時の終了処理が細分化された。

使用例

  • エラーメッセージとしてを表示する。
    <?php wp_die( '予期せぬエラーです。' ); ?>
  • タイトルを指定してエラーメッセージとしてを表示する。
    <?php wp_die( '予期せぬエラーです。', 'システムエラー' ); ?>

フィルター

[3.4.0]AJAXリクエスト時に'wp_die_ajax_handler'フィルターを呼び出す。パラメータにはAJAXリクエスト時の終了処理を行う関数名の'_ajax_wp_die_handler'が格納されている。 
$function = apply_filters( 'wp_die_ajax_handler', '_ajax_wp_die_handler' );
[5.1.0]JSONリクエスト時に'wp_die_json_handler'フィルターを呼び出す。パラメータにはJSONリクエスト時の終了処理を行う関数名の'_json_wp_die_handler'が格納されている。 
$function = apply_filters( 'wp_die_json_handler', '_json_wp_die_handler' );
[5.2.0]JSONPリクエスト時に'wp_die_jsonp_handler'フィルターを呼び出す。パラメータにはJSONPリクエスト時の終了処理を行う関数名の'_jsonp_wp_die_handler'が格納されている。 
$function = apply_filters( 'wp_die_jsonp_handler', '_jsonp_wp_die_handler' );
[3.4.0]XMLRPCリクエスト時に'wp_die_xmlrpc_handler'フィルターを呼び出す。パラメータにはXMLRPCリクエスト時の終了処理を行う関数名の'_xmlrpc_wp_die_handler'が格納されている。 
$function = apply_filters( 'wp_die_xmlrpc_handler', '_xmlrpc_wp_die_handler' );
[5.2.0]XMLリクエスト時に'wp_die_xml_handler'フィルターを呼び出す。パラメータにはXMLリクエスト時の終了処理を行う関数名の'_xml_wp_die_handler'が格納されている。 
$function = apply_filters( 'wp_die_xml_handler', '_xml_wp_die_handler' );
[3.0.0]上記以外のリクエスト時に'wp_die_handler'フィルターを呼び出す。パラメータには終了処理を行う関数名の'_default_wp_die_handler'が格納されている。 
$function = apply_filters( 'wp_die_handler', '_default_wp_die_handler' );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/functions.php

最終更新 : 2019年05月10日 10:20

関連

参考

Code Reference: wp_die

お勧め

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

さくらのVPSでKUSANAGI#2（2018年5月27日 更新）

今回は「前回」の続き。さくらのVPS（メモリー2GB SSDプラン）でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

タイトルのみをキーワード検索する（2014年4月3日 更新）

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

Login rebuilder 2.6.0の新機能紹介（2019年4月22日 更新）

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

Blacklist keys manager：プラグイン作ってみました（2015年5月22日 更新）

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。