详解 WordPress `wpdb` 类的 `last_error` 属性：如何在调试时获取最近一次数据库操作的错误信息。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，大家好！我是今天的主讲人，咱们今天来聊聊 WordPress 里那个让人又爱又恨的 wpdb 类，特别是它那个关键的 last_error 属性。这玩意儿啊，就像你家猫主子的性格，捉摸不透，但关键时刻又能救你一命。

咱们今天就来扒一扒 last_error 的皮，看看它到底是个什么东西，以及如何在调试的时候，把它用得炉火纯青。

开场白：wpdb 是什么？

在 WordPress 的世界里，数据都存在数据库里，而 wpdb 类就是 WordPress 官方提供的，用来跟数据库打交道的接口。你可以把它想象成一个专业的数据库翻译，你跟它说人话（PHP 代码），它负责翻译成数据库能听懂的 SQL 语句，然后把数据库返回的结果再翻译成人话给你。

last_error：数据库操作的晴雨表

wpdb 类提供了一堆方法，比如 query(), insert(), update(), delete() 等等，让你能对数据库进行各种操作。但是，数据库操作嘛，难免会出错。可能是 SQL 语句写错了，可能是数据库权限不够，也可能是数据库服务器抽风了。

这时候，last_error 就派上用场了。它就像一个晴雨表，记录了 wpdb 类最近一次执行的数据库操作是否成功。如果成功了，它就是空的（或者说，是 null）；如果出错了，它就会包含错误信息。

last_error 的真面目：字符串

last_error 属性是一个字符串，它包含了 MySQL 服务器返回的错误信息。这个错误信息通常会告诉你发生了什么错误，以及错误发生的位置。

如何访问 last_error？

要访问 last_error 属性，你需要先获取 wpdb 类的实例，然后通过 -> 符号来访问它。一般来说，全局变量 $wpdb 就是 wpdb 类的实例，可以直接使用。

global $wpdb;

// 执行一个可能会出错的数据库操作
$wpdb->query("SELECT * FROM non_existent_table");

// 检查是否有错误发生
if ($wpdb->last_error) {
  echo "数据库出错了： " . $wpdb->last_error;
}

实战演练：各种错误场景下的 last_error

光说不练假把式，咱们来模拟几种常见的数据库错误场景，看看 last_error 会返回什么信息。

场景一：表不存在

global $wpdb;

$wpdb->query("SELECT * FROM non_existent_table");

if ($wpdb->last_error) {
  echo "数据库出错了： " . $wpdb->last_error;
}

输出：

数据库出错了： Table 'your_database_name.non_existent_table' doesn't exist

last_error 告诉你 non_existent_table 这个表不存在。

场景二：SQL 语法错误

global $wpdb;

$wpdb->query("SELECT FROM users"); // 缺少字段列表

if ($wpdb->last_error) {
  echo "数据库出错了： " . $wpdb->last_error;
}

输出：

数据库出错了： You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'FROM users' at line 1

last_error 告诉你 SQL 语句有语法错误，并且指出了错误的大概位置。

场景三：字段不存在

global $wpdb;

$wpdb->query("SELECT non_existent_column FROM users");

if ($wpdb->last_error) {
  echo "数据库出错了： " . $wpdb->last_error;
}

输出：

数据库出错了： Unknown column 'non_existent_column' in 'field list'

last_error 告诉你 non_existent_column 这个字段不存在。

场景四：重复插入数据（违反唯一约束）

假设 users 表有一个 username 字段，并且设置了唯一约束。

global $wpdb;

$wpdb->insert(
    'users',
    array(
        'username' => 'existing_user',
        'email' => '[email protected]'
    )
);

if ($wpdb->last_error) {
  echo "数据库出错了： " . $wpdb->last_error;
}

输出（取决于你的数据库配置和表结构）：

数据库出错了： Duplicate entry 'existing_user' for key 'username'

last_error 告诉你违反了 username 字段的唯一约束。

场景五：权限不足

假设你的 WordPress 用户没有执行 DROP TABLE 操作的权限。

global $wpdb;

$wpdb->query("DROP TABLE users");

if ($wpdb->last_error) {
  echo "数据库出错了： " . $wpdb->last_error;
}

输出：

数据库出错了： DROP command denied to user 'your_wordpress_user'@'localhost' for table 'users'

last_error 告诉你当前用户没有删除 users 表的权限。

最佳实践：如何优雅地使用 last_error

每次数据库操作后都要检查 last_error

不要偷懒！每次执行完数据库操作后，都要立即检查 last_error 是否为空。如果为空，说明操作成功；如果不为空，说明操作失败，需要进行相应的处理。

global $wpdb;

$result = $wpdb->insert(
    'users',
    array(
        'username' => 'new_user',
        'email' => '[email protected]'
    )
);

if ($wpdb->last_error) {
  // 记录错误日志
  error_log("数据库插入错误： " . $wpdb->last_error);

  // 显示友好的错误提示信息
  wp_die("数据库操作失败，请稍后再试。");
} else {
  // 操作成功
  echo "用户创建成功！";
}

使用 error_log() 记录错误日志

不要把错误信息直接显示给用户看，这很不专业，而且可能会暴露敏感信息。应该使用 error_log() 函数将错误信息记录到服务器的错误日志中，方便以后进行调试和分析。
显示友好的错误提示信息

如果数据库操作失败，应该显示一个友好的错误提示信息给用户，告诉他们发生了什么错误，以及应该怎么做。不要直接把 last_error 的内容显示给用户看，这会让用户感到困惑和害怕。
使用 wp_die() 函数停止程序执行

如果数据库操作失败，并且无法继续执行程序，应该使用 wp_die() 函数停止程序的执行，并显示一个错误提示信息。这可以防止程序出现更严重的错误。

封装数据库操作

为了方便管理和维护，可以将数据库操作封装成函数或者类。这样可以避免重复编写相同的代码，并且可以更好地控制数据库操作的流程。

function create_user($username, $email) {
    global $wpdb;

    $result = $wpdb->insert(
        'users',
        array(
            'username' => $username,
            'email' => $email
        )
    );

    if ($wpdb->last_error) {
      error_log("数据库插入错误： " . $wpdb->last_error);
      return false; // 返回 false 表示操作失败
    } else {
      return true; // 返回 true 表示操作成功
    }
}

// 使用封装后的函数
if (create_user('another_user', '[email protected]')) {
    echo "用户创建成功！";
} else {
    wp_die("用户创建失败，请稍后再试。");
}

使用 prepare() 方法防止 SQL 注入

wpdb 类的 prepare() 方法可以防止 SQL 注入攻击。在使用用户输入的数据进行数据库操作时，一定要使用 prepare() 方法进行处理。

global $wpdb;

$username = $_POST['username'];
$email = $_POST['email'];

// 使用 prepare() 方法防止 SQL 注入
$sql = $wpdb->prepare(
    "INSERT INTO users (username, email) VALUES (%s, %s)",
    $username,
    $email
);

$result = $wpdb->query($sql);

if ($wpdb->last_error) {
  error_log("数据库插入错误： " . $wpdb->last_error);
  wp_die("用户创建失败，请稍后再试。");
} else {
  echo "用户创建成功！";
}

last_error 的局限性

last_error 只能告诉你最近一次数据库操作是否出错，以及出错的原因。它不能告诉你之前发生的错误，也不能告诉你数据库的整体状态。

如果你需要更详细的数据库信息，可以使用 wpdb 类的其他属性和方法，比如 num_queries (查询次数), queries (查询记录), show_errors() (显示错误信息) 等等。

wpdb 常用方法和属性总结

为了方便大家查阅，这里列出一些 wpdb 类常用的方法和属性：

方法/属性	描述
`query()`	执行 SQL 查询。
`insert()`	插入数据到数据库表。
`update()`	更新数据库表中的数据。
`delete()`	从数据库表中删除数据。
`prepare()`	预处理 SQL 查询，防止 SQL 注入。
`get_results()`	执行 SQL 查询并返回结果集（通常是对象数组）。
`get_row()`	执行 SQL 查询并返回单行结果（通常是对象）。
`get_col()`	执行 SQL 查询并返回单列结果（通常是字符串数组）。
`get_var()`	执行 SQL 查询并返回单个变量值。
`last_error`	包含最近一次数据库操作的错误信息（字符串）。
`last_query`	包含最近一次执行的 SQL 查询语句（字符串）。
`num_queries`	记录了当前页面加载过程中执行的 SQL 查询总次数（整数）。
`queries`	包含所有执行过的 SQL 查询语句的数组（数组）。
`show_errors()`	开启或关闭数据库错误显示（通常在调试模式下使用）。

进阶技巧：自定义错误处理

如果你觉得 wpdb 默认的错误处理方式不够灵活，可以自定义错误处理函数。例如，你可以将错误信息发送到邮件或者 Slack 频道。

// 自定义错误处理函数
function my_custom_db_error_handler($error_message) {
    // 发送邮件
    wp_mail(
        '[email protected]',
        '数据库错误',
        "数据库出错了： " . $error_message
    );

    // 发送到 Slack 频道 (需要安装相应的插件或者库)
    // ...

    error_log("数据库错误： " . $error_message);
}

// 重写 wpdb 类的 query() 方法
class My_WPDB extends wpdb {
    public function query( $query ) {
        $result = parent::query( $query );

        if ( $this->last_error ) {
            my_custom_db_error_handler( $this->last_error );
            return false; // 返回 false 表示操作失败
        }

        return $result;
    }
}

// 使用自定义的 wpdb 类
global $wpdb;
$wpdb = new My_WPDB( DB_USER, DB_PASSWORD, DB_NAME, DB_HOST );

// 测试
$wpdb->query("SELECT * FROM non_existent_table"); // 这会触发自定义的错误处理函数

总结

wpdb 类的 last_error 属性是 WordPress 调试中一个非常重要的工具。掌握了它的使用方法，可以帮助你快速定位和解决数据库问题。记住，每次数据库操作后都要检查 last_error，并且要使用 prepare() 方法防止 SQL 注入。希望今天的分享能帮助大家更好地使用 WordPress，写出更健壮的代码！

今天的讲座就到这里，谢谢大家！如果大家有什么问题，欢迎提问。

发表回复 取消回复

发表回复取消回复