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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

WordPressのコーディングスタンダードとPSR-2がかみ合わない(2018年5月27日 更新)

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon(4.6)」から「Oxygen(4.7)」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style(Formatter)」が「PSR-2」に設定されていることが原因だった。

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

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

検索ワード「-10,000円」を検索できるようにしたい(2018年5月27日 更新)

とあるサイトで「-10,000円」をキーワードに検索した際、予想と異なるページが表示され、ちょっと驚いた。今回はその原因調査と対策についてまとめてみた。

32ピクセルのサイトアイコンを別の画像ファイルに変更する(2018年5月27日 更新)

「サイトアイコン」は4.3の新機能の1つ。管理画面で適当な画像ファイルを指定するだけでサイトアイコンが適用されます。そんなサイトアイコンで、既存の favicon.ico を併用する方法を紹介します。