• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

「関数リファレンス/wp die」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(最終行の翻訳、および細部の修正、半角英字・記号の標記ルールに対応しました)
(引数)
27行目: 27行目:
 
=== 引数 ===
 
=== 引数 ===
 
{{Parameter|response|integer|HTML ステータスコードを返します。|オプション|500}}
 
{{Parameter|response|integer|HTML ステータスコードを返します。|オプション|500}}
{{Parameter|back_link|boolean|Whether to display a back link in the returned page.|オプション|<tt>false</tt>}}
+
{{Parameter|back_link|boolean|返されるページでバックリンクを表示するかどうか|オプション|<tt>false</tt>}}
{{Parameter|text_direction|文字列|Whether to set ltr or rtl as the text direction|オプション|'ltr'}}
+
{{Parameter|text_direction|文字列|テキスト方向をltr(左から右)またはrtl(右から左)を設定する|オプション|'ltr'}}
  
 
== 返り値 ==
 
== 返り値 ==

2015年8月7日 (金) 20:47時点における版

説明

WordPress の処理を中断し、条件つきのエラーメッセージを HTML で出力します。

この関数は PHP 関数であるdie()を補完します。

die() 関数との違いは、この関数に対し典型的なリクエストが発生した場合、ユーザーに対しその HTML が表示されることにあります。

この関数は、これ以上継続すべきでない処理がある場合のみ使用を推奨します。

この関数を頻繁に呼び出したり、大量のエラーをユーザーの見えない範囲で処理する行為は推奨しません。

もし本当に何も出力することなく処理を停止(およびタイムアウト)させたい場合は exit; か、最新版の die() を使用してください。

wp_die() 関数は空の値もしくはタイムアウトが返される直前に実行されるよう設計されています。

最新英語版: WordPress Codex » Function_Reference/wp_die最新版との差分

使い方

<?php wp_die( $message, $title, $args ) ?>

パラメータ

$message
mixed) (オプション) エラーメッセージまたは a complete WP_Errorオブジェクト。
初期値: なし
$title
string) (オプション) Error title, If you use a WP_Error object, the title will be by default the one you added in $data['title'] (ignored when DOING_AJAX is true).
初期値: ''
$args
string|array) (オプション) Optional arguments to control behavior (ignored when DOING_AJAX is true).
初期値: なし

引数

response
integer) (オプション) HTML ステータスコードを返します。
初期値: 500
back_link
boolean) (オプション) 返されるページでバックリンクを表示するかどうか
初期値: false
text_direction
文字列) (オプション) テキスト方向をltr(左から右)またはrtl(右から左)を設定する
初期値: 'ltr'

返り値

(void) 
この関数は値を返しません。

用例

Test to see what is in the $post variable in a filter:

add_filter( 'body_class', 'add_body_class_cb' );
/**
 * Add new body class.
 *
 * Testing what is in the $post variable.
 */
function add_body_class_cb( $classes ) {
    global $post;

    wp_die( '<pre>' . var_export( $post, true ) . '</pre>' );
}


  • Uses: apply_filters() - To filter the name of the die handler function:
    • Calls 'wp_die_ajax_handler' with the default AJAX die handler function ('_ajax_wp_die_handler') if the DOING_AJAX constant is set to true.
    • Calls 'wp_die_xmlrpc_handler' with the default XML-RPC die handler function ('_xmlrpc_wp_die_handler') if the XMLRPC_REQUEST constant is set to true.
    • Calls 'wp_die_handler' in every other case, with the default die handler function ('_default_wp_die_handler').
  • You can add a WP_Error object. If you've done so, you can add $data['title'] to the error object and it will automatically be taken as (default/overwriteable) title for the die page.

    [example missing here]

更新履歴

ソースファイル

wp_die()wp-includes/functions.phpにあります。

関連


関数リファレンステンプレートタグ目次もご覧ください。


このページ「関数リファレンス/wp die」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

最新英語版: WordPress Codex » Function_Reference/wp_die最新版との差分