PHPのuser_error()関数とは？使い方とサンプルコードを解説

user_error() 関数は、PHP の trigger_error() 関数のエイリアス（別名）です。ユーザーが任意にエラー条件を発生させるために使用され、PHP 組み込みのエラーハンドラと組み合わせることも、set_error_handler() で登録したユーザー定義のエラーハンドラ関数と併用することもできます。

なお、この関数は trigger_error() と完全に同じ動作をするため、現在では可読性の観点から trigger_error() を使うことが推奨されています。

構文

user_error(error_msg, error_type)

パラメータ

• error_msg − 出力するエラーメッセージを指定します。メッセージの長さは最大1024文字までに制限されています。

• error_type − 発生させるエラーの種類を指定します。このパラメータは省略可能で、デフォルトは E_USER_NOTICE です。

• 指定できる主なエラータイプは以下の通りです。

  • E_USER_ERROR − ユーザーが生成した致命的な実行時エラー。回復不能なエラーであり、スクリプトの実行はそこで中断されます。

  • E_USER_WARNING − ユーザーが生成した致命的ではない実行時の警告。スクリプトの実行は継続されます。

  • E_USER_NOTICE − デフォルト値。ユーザーが生成した実行時の通知。スクリプトがエラーの可能性があるものを検出したことを示しますが、通常の実行でも発生しうる軽微なものです。

戻り値

無効な error_type が指定された場合は FALSE を返し、正しく指定された場合は TRUE を返します。

使用例

以下は user_error() 関数を使用したサンプルコードです。

<?php
   if ($demo<10) {
      user_error("Number cannot be less than 2");
   }
?>

出力結果

上記のコードを実行すると、次のような出力になります。

PHP Notice: Undefined variable: demo in /home/cg/root/4127336/main.php on line 2
PHP Notice: Number cannot be less than 2 in /home/cg/root/4127336/main.php on line 3

この例では、変数 $demo が未定義であるため最初の通知が出力され、続いて user_error() によって生成されたカスタムメッセージが通知（Notice）として表示されています。エラータイプを省略しているため、デフォルトの E_USER_NOTICE が適用されている点にも注目してください。