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

最終更新 : 2020年04月07日 11:42



お勧め

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

ツイート引用が簡単になる仕組み(2012年6月8日 更新)

WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

サイトヘルス機能を使ってみた(2019年4月12日 更新)

先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2(以降5.2Beta2)が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。

ブロックエディターで編集したページが出力した余分な改行を削除(2019年2月22日 更新)

ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。