WordPress REST API 如何隐藏 PHP 错误细节并记录日志
结论
别指望在 set_error_handler 里直接返回 REST API 响应。该函数只处理可捕获的 PHP 错误,返回值也只在 PHP 错误处理链里有意义,不会变成 HTTP 响应。实际可做的处理是:关闭错误详情输出;在 REST 回调里把错误或异常写入 error_log,再用 WP_Error 返回简略的 500;遇到致命错误时,用 register_shutdown_function 配合 error_get_last() 记录,并尽量输出简略的 JSON 响应。
原因
set_error_handler 无法处理 E_ERROR、E_PARSE 这类致命错误。在处理器里直接 echo 或调用 wp_send_json_error() 会提前结束请求,绕过 REST 生命周期,也容易出现重复输出。REST API 的正常错误应通过 WP_Error 或 WP_REST_Response 返回。致命错误出现后,REST 回调已经走不到了,只能在请求结束阶段做补救。
先在配置里关闭错误详情
在 wp-config.php 中确保生产环境不显示错误:
define('WP_DEBUG', false);
define('WP_DEBUG_DISPLAY', false);
define('WP_DEBUG_LOG', true); // 可选:写入 wp-content/debug.log
@ini_set('display_errors', '0');
@ini_set('log_errors', '1');
如果服务器已经配置了 error_log,error_log() 会把内容写到对应目标。要注意,WP_DEBUG_LOG 和 PHP 的 error_log 配置不是同一个开关,实际写入路径以服务器配置为准。
可捕获的错误:在 REST 回调里记录并返回 WP_Error
可捕获错误可以这样处理:
add_action('rest_api_init', function () {
register_rest_route('myplugin/v1', '/demo', [
'methods' => 'GET',
'callback' => function (WP_REST_Request $request) {
set_error_handler(function ($errno, $errstr, $errfile, $errline) {
if (!(error_reporting() & $errno)) {
return false;
}
$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
error_log(
'[REST PHP error] ' . $errstr . ' in ' . $errfile . ':' . $errline .
PHP_EOL . print_r($trace, true)
);
throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
});
try {
// 你的业务代码
// trigger_error('demo warning', E_USER_WARNING);
return rest_ensure_response(['ok' => true]);
} catch (Throwable $e) {
error_log(
'[REST exception] ' . $e->getMessage() .
PHP_EOL . $e->getTraceAsString()
);
return new WP_Error(
'internal_error',
'服务器内部错误',
['status' => 500]
);
} finally {
restore_error_handler();
}
},
]);
});
处理器只负责记录并抛出 ErrorException,真正的 REST 响应由 catch 里的 WP_Error 返回。客户端只会看到 internal_error 和“服务器内部错误”,完整错误和 backtrace 留在日志里。
致命错误:在 shutdown 里记录,并尽量返回简略的 500
set_error_handler 捕获不到致命错误,需要单独处理:
register_shutdown_function(function () {
$err = error_get_last();
if (!$err) {
return;
}
$fatalTypes = [E_ERROR, E_PARSE, E_CORE_ERROR, E_COMPILE_ERROR, E_USER_ERROR];
if (!in_array($err['type'], $fatalTypes, true)) {
return;
}
if (!defined('REST_REQUEST') || !REST_REQUEST) {
return;
}
error_log(
'[REST fatal] ' . $err['message'] .
' in ' . $err['file'] . ':' . $err['line']
);
if (!headers_sent()) {
status_header(500);
header('Content-Type: application/json; charset=utf-8');
echo wp_json_encode([
'code' => 'internal_error',
'message' => '服务器内部错误',
'data' => ['status' => 500],
]);
}
});
这段代码只在 REST_REQUEST 为真时尝试输出 JSON。响应头已经发送时,headers_sent() 会阻止重复输出,这时只能依靠日志和服务器层配置。不同 WordPress 版本中,核心致命错误处理器的执行顺序可能不一样,建议在目标环境里实测,并尽量在 mu-plugin 或加载很早的插件中注册。
注意事项
- 不要在
set_error_handler里直接调用wp_send_json_error()再exit,除非你明确接受绕过 REST 生命周期。更稳妥的做法是抛出异常,让回调去捕获。 - 日志里不要写密码、token、完整请求参数等敏感数据;错误详情只进日志,不要返回给客户端。
- 生产环境应关闭
display_errors,并限制日志文件权限。 - 使用
WP_DEBUG_LOG时,WordPress 自己可能也会记录部分错误;自定义日志和核心日志可能重复,按环境取舍。 - 上面的 shutdown 方案只是补充手段,不能保证覆盖所有致命错误场景。Web 服务器和 PHP 层的错误处理仍要配置正确。
备注:内容仅供参考。
