クラスリファレンス/WP Errorのソースを表示

<div id="Description">
== 説明 ==
</div>

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

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

<div id="Methods and Properties">
== メソッドとプロパティ ==
</div>

<div id="Properties">
=== プロパティ ===
</div>

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

'''参考:''' バージョン 4.0 でこれらのプロパティはプライベートにされましたが、4.2 以降ふたたびパブリックになりました。

<div id="Methods">
=== メソッド ===
</div>

;	<tt>__construct( $code = <nowiki>''</nowiki>, $message = <nowiki>''</nowiki>, $data = <nowiki>''</nowiki> )</tt>
:		エラーメッセージをセットアップします。どのパラメータも省略可能です。 <tt>$code</tt> が空文字列の場合、他のパラメータは無視されます。<tt>$code</tt> パラメータに空でない値をセットすると、<tt>$message</tt> は空文字列でも使われますが、<tt>$data</tt> は空文字列でないときのみ使われます。このクラスの他のメソッドを使うと、同じコードに複数のメッセージを追加できます。

;	<tt>get_error_codes()</tt>
:		エラーコードをすべて取得します。パブリックにアクセス可能で、エラーコードのリストの配列を返します（エラーコードがセット済みのとき）。

;	<tt>get_error_code()</tt>
:		先頭のエラーコードを取得します。パブリックにアクセス可能で、文字列または整数を返します。エラーコードがない場合は空文字列を返します。

;	<tt>get_error_messages($code)</tt>
:		すべてのエラーメッセージ、または指定したコードにマッチするエラーメッセージを取得します。パブリックにアクセス可能で、エラー文字列の配列を返します。指定したコードにマッチするメッセージが無ければ空の配列を返します。

;	<tt>get_error_message($code)</tt>
:		エラーメッセージを一つ取得します。指定したコードの最初のメッセージを返します。コードを指定しなければ、先頭のコードが使われます。エラー文字列を返します。

;	<tt>get_error_data($code)</tt>
:		指定したエラーコードのエラーデータを取得します。戻り値は mixed です。エラーデータがなければ null を返します。

;	<tt>add($code, $message, $data)</tt>
:		エラーメッセージのリストにエラーメッセージをもっと追加します。戻り値はありません。

;	<tt>add_data($data, $code)</tt>
:		エラーコードにデータを追加します。エラーコードはエラーデータを一つしか持てません。戻り値はありません。

;	<tt>remove($code)</tt>
:		エラーコードに関連付けられたすべてのメッセージやデータを削除します。戻り値はありません。

<div id="Example">
== 用例 ==
</div>

 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();
 }

<div id="Source">
== ソースファイル ==
</div>

<tt>WP_Error</tt> は {{Trac|wp-includes/class-wp-error.php}} にあります。

<div id="Change Log">
== 改訂履歴 ==
</div>

* [[Version_4.2 | 4.2.0]] : エラーとデータの配列が再びパブリックになり、マジックメソッドが削除されました。[https://core.trac.wordpress.org/ticket/30891 Trac ticket #30891] を見てください。
* [[Version_4.1 | 4.1.0]] : <tt>remove()</tt> メソッドを追加。
* [[Version_4.0 | 4.0.0]] : エラーとデータの配列がプライベートになり、後方互換性のためマジックメソッドが追加されました。[https://core.trac.wordpress.org/changeset/28511 <nowiki>[28511]</nowiki>] を見てください。
* [[Version 2.1|2.1.0]] : 新規導入。

<div id="Related">
== 関連項目 ==
</div>

* エラー処理について詳しくは [[関数リファレンス/is_wp_error|is_wp_error()]] を参照してください。（恐ろしい 'Catchable fatal error: Object of class WP_Error could not be converted to string' に直面したとき特に役に立ちます。）

== リソース ==
* [http://code.tutsplus.com/tutorials/wordpress-error-handling-with-wp_error-class-i--cms-21120 WordPress Error Handling with WP_Error Class]

{{Class Footer}}

{{原文|Class Reference/WP Error|152717}} <!-- 19:56, 22 July 2015 Felipelavinz  版 -->

{{DEFAULTSORT:WP_Error}}
[[Category:クラス]]
[[Category:エラー処理]]

[[en:Class Reference/WP_Error]]
[[it:Riferimento classi/WP_Error]]