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'に有効な文字列を指定する必要がある。


使用例

  • エラーメッセージとしてを表示する。
    <?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' );
[3.4.0]XMLRPCリクエスト時に'wp_die_xmlrpc_handler'フィルターを呼び出す。パラメータにはXMLRPCリクエスト時の終了処理を行う関数名の'_xmlrpc_wp_die_handler'が格納されている。
$function = apply_filters( 'wp_die_xmlrpc_handler', '_xmlrpc_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年02月23日 10:28



お勧め

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。

新「WordPress Events and News」ウィジェットが興味深い(2018年5月27日 更新)

4.8のベータ版ですぐに新機能とわかるのが管理者ダッシュボードの新「WordPress Events and News」ウィジェット。ユーザーが指定した地域近隣で開催されるイベント情報を表示してくれるウィジェットで、この中のフォームがちょっと興味深かった。なおこの記事はWordPress 4.8 beta-2をもとにしており、以降のバージョンで変更される可能性があることをあらかじめ断っておく。

適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす(2016年12月15日 更新)

/wp-includes/template-loader.phpではリクエストされたページに応じて現在のテーマにあるテンプレートファイルの中から適切なものを選びに振り分けている。ここでは、さまざまなテンプレートファイルの種類と、テンプレートファイルが省略された場合の内部の動作についてまとめてみる。

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

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

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 更新)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。