PHP Error Handler

Edit This Page

If your Slim Framework application throws a PHP Runtime error (PHP 7+ only), the application invokes its PHP Error handler and returns a HTTP/1.1 500 Internal Server Error response to the HTTP client.

Please note that Warnings and Notices are not caught by default. If you wish your application to display an error page when they happen, you have to run the following code before the app starts. In most cases that means adding it to the very top of index.php.

<?php

error_reporting(E_ALL);
set_error_handler(function ($severity, $message, $file, $line) {
    if (error_reporting() & $severity) {
        throw new \ErrorException($message, 0, $severity, $file, $line);
    }
});

This way all Warnings and Notices will be treated as Errors and as such will trigger the defined handlers.

Default PHP Error handler

Each Slim Framework application has a default PHP Error handler. This handler sets the Response status to 500, it sets the content type to text/html, and it writes a simple explanation to the Response body.

Custom PHP Error handler

A Slim Framework application’s PHP Error handler is a Pimple service. You can substitute your own PHP Error handler by defining a custom Pimple factory method with the application container.

// Create Slim
$app = new \Slim\App();
// get the app's di-container
$c = $app->getContainer();
$c['phpErrorHandler'] = function ($c) {
    return function ($request, $response, $error) use ($c) {
        return $response->withStatus(500)
            ->withHeader('Content-Type', 'text/html')
            ->write('Something went wrong!');
    };
};

N.B Check out Not Found docs for pre-slim creation method using a new instance of \Slim\Container

In this example, we define a new phpErrorHandler factory that returns a callable. The returned callable accepts three arguments:

  1. A \Psr\Http\Message\ServerRequestInterface instance
  2. A \Psr\Http\Message\ResponseInterface instance
  3. A \Throwable instance

The callable MUST return a new \Psr\Http\Message\ResponseInterface instance as is appropriate for the given error.