O'Reilly

Custom Error Handling in PHP

By on  

Web application don't always go to plan, that much is obvious. Users will continuously find ways to trigger errors within your application and how you record, contain, and eliminate these errors is a true testament to your code. PHP provides means for trapping errors and dealing with them the way you need them to be dealt with. The best part of PHP error handling is that it's extremely customizable using PHP's set_error_handler() function.

The Error Handler

function xhandler($number,$string,$file,$line,$context)
{
	//log to text file?

	//log to xml file?

	//store in database?

	//whatever you want to do!
}

The Explanation

Your error handling function can accept five parameters:

  • $number - Integer error number representative of the PHP error level
  • $string - String description of the error
  • $file - File in which the error occurred
  • $line - Line number in the file that the error occurred
  • $context - Context of the area, including an array of each variable in scope

The Usage

/* use this error for ALL (E_ALL) errors */
set_error_handler('xhandler',E_ALL);

This is a basic example of the custom error handling in PHP. The programming and methods you use to save and analyze these errors is up to you, but common methods include:

  • Saving the error to a database
  • Saving the error information to a local file (text, xml, etc.)
  • Redirecting the user to another page
  • Absolutely nothing (I've actually seen this in other dev's code).

Though you can do almost anything in your error handling function(s), I recommend the following for error handling functions:

  • Store the date/time of the error
  • Use more than one method of storing error logs (database, file, etc.)
  • Email severe warnings/errors to yourself so you may deal with any critical problems as soon as possible
  • Use different error handling functions for different error levels if necessary
  • Create a new file log daily so that your log file doesn't balloon

How do you record PHP errors in your applications?

Track.js Error Reporting

Recent Features

  • 7 Essential JavaScript Functions

    I remember the early days of JavaScript where you needed a simple function for just about everything because the browser vendors implemented features differently, and not just edge features, basic features, like addEventListener and attachEvent.  Times have changed but there are still a few functions each developer should...

  • An Interview with Eric Meyer

    Your early CSS books were instrumental in pushing my love for front end technologies. What was it about CSS that you fell in love with and drove you to write about it? At first blush, it was the simplicity of it as compared to the table-and-spacer...

Incredible Demos

  • Redacted Font

    Back when I created client websites, one of the many things that frustrated me was the initial design handoff.  It would always go like this: Work hard to incorporate client's ideas, dream up awesome design. Create said design, using Lorem Ipsum text Send initial design concept to the client...

  • Build a Calendar Using PHP, XHTML, and CSS

    One of the website features my customers love to provider their web users is an online dynamic calendar. An online calendar can be used for events, upcoming product specials, memos, and anything else you can think of. I've taken some time to completely...

Discussion

  1. Hello – nice tutorial. It would be cool to see a custom exception handler tutorial next – and then maybe a combo of the two. ;)
    -Aaron

  2. This is very useful. I shall implement now :)

  3. Thanks for this great tutorial. I’ll subscribing to your feeds!

  4. hi

    thanks for your tutorial . but we tried this and it dosn’t work for some error types like fatal errors
    did u see this ?

  5. flies

    And if you need something for exceptions (although you should avoid them), you can try this:

    function exception_handler($exception)
    {
        // these are our templates
        $traceline = "#%s %s(%s): %s(%s)";
        $msg = "PHP Fatal error:  Uncaught exception '%s' with message '%s' in %s:%s\nStack trace:\n%s\n  thrown in %s on line %s\n\n";
    
        // alter your trace as you please, here
        $trace = $exception->getTrace();
        foreach ($trace as $key => $stackPoint) {
            // I'm converting arguments to their type
            // (prevents passwords from ever getting logged as anything other than 'string')
            $trace[$key]['args'] = array_map('gettype', $trace[$key]['args']);
        }
    
        // build your tracelines
        $result = array();
        foreach ($trace as $key => $stackPoint) {
            $result[] = sprintf(
                $traceline,
                $key,
                $stackPoint['file'],
                $stackPoint['line'],
                $stackPoint['function'],
                implode(', ', $stackPoint['args'])
            );
        }
        // trace always ends with {main}
        $result[] = '#' . ++$key . ' {main}';
    
        // write tracelines into main template
        $msg = sprintf(
            $msg,
            get_class($exception),
            $exception->getMessage(),
            $exception->getFile(),
            $exception->getLine(),
            implode("\n", $result),
            $exception->getFile(),
            $exception->getLine()
        );
    
    
    
    // do something with message
    }
    

    And then:

    set_exception_handler("exception_handler");
    
  6. flies

    @MiZO: if you want to catch fatal errors, you can try the following:

    error_reporting(E_ALL);
    ini_set('display_errors', 0);

    function shutdown(){
    $isError = false;
    if ($error = error_get_last()){
    switch($error['type']){
    case E_ERROR:
    case E_CORE_ERROR:
    case E_COMPILE_ERROR:
    case E_USER_ERROR:
    $isError = true;
    break;
    }
    }

    if ($isError){
    echo "Script execution halted ({$error['message']})";
    } else {
    echo "Script completed";
    }
    }

    register_shutdown_function('shutdown');

Wrap your code in <pre class="{language}"></pre> tags, link to a GitHub gist, JSFiddle fiddle, or CodePen pen to embed!

Recently on David Walsh Blog

  • Serve a Directory via Python

    Sometimes I'm working with a test HTML file and some JavaScript but need to work off of a served space.  In that case, I sometimes need to swap out folders within MAMP Stack which leads to a maintenance nightmare.  Bleh. I recently found out that you can...

  • OSCON Portland:  Conference  Discount!

    O'Reilly puts on the best web industry conferences in the world.  These conferences include Fluent Conference, Velocity Conference, and the upcoming OSCON in Portland, Oregon from July 20-24.  Open Source Convention (OSCON) is a conference that focuses specifically on open source developers and the tools and possibilities...

  • Follow Redirects with cURL

    I love playing around with cURL. There's something about loading websites via command line that makes me feel like some type of smug hacker, just like tweeting from command line does. I recently cURL'd the Google homepage and saw the following: I found it weird that Google...

  • Developers Have WordPress, Amateurs Have Squarespace, Professional Designers Have the NEW Webydo!

    Web design platforms have traditionally come in one of two varieties. There are the solutions like WordPress and Drupal that are incredibly powerful, but an understanding of web development and coding is required to be able to use those platforms effectively. On the other side of the...

  • Chris Coyierâs Favorite CodePen Demos II

    Hey everyone! Before we get started, I just want to say it’s damn hard to pick this few favorites on CodePen. Not because, as a co-founder of CodePen, I feel like a dad picking which kid he likes best (RUDE). But because there is just so...