How to disable Whoops pretty error page in production?

Conditionally register Whoops based on environment variables, or replace the PrettyPageHandler with a secure alternative like PlainTextHandler. The README suggests overriding system calls for finer control, but explicit production guidance is sparse.

Whoops vs Monolog for PHP error handling?

Whoops is designed for error display and debugging with pretty interfaces, while Monolog is a logging library for recording errors to various outputs. They complement each other—use Whoops for development and Monolog for production logging.

How to set up editor integration with Whoops in PHPStorm?

Configure the PrettyPageHandler with editor paths using the 'Open Files In An Editor' documentation. For PHPStorm, set the editor to 'phpstorm' and ensure the correct URI scheme is enabled for direct file opening from error traces.

Can Whoops handle AJAX errors properly?

Yes, use the JsonResponseHandler or XmlResponseHandler to return error details in JSON or XML format. Push these handlers conditionally based on request headers to ensure AJAX requests receive appropriate error responses.

Is Whoops safe to use in production with Laravel?

While Laravel integrates Whoops, it's risky to enable the pretty interface in production due to data exposure. Disable it via environment checks or use Laravel's logging mechanisms, and consider custom handlers for secure error reporting.

How to add custom data to Whoops error page?

Extend the PrettyPageHandler and use methods like addDataTable to include additional context such as session variables or application state. This enhances debugging without modifying core files, as per the extensible architecture.

Open-Awesome

Whoops

MITPHP

A flexible error handler framework for PHP that provides a pretty error interface and stacked error handling.

Visit Website GitHub

13.2k stars599 forks0 contributors

What is Whoops?

Whoops is an error handler framework for PHP designed to improve the debugging experience. It provides a stacked error handling system with an out-of-the-box pretty error interface for web projects, making error diagnosis more intuitive and developer-friendly.

Target Audience

PHP developers working on web applications who need enhanced error handling and debugging tools, particularly those using frameworks like Laravel, Mezzio, or other PHP frameworks with community integrations.

Value Proposition

Developers choose Whoops for its visually appealing error pages, editor integration for opening files directly from traces, and extensible architecture with no required dependencies, offering a lightweight yet powerful alternative to basic PHP error handling.

Overview

PHP errors for cool kids

Use Cases

Best For

Debugging PHP web applications with visually detailed error pages
Integrating enhanced error handling into PHP frameworks like Laravel, Mezzio, or Slim
Handling errors in AJAX requests with JSON or XML response formats
Improving developer productivity through editor integration for quick file access from error traces
Building extensible error handling systems with a modular, stack-based approach
Creating CLI applications with plain text error output using the PlainTextHandler

Not Ideal For

Production deployments where exposing detailed stack traces and environment data to end-users poses a security risk
Teams using PHP frameworks with immutable, built-in error handling that cannot be easily replaced or extended
Projects requiring automated error logging and monitoring integration with services like Sentry or Datadog without custom handler development

Pros & Cons

Pros

Flexible Stack Handling

Modular, stack-based architecture allows for managing exceptions and trace frames with a simple API, enabling custom error workflows as highlighted in the README's feature list.

Developer-Friendly Interface

Provides pretty error pages with editor integration, letting developers open files directly from traces to speed up debugging, as evidenced by the dedicated documentation for editor setup.

Multiple Response Formats

Includes built-in handlers for JSON, XML, and SOAP outputs, making it suitable for web APIs and AJAX requests without additional dependencies, per the README's handler descriptions.

Lightweight and Extensible

No required dependencies and easy integration with existing libraries, supported by community plugins for frameworks like Laravel, Slim, and CakePHP, as listed in the installation section.

Cons

Production Security Risks

The default pretty error interface can leak sensitive data like stack traces and environment variables if not disabled or secured in production, a concern not prominently addressed in the README.

Manual Integration Effort

For projects using unsupported or custom frameworks, setup requires manual handler registration and configuration, which can be time-consuming compared to drop-in solutions for popular frameworks.

Limited Built-in Logging

Focuses on error display rather than persistent logging; developers must implement custom handlers for saving errors to files or external services, adding overhead for production use.

Frequently Asked Questions

Related Projects

Symfony VarDumper

Provides mechanisms for walking through any arbitrary PHP variable

Stars7,441

Forks100

Last commit6 days ago

Kint

Kint - Advanced PHP dumper

Stars2,819

Forks286

Last commit3 months ago

PHPBench

PHP Benchmarking framework

Stars1,994

Forks132

Last commit20 days ago

Tracy

😎 Tracy: the addictive tool to ease debugging PHP code for cool developers. Friendly design, logging, profiler, advanced features like debugging AJAX calls or CLI support. You will love it.

Stars1,824

Forks221

Last commit2 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub