当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「クラスリファレンス/WP Error」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Class Reference/WP_Error 13:29, 10 May 2014 Jdgrimes 版を流し込み。)
 
(最初の翻訳。)
1行目: 1行目:
{{NeedTrans}}
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
==Description==
+
<tt>WP_Error</tt> は、プラグインと WordPress 自身のエラー処理を簡単に行えるようにするクラス(PHP のクラス)です。
  
<tt>WP_Error</tt> is a class that makes error handling within plugins and WordPress itself much easier.
+
<tt>WP_Error</tt> のインスタンスは一つか複数のエラーを表すエラーコードとメッセージを保持します。
 +
また、ある変数が <tt>WP_Error</tt> のインスタンスであるかを <tt>[[関数リファレンス/is_wp_error | is_wp_error()]]</tt> 関数を使って判定できます。
  
Instances of <tt>WP_Error</tt> store error codes and messages representing one or more errors, and whether or not a variable is an instance of <tt>WP_Error</tt> can be determined using the <tt>[[関数リファレンス/is_wp_error | is_wp_error()]]</tt> function.
+
<div id="Methods and Properties">
 +
== メソッドとプロパティ ==
 +
</div>
  
==Methods and Properties==
+
<div id="Properties">
 
+
=== プロパティ ===
===Properties===
+
</div>
  
 
; <tt>$errors</tt>
 
; <tt>$errors</tt>
: Array containing the list of errors.
+
: エラーのリストが入った配列。
 
; <tt>$error_data</tt>
 
; <tt>$error_data</tt>
: Array containing the list of data for error codes.
+
: エラーコードを表すデータのリストが入った配列。
 
+
===Methods===
+
  
 +
<div id="Methods">
 +
=== メソッド ===
 +
</div>
  
 
; <tt>__construct( $code = <nowiki>''</nowiki>, $message = <nowiki>''</nowiki>, $data = <nowiki>''</nowiki> )</tt>
 
; <tt>__construct( $code = <nowiki>''</nowiki>, $message = <nowiki>''</nowiki>, $data = <nowiki>''</nowiki> )</tt>
: Sets up the error message. All parameters are optional, and if the <tt>$code</tt> parameter is empty, the other parameters will be ignored. When the <tt>$code</tt> parameter is set to a non-empty value, the <tt>$message</tt> will be used even if it is empty, but the <tt>$data</tt> parameter will be used only if it is not empty. It is possible to add multiple messages to the same code by using other methods in the class.
+
: エラーメッセージをセットアップします。どのパラメータも省略可能です。 <tt>$code</tt> が空文字列の場合、他のパラメータは無視されます。<tt>$code</tt> パラメータに空でない値をセットすると、<tt>$message</tt> は空文字列でも使われますが、<tt>$data</tt> は空文字列でないときのみ使われます。このクラスの他のメソッドを使うと、同じコードに複数のメッセージを追加できます。
  
 
; <tt>get_error_codes()</tt>
 
; <tt>get_error_codes()</tt>
: Retrieve all error codes. Access public, returns array List of error codes, if available.
+
: エラーコードをすべて取得します。パブリックにアクセス可能で、エラーコードのリストの配列を返します(エラーコードがセット済みのとき)。
  
 
; <tt>get_error_code()</tt>
 
; <tt>get_error_code()</tt>
: Retrieve first error code available. Access public, returns string, int or Empty if there is no error codes
+
: 先頭のエラーコードを取得します。パブリックにアクセス可能で、文字列または整数を返します。エラーコードがない場合は空文字列を返します。
  
 
; <tt>get_error_messages($code)</tt>
 
; <tt>get_error_messages($code)</tt>
: Retrieve all error messages or error messages matching code. Access public, returns an array of error strings on success, or empty array on failure (if using code parameter)
+
: すべてのエラーメッセージ、または指定したコードにマッチするエラーメッセージを取得します。パブリックにアクセス可能で、エラー文字列の配列を返します。指定したコードにマッチするメッセージが無ければ空の配列を返します。
  
 
; <tt>get_error_message($code)</tt>
 
; <tt>get_error_message($code)</tt>
: Get single error message. This will get the first message available for the code. If no code is given then the first code available will be used. Returns an error string.
+
: エラーメッセージを一つ取得します。指定したコードの最初のメッセージを返します。コードを指定しなければ、先頭のコードが使われます。エラー文字列を返します。
  
 
; <tt>get_error_data($code)</tt>
 
; <tt>get_error_data($code)</tt>
: Retrieve error data for error code. Returns mixed or null, if no errors.
+
: 指定したエラーコードのエラーデータを取得します。戻り値は mixed です。エラーデータがなければ null を返します。
  
 
; <tt>add($code, $message, $data)</tt>
 
; <tt>add($code, $message, $data)</tt>
: Append more error messages to list of error messages. No return.
+
: エラーメッセージのリストにエラーメッセージをもっと追加します。戻り値はありません。
  
 
; <tt>add_data($data, $code)</tt>
 
; <tt>add_data($data, $code)</tt>
: Add data for error code. The error code can only contain one error data. No return.
+
: エラーコードにデータを追加します。エラーコードはエラーデータを一つしか持てません。戻り値はありません。
 +
 
 +
<div id="Example">
 +
== 例 ==
 +
</div>
  
===Example===
 
 
  function doer_of_stuff() {
 
  function doer_of_stuff() {
 
     return new WP_Error( 'broke', __( "I've fallen and can't get up", "my_textdomain" ) );
 
     return new WP_Error( 'broke', __( "I've fallen and can't get up", "my_textdomain" ) );
53行目: 62行目:
 
  }
 
  }
  
== Source ==
+
<div id="Source">
<tt>WP_Error</tt> is located in {{Trac|wp-includes/class-wp-error.php}}
+
== ソースファイル ==
 +
</div>
 +
 
 +
<tt>WP_Error</tt> {{Trac|wp-includes/class-wp-error.php}} にあります。
 +
 
 +
<div id="Change Log">
 +
== 改訂履歴 ==
 +
</div>
  
== Change Log ==
+
[[Version 2.1|2.1.0]] にて導入されました。
*Since [[Version_2.1 | 2.1.0]]
+
  
== Related ==
+
<div id="Related">
 +
== 関連項目 ==
 +
</div>
  
* see [[関数リファレンス/is_wp_error|is_wp_error()]] for more information on trapping for errors (particularly useful when faced with the dreaded 'Catchable fatal error: Object of class WP_Error could not be converted to string')
+
* エラー処理について詳しくは [[関数リファレンス/is_wp_error|is_wp_error()]] を参照してください。(恐ろしい 'Catchable fatal error: Object of class WP_Error could not be converted to string' に直面したとき特に役に立ちます。)
  
 
{{Class Footer}}
 
{{Class Footer}}
67行目: 84行目:
 
{{原文|Class Reference/WP Error|143285}} <!-- 13:29, 10 May 2014 Jdgrimes 版 -->
 
{{原文|Class Reference/WP Error|143285}} <!-- 13:29, 10 May 2014 Jdgrimes 版 -->
  
[[Category:Classes]]
+
{{DEFAULTSORT:WP_Error}}
[[Category:Error Handling]]
+
[[Category:クラス]]
 +
[[Category:エラー処理]]
  
 
[[en:Class Reference/WP_Error]]
 
[[en:Class Reference/WP_Error]]
 
[[it:Riferimento classi/WP_Error]]
 
[[it:Riferimento classi/WP_Error]]

2014年8月2日 (土) 19:17時点における版

WP_Error は、プラグインと WordPress 自身のエラー処理を簡単に行えるようにするクラス(PHP のクラス)です。

WP_Error のインスタンスは一つか複数のエラーを表すエラーコードとメッセージを保持します。 また、ある変数が WP_Error のインスタンスであるかを is_wp_error() 関数を使って判定できます。

メソッドとプロパティ

プロパティ

$errors
エラーのリストが入った配列。
$error_data
エラーコードを表すデータのリストが入った配列。

メソッド

__construct( $code = '', $message = '', $data = '' )
エラーメッセージをセットアップします。どのパラメータも省略可能です。 $code が空文字列の場合、他のパラメータは無視されます。$code パラメータに空でない値をセットすると、$message は空文字列でも使われますが、$data は空文字列でないときのみ使われます。このクラスの他のメソッドを使うと、同じコードに複数のメッセージを追加できます。
get_error_codes()
エラーコードをすべて取得します。パブリックにアクセス可能で、エラーコードのリストの配列を返します(エラーコードがセット済みのとき)。
get_error_code()
先頭のエラーコードを取得します。パブリックにアクセス可能で、文字列または整数を返します。エラーコードがない場合は空文字列を返します。
get_error_messages($code)
すべてのエラーメッセージ、または指定したコードにマッチするエラーメッセージを取得します。パブリックにアクセス可能で、エラー文字列の配列を返します。指定したコードにマッチするメッセージが無ければ空の配列を返します。
get_error_message($code)
エラーメッセージを一つ取得します。指定したコードの最初のメッセージを返します。コードを指定しなければ、先頭のコードが使われます。エラー文字列を返します。
get_error_data($code)
指定したエラーコードのエラーデータを取得します。戻り値は mixed です。エラーデータがなければ null を返します。
add($code, $message, $data)
エラーメッセージのリストにエラーメッセージをもっと追加します。戻り値はありません。
add_data($data, $code)
エラーコードにデータを追加します。エラーコードはエラーデータを一つしか持てません。戻り値はありません。

function doer_of_stuff() {
    return new WP_Error( 'broke', __( "I've fallen and can't get up", "my_textdomain" ) );
}

$return = doer_of_stuff();
if( is_wp_error( $return ) ) {
    echo $return->get_error_message();
}

ソースファイル

WP_Errorwp-includes/class-wp-error.php にあります。

改訂履歴

2.1.0 にて導入されました。

  • エラー処理について詳しくは is_wp_error() を参照してください。(恐ろしい 'Catchable fatal error: Object of class WP_Error could not be converted to string' に直面したとき特に役に立ちます。)
クラスリファレンス関数リファレンスの各インデックスも参照してください。

最新英語版: WordPress Codex » Class Reference/WP Error最新版との差分