Gỡ lỗi mã PHP là một phần của bất kỳ dự án nào, nhưng WordPress đi kèm với các hệ thống gỡ lỗi cụ thể được thiết kế để đơn giản hóa quy trình cũng như chuẩn hóa mã trên toàn bộ lõi, plugin và theme. Trang này mô tả các công cụ gỡ lỗi khác nhau có sẵn trong WordPress và cách để bạn làm việc hiệu quả hơn khi lập trình, cũng như nâng cao chất lượng và khả năng tương tác tổng thể của mã.
Đối với những người không phải lập trình viên hoặc người dùng thông thường, các tùy chọn này có thể được sử dụng để hiển thị thông tin chi tiết về lỗi.
LƯU Ý : Trước khi thực hiện bất kỳ thay đổi nào đối với trang web của bạn, hãy đảm bảo rằng bạn đã sử dụng môi trường thử nghiệm hoặc đã sao lưu trang web của mình một cách thích hợp.
Đoạn mã sau, được chèn vào tệp wp-config.php của bạn , sẽ ghi lại tất cả các lỗi, thông báo và cảnh báo vào một tệp có tên debug.logtrong wp-contentthư mục đó. Nó cũng sẽ ẩn các lỗi để chúng không làm gián đoạn quá trình tạo trang.
// Enable WP_DEBUG mode
define( 'WP_DEBUG', true );
// Enable Debug logging to the /wp-content/debug.log file
define( 'WP_DEBUG_LOG', true );
// Disable display of errors and warnings
define( 'WP_DEBUG_DISPLAY', false );
@ini_set( 'display_errors', 0 );
// Use dev versions of core JS and CSS files (only needed if you are modifying these core files)
define( 'SCRIPT_DEBUG', true );
LƯU Ý : Bạn phải chèn đoạn mã này TRƯỚC /* That's all, stop editing! Happy blogging. */ trong tệp wp-config.php .
WP_DEBUGlà một hằng số PHP (một biến toàn cục cố định) có thể được sử dụng để kích hoạt chế độ "gỡ lỗi" trong toàn bộ WordPress. Theo mặc định, nó được coi là false, và thường được đặt thành true trong tệp wp-config.php trên các bản sao WordPress dành cho nhà phát triển.
// This enables debugging.
define( 'WP_DEBUG', true );
// This disables debugging.
define( 'WP_DEBUG', false );
Lưu ý : Các giá trị true`and` falsetrong ví dụ không được bao quanh bởi dấu nháy đơn (') vì chúng là các giá trị boolean (đúng/sai). Nếu bạn đặt các hằng số thành `true` 'false', chúng sẽ được hiểu là đúng vì dấu nháy đơn biến nó thành chuỗi chứ không phải là boolean.
Không nên sử dụng WP_DEBUGcác công cụ gỡ lỗi này trên các trang web đang hoạt động; chúng chỉ dành cho việc kiểm thử cục bộ và cài đặt thử nghiệm.
Việc kích hoạt tùy chọn này WP_DEBUGsẽ hiển thị tất cả các lỗi, thông báo và cảnh báo của PHP. Điều này có thể làm thay đổi hành vi mặc định của PHP, vốn chỉ hiển thị các lỗi nghiêm trọng hoặc màn hình trắng khi xảy ra lỗi.
Việc hiển thị tất cả các thông báo và cảnh báo PHP thường dẫn đến các thông báo lỗi cho những thứ dường như không bị hỏng, nhưng lại không tuân theo các quy ước xác thực dữ liệu thích hợp trong PHP. Những cảnh báo này rất dễ khắc phục một khi đã xác định được đoạn mã liên quan, và mã kết quả hầu như luôn ít bị lỗi hơn và dễ bảo trì hơn.
Nếu cần ghi nhật ký thông tin không phải lỗi để phục vụ mục đích gỡ lỗi, PHP cung cấp error_loghàm này. Tuy nhiên, phương pháp này không cung cấp định dạng đầu ra đúng cách theo mặc định.
Để giải quyết vấn đề này, bạn có thể thêm một hàm khác vào trang web của mình để xử lý định dạng, bằng cách tạo một plugin tùy chỉnh hoặc sử dụng một đoạn mã với một số plugin đoạn mã . Hàm này sẽ hoạt động như một lớp bao bọc để error_logđịnh print_rdạng mảng và đối tượng một cách chính xác trước khi ghi nhật ký chúng.
Dưới đây là một ví dụ về hàm cần WP_DEBUGđược kích hoạt.
function write_log( $data ) {
if ( true === WP_DEBUG ) {
if ( is_array( $data ) || is_object( $data ) ) {
error_log( print_r( $data, true ) );
} else {
error_log( $data );
}
}
}
Ví dụ sử dụng:
write_log( 'DEBUG TEXT' );
write_log( $variable );
Lưu ý : Không nên thêm mã tùy chỉnh như ví dụ trên functions.phpđể tránh các vấn đề về bảo trì, bảo mật, hiệu năng, khả năng tương thích và tổ chức mã.
Việc kích hoạt tính năng này WP_DEBUGcũng sẽ hiển thị thông báo về các hàm và đối số đã lỗi thời trong WordPress đang được sử dụng trên trang web của bạn. Đây là các hàm hoặc đối số hàm chưa bị xóa khỏi mã nguồn chính, nhưng dự kiến sẽ bị xóa trong tương lai gần. Thông báo lỗi thời thường chỉ ra hàm mới nên được sử dụng thay thế.
WP_DEBUG_LOGĐây là một công cụ bổ trợ cho WP_DEBUG, giúp lưu tất cả các lỗi vào một debug.logtệp nhật ký. Điều này hữu ích nếu bạn muốn xem lại tất cả các thông báo sau này hoặc cần xem các thông báo được tạo ra ngoài màn hình (ví dụ: trong quá trình yêu cầu hoặc chạy AJAX wp-cron).
Lưu ý rằng điều này cho phép bạn ghi vào tệp nhật ký bằng error_log()chức năng tích hợp sẵn của PHP, điều này có thể hữu ích, ví dụ như khi gỡ lỗi các sự kiện Ajax.
Khi được đặt thành true, nhật ký sẽ được lưu vào debug.logthư mục nội dung (thường là wp-content/debug.log) trong hệ thống tệp của trang web. Ngoài ra, bạn có thể đặt nó thành một đường dẫn tệp hợp lệ để lưu tệp ở nơi khác.
define( 'WP_DEBUG_LOG', true );
-hoặc-
define( 'WP_DEBUG_LOG', '/tmp/wp-errors.log' );
Lưu ý : để WP_DEBUG_LOGthực hiện bất kỳ thao tác nào, WP_DEBUGcần phải bật (true). Hãy nhớ rằng, bạn có thể tắt WP_DEBUG_DISPLAYđộc lập.
WP_DEBUG_DISPLAYlà một thành phần bổ trợ khác WP_DEBUGkiểm soát việc hiển thị thông báo gỡ lỗi bên trong mã HTML của trang hay không. Mặc định là 'true', nghĩa là hiển thị lỗi và cảnh báo ngay khi chúng được tạo ra. Đặt thành 'false' sẽ ẩn tất cả lỗi. Thành phần này nên được sử dụng cùng với WP_DEBUG_LOGđể có thể xem lại lỗi sau này.
define( 'WP_DEBUG_DISPLAY', false );
Lưu ý : để WP_DEBUG_DISPLAYthực hiện bất kỳ thao tác nào, WP_DEBUGcần phải bật (true). Hãy nhớ rằng, bạn có thể điều khiển WP_DEBUG_LOGđộc lập.
SCRIPT_DEBUGlà một hằng số liên quan sẽ buộc WordPress sử dụng các phiên bản “dev” của các tệp CSS và JavaScript cốt lõi thay vì các phiên bản thu nhỏ thường được tải. Điều này hữu ích khi bạn đang thử nghiệm các sửa đổi đối với bất kỳ tệp .jshoặc .cssthư viện tích hợp nào. Giá trị mặc định là false.
define( 'SCRIPT_DEBUG', true );
Định nghĩa này SAVEQUERIESlưu các truy vấn cơ sở dữ liệu vào một mảng, sau đó có thể hiển thị để giúp phân tích các truy vấn đó. Khi hằng số được đặt thành true, nó sẽ khiến mỗi truy vấn được lưu lại cùng với thời gian thực thi và hàm đã gọi nó.
define( 'SAVEQUERIES', true );
Mảng được lưu trữ trong biến toàn cục $wpdb->queries.
LƯU Ý : Việc này sẽ ảnh hưởng đến hiệu suất của trang web, vì vậy hãy đảm bảo tắt chức năng này khi bạn không đang gỡ lỗi.
Có rất nhiều plugin gỡ lỗi cho WordPress hiển thị nhiều thông tin hơn về hoạt động bên trong, cho một thành phần cụ thể hoặc tổng quát.
Ví dụ, Debug Bar thêm một menu gỡ lỗi vào thanh quản trị hiển thị thông tin truy vấn, bộ nhớ cache và các thông tin gỡ lỗi hữu ích khác. Khi WP_DEBUG được bật, nó cũng theo dõi các cảnh báo và thông báo PHP để giúp bạn dễ dàng tìm thấy chúng hơn.