Wyświetlanie błędów PHP: display_errors i E_ALL

Aby pokazać błędy PHP, wstaw na początku skryptu te linie: ini_set('display_errors', '1'); i error_reporting(E_ALL);. Pierwsza sprawia, że PHP wypisuje komunikaty błędów, druga, że zgłasza każdy rodzaj błędu, łącznie z ostrzeżeniami i informacjami o przestarzałym kodzie.

<?php
ini_set('display_errors', '1');
ini_set('display_startup_errors', '1');
error_reporting(E_ALL);

Z tymi ustawieniami błąd taki jak odczyt zmiennej, której nigdy nie ustawiono, wypisuje komunikat z plikiem i numerem linii, zamiast cicho zawieść:

Warning: Undefined variable $total in /home/index.php on line 7

error_reporting() wywołane bez argumentu zwraca bieżące ustawienie jako liczbę. Kliknij Run, aby ustawić poziom i odczytać go z powrotem jako nazwy:

<?php
error_reporting(E_ALL & ~E_DEPRECATED);
$level = error_reporting();

echo "Current level: $level (E_ALL is " . E_ALL . ")\n";

foreach (get_defined_constants(true)['Core'] as $name => $value) {
    if (str_starts_with($name, 'E_') && $name !== 'E_ALL') {
        echo str_pad($name, 20), ($level & $value) ? "reported" : "off", "\n";
    }
}

Każdy typ błędu to jeden bit, więc E_ALL & ~E_DEPRECATED oznacza „wszystko oprócz informacji o przestarzałym kodzie”. Zmień pierwszą linię na error_reporting(E_ERROR | E_WARNING); i uruchom ponownie.

Wyświetlanie błędów w php.ini

Ustawienie w skrypcie działa dopiero, gdy skrypt zacznie się wykonywać. Aby pokazywać błędy dla każdego skryptu, łącznie z błędami parsowania, zmień php.ini (znajdziesz go przez php --ini):

; Development
display_errors = On
display_startup_errors = On
error_reporting = E_ALL

Po edycji zrestartuj Apache albo PHP-FPM. Wbudowany serwer php -S i wiersz poleceń czytają plik przy każdym starcie. Na hostingu współdzielonym bez dostępu do php.ini Apache z mod_php przyjmuje też linie w .htaccess:

php_flag display_errors on
php_value error_reporting -1

-1 ustawia każdy bit, czyli to samo co E_ALL.

Poziomy błędów

PHP 8.0 zamienił wiele starych ostrzeżeń w wyjątki: dzielenie przez zero operatorem / i przekazanie złego typu do wbudowanej funkcji rzucają teraz podklasę Error, tak samo jak wywołanie niezdefiniowanej funkcji od PHP 7. Wszystkie trzy możesz przechwycić:

<?php
$attempts = [
    fn() => 10 / 0,
    fn() => strlen([]),
    fn() => undefinedFunction(),
];

foreach ($attempts as $attempt) {
    try {
        $attempt();
    } catch (Throwable $e) {
        echo get_class($e), ": ", $e->getMessage(), "\n";
    }
}

Wyjątki są opisane w try i catch. Ostrzeżenia, notice i informacje o przestarzałym kodzie nadal przechodzą przez opisany tu system raportowania błędów.

Logowanie błędów zamiast wyświetlania

Na działającej stronie odwiedzający nigdy nie powinni widzieć komunikatów błędów: ujawniają ścieżki, SQL i kod. Zapisuj je zamiast tego do pliku logu:

; Production
display_errors = Off
log_errors = On
error_log = /var/log/php/app-errors.log
error_reporting = E_ALL

Zostaw error_reporting = E_ALL na produkcji. Obniżenie poziomu nie usuwa błędów, tylko sprawia, że się o nich nie dowiadujesz. Własne komunikaty możesz zapisać do tego samego logu przez error_log():

<?php
error_log("Payment failed for order 1042");

Potem obserwuj plik podczas testów: tail -f /var/log/php/app-errors.log.

Zamiana ostrzeżeń w wyjątki przez set_error_handler

set_error_handler zastępuje domyślną obsługę ostrzeżeń, notice i informacji o przestarzałym kodzie Twoją własną funkcją. Popularny wzorzec zamienia każde z nich w ErrorException, więc zapomniany klucz tablicy zatrzymuje kod jak każdy inny wyjątek i można go przechwycić:

<?php
set_error_handler(function (int $severity, string $message, string $file, int $line): bool {
    throw new ErrorException($message, 0, $severity, $file, $line);
});

$prices = ['bread' => 4.5, 'milk' => 1.2];

try {
    echo "Bread costs {$prices['bread']}\n";
    echo "Cheese costs {$prices['cheese']}\n";
} catch (ErrorException $e) {
    echo "Caught: ", $e->getMessage(), " on line ", $e->getLine(), "\n";
}

restore_error_handler();

Funkcja obsługi dostaje poziom błędu jako pierwszy argument, więc może traktować poziomy różnie. Ta tylko loguje informacje o przestarzałym kodzie, a całą resztę zamienia w wyjątek:

<?php
set_error_handler(function (int $severity, string $message): bool {
    if ($severity === E_DEPRECATED || $severity === E_USER_DEPRECATED) {
        echo "[log] deprecated: $message\n";
        return true; // handled, PHP does nothing more
    }
    throw new ErrorException($message, 0, $severity);
});

trigger_error("oldFunction() is deprecated, use newFunction()", E_USER_DEPRECATED);

try {
    trigger_error("Config value 'timeout' is missing", E_USER_WARNING);
} catch (ErrorException $e) {
    echo "Exception: ", $e->getMessage(), "\n";
}

Błędy krytyczne i błędy parsowania nigdy nie trafiają do funkcji obsługi, bo skrypt nie może po nich kontynuować. Aby je zapisać, zarejestruj funkcję zamykającą, która czyta error_get_last().

Odczyt ostatniego błędu przez error_get_last

Niektóre funkcje zwracają false i podają przyczynę tylko jako ostrzeżenie, na przykład file_get_contents dla nieistniejącego pliku. error_get_last() zwraca to ostrzeżenie jako tablicę, co się przydaje, gdy chcesz pokazać własny komunikat:

<?php
$content = @file_get_contents('missing-config.json');

if ($content === false) {
    $error = error_get_last();
    echo "Could not read the file.\n";
    echo "Type: ", $error['type'] === E_WARNING ? 'E_WARNING' : $error['type'], "\n";
    echo "Message: ", $error['message'], "\n";
}

Operator @ przed wywołaniem wycisza komunikat dla tego jednego wyrażenia. Używaj go oszczędnie i tylko wtedy, gdy zaraz potem sprawdzasz wynik, jak tutaj; samo @ jedynie ukrywa błędy.

Częsty błąd: błędy są włączone, a strona nadal jest pusta

Jeśli dodałeś ini_set('display_errors', '1') i nadal widzisz białą stronę, to prawdopodobnie błąd parsowania. PHP parsuje cały plik przed wykonaniem pierwszej linii, więc brakujący ; albo } zatrzymuje wszystko, zanim wykona się ini_set. Sprawdź plik z terminala, który zawsze wypisuje komunikat:

php -l index.php

Errors parsing index.php
PHP Parse error:  syntax error, unexpected token "," in index.php on line 2

Numer linii wskazuje miejsce, w którym PHP się poddał, a to często linia po faktycznym błędzie. Popraw go, uruchamiaj php -l, aż wypisze No syntax errors detected, i odśwież stronę.