PHP - Function trigger_error()


Advertisements


Syntax

bool trigger_error ( string $error_msg [, int $error_type] );

Definition and Usage

This function is used to trigger a user error condition, it can be used by in conjunction with the built-in error handler, or with a user defined function that has been set as the new error handler (set_error_handler()).

Parameters

Parameter Description
error_msg Required. Specifies the error message. Limited to 1024 characters in length.
error_types

Optional. Specifies the error type for this error message.

Possible error types −

  • E_USER_ERROR − Fatal user-generated run-time error. Errors that can not be recovered from. Execution of the script is halted.

  • E_USER_WARNING − Non-fatal user-generated run-time warning. Execution of the script is not halted.

  • E_USER_NOTICE − Default. User-generated run-time notice. The script found something that might be an error, but could also happen when running a script normally.

Return Value

This function returns FALSE if wrong error_type is specified, TRUE otherwise.

Example

Following is the usage of this function −

<?php
   if (assert($divisor == 0)) {
      trigger_error("Cannot divide by zero :\n", E_USER_ERROR);
   }
?> 

This will produce the following result −

Fatal error: Cannot divide by zero :
in /var/www/tutorialspoint/php/test.php on line 3

php_function_reference.htm

Advertisements