wp_error()


WordPress関数wp_error()は、エラー処理を行うために使用されるクラスまたは関数です。

構文

$variable = new WP_Error( string $code = '', string $message = '', mixed $data = '' );

引数の説明:

  • $code (string) — エラーコード。識別のために使用されます。
  • $message (string) — エラーメッセージ。エラー内容を説明する文字列です。
  • $data (mixed) — エラーに関連付けられた追加データ(オプション)。

例1: シンプルなエラーの作成

次のコードは、カスタムエラーを作成し、エラーメッセージを表示します。

<?php
$error = new WP_Error( 'invalid_request', 'リクエストが無効です。' );
echo $error->get_error_message();
?>

例2: エラーのデータを設定する

エラーに追加情報を関連付けることができます。

<?php
$error = new WP_Error( 'missing_data', '必要なデータが提供されていません。', array( 'field' => 'email' ) );
$data = $error->get_error_data();
print_r( $data );
?>

例3: 複数のエラーを追加する

1つのWP_Errorオブジェクトに複数のエラーを追加する方法です。

<?php
$error = new WP_Error();
$error->add( 'empty_username', 'ユーザー名が入力されていません。' );
$error->add( 'empty_password', 'パスワードが入力されていません。' );
foreach ( $error->get_error_messages() as $message ) {
    echo $message . '<br>';
}
?>

例4: 特定のエラーメッセージを取得する

エラーコードを指定して、特定のエラーメッセージを取得します。

<?php
$error = new WP_Error();
$error->add( 'invalid_email', 'メールアドレスが無効です。' );
$message = $error->get_error_message( 'invalid_email' );
echo $message;
?>

例5: エラーが存在するか確認する

WP_Errorオブジェクトがエラーを保持しているかを確認します。

<?php
$error = new WP_Error();
if ( is_wp_error( $error ) ) {
    echo 'エラーが存在します。';
}
?>

注意事項

  • エラーコードは一意であることを推奨します。他のプラグインやテーマと競合しないようにします。
  • デバッグ時にWP_Errorを使用すると便利です。

関連機能: