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日 更新)

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

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。