Báo lỗi trong PHP: hiển thị lỗi và E_ALL

Để hiện lỗi PHP, hãy đặt các dòng sau ở đầu script: ini_set('display_errors', '1'); và error_reporting(E_ALL);. Dòng đầu khiến PHP in ra thông báo lỗi, dòng thứ hai khiến nó báo mọi loại lỗi, kể cả cảnh báo (warning) và thông báo deprecation.

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

Khi đã có các dòng đó, một lỗi như đọc một biến chưa từng được gán sẽ in ra thông báo kèm tên tệp và số dòng, thay vì thất bại trong im lặng:

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

error_reporting() khi gọi không có đối số sẽ trả về cấu hình hiện tại dưới dạng một con số. Nhấn Chạy để đặt một mức báo lỗi và giải mã nó trở lại thành tên:

<?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";
    }
}

Mỗi loại lỗi là một bit, nên E_ALL & ~E_DEPRECATED có nghĩa là "mọi thứ trừ deprecation". Đổi dòng đầu thành error_reporting(E_ERROR | E_WARNING); rồi chạy lại.

Hiển thị lỗi trong php.ini

Cấu hình đặt trong script chỉ có hiệu lực khi script đã bắt đầu chạy. Để hiện lỗi cho mọi script, kể cả lỗi cú pháp, hãy sửa php.ini (tìm nó bằng php --ini):

; Development
display_errors = On
display_startup_errors = On
error_reporting = E_ALL

Khởi động lại Apache hoặc PHP-FPM sau khi sửa. Server tích hợp php -S và dòng lệnh đọc lại tệp này mỗi lần khởi động. Trên shared hosting không có quyền truy cập php.ini, Apache với mod_php cũng chấp nhận các dòng trong .htaccess:

php_flag display_errors on
php_value error_reporting -1

-1 bật mọi bit, tương đương với E_ALL.

Các mức lỗi

PHP 8.0 đã biến nhiều cảnh báo cũ thành ngoại lệ: chia cho 0 bằng / và truyền sai kiểu cho một hàm có sẵn giờ đều ném ra một lớp con của Error, giống như việc gọi một hàm chưa định nghĩa từ PHP 7. Bạn có thể bắt cả ba:

<?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";
    }
}

Ngoại lệ được trình bày ở try và catch. Cảnh báo, notice và deprecation vẫn đi qua hệ thống báo lỗi được mô tả ở đây.

Ghi log lỗi thay vì hiển thị

Trên một website đang chạy thật, người truy cập không bao giờ nên thấy thông báo lỗi: chúng để lộ đường dẫn, SQL và code. Thay vào đó, hãy ghi chúng vào một tệp log:

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

Giữ error_reporting = E_ALL trên production. Hạ mức này xuống không làm lỗi biến mất, nó chỉ khiến bạn không còn nghe về chúng. Thông báo của riêng bạn cũng có thể ghi vào cùng log đó bằng error_log():

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

Sau đó hãy theo dõi tệp trong lúc thử nghiệm: tail -f /var/log/php/app-errors.log.

Biến cảnh báo thành ngoại lệ với set_error_handler

set_error_handler thay cách PHP xử lý mặc định cho warning, notice và deprecation bằng hàm của riêng bạn. Một mẫu hay gặp là chuyển mọi lỗi thành ErrorException, để một khóa mảng bị quên sẽ dừng code như mọi ngoại lệ khác và có thể bắt được:

<?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();

Hàm xử lý nhận mức lỗi làm đối số đầu tiên, nên nó có thể xử lý từng mức theo cách khác nhau. Hàm này chỉ ghi log các deprecation và biến mọi thứ khác thành ngoại lệ:

<?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";
}

Lỗi nghiêm trọng và lỗi cú pháp không bao giờ đến được hàm xử lý, vì script không thể tiếp tục sau chúng. Để ghi lại những lỗi đó, hãy đăng ký một hàm shutdown đọc error_get_last().

Đọc lỗi gần nhất với error_get_last

Một số hàm trả về false và chỉ báo lý do dưới dạng cảnh báo, ví dụ file_get_contents với một tệp không tồn tại. error_get_last() trả về cảnh báo đó dưới dạng mảng, rất có ích khi bạn muốn hiện thông báo của riêng mình:

<?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";
}

Toán tử @ đặt trước lời gọi sẽ ẩn thông báo cho riêng biểu thức đó. Hãy dùng nó thật hạn chế và chỉ khi bạn kiểm tra kết quả ngay sau đó, như ở đây; một dấu @ đứng riêng chỉ che giấu bug.

Lỗi thường gặp: đã bật hiển thị lỗi nhưng trang vẫn trắng

Nếu bạn đã thêm ini_set('display_errors', '1') mà vẫn thấy trang trắng, rất có thể đó là lỗi cú pháp. PHP phân tích toàn bộ tệp trước khi chạy dòng đầu tiên, nên một dấu ; hay } bị thiếu sẽ dừng mọi thứ trước khi ini_set kịp chạy. Hãy kiểm tra tệp từ terminal, nơi thông báo luôn được in ra:

php -l index.php

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

Số dòng chỉ đến chỗ PHP bỏ cuộc, thường là dòng ngay sau lỗi thật. Hãy sửa nó, chạy lại php -l cho đến khi thấy No syntax errors detected, rồi tải lại trang.