剖析 WordPress `wpdb` 类的 `get_row()` 方法源码：如何通过 `_get_row_from_array()` 处理查询结果。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷们，今天咱来唠唠 WordPress wpdb 类里那个神秘又实用的 get_row() 方法。别看它名字平平无奇，背后可是藏着不少门道。特别是它的小助手 _get_row_from_array()，那更是个精巧的设计。咱们就来扒一扒它的底裤，看看它到底是怎么把数据库查询结果变成我们想要的香喷喷的数据对象的。

开场白：get_row() 的前世今生

在 WordPress 的世界里，wpdb 类就像一个万能的数据库管家，你想从数据库里拿点啥，都得找它。 get_row() 就是它手里的一个常用工具，专门用来获取数据库查询结果的第一行。它可以把这一行数据变成一个对象、一个关联数组，或者一个数字索引数组，完全取决于你的心情和需求。

<?php
global $wpdb;

// 获取 users 表中 ID 为 1 的用户数据，返回一个对象
$user = $wpdb->get_row( "SELECT * FROM {$wpdb->users} WHERE ID = 1" );

if ( $user ) {
  echo "用户ID: " . $user->ID . "n";
  echo "用户名: " . $user->user_login . "n";
}

// 获取 posts 表中 post_title 为 'Hello World' 的文章数据，返回一个关联数组
$post = $wpdb->get_row( "SELECT * FROM {$wpdb->posts} WHERE post_title = 'Hello World'", ARRAY_A );

if ( $post ) {
  echo "文章标题: " . $post['post_title'] . "n";
  echo "文章内容: " . $post['post_content'] . "n";
}

// 获取 options 表中 option_name 为 'siteurl' 的选项数据，返回一个数字索引数组
$option = $wpdb->get_row( "SELECT * FROM {$wpdb->options} WHERE option_name = 'siteurl'", ARRAY_N );

if ( $option ) {
  echo "站点URL: " . $option[1] . "n"; // 注意索引从0开始
}
?>

看到没？ get_row() 就像一个变形金刚，可以根据你给它的参数，变幻出不同的数据形态。而它之所以能这么灵活，很大程度上要归功于 _get_row_from_array() 这个幕后英雄。

_get_row_from_array()：数据变形记

_get_row_from_array() 是 wpdb 类的一个私有方法（名字前面有个下划线 _ 就说明是私有的，一般不建议直接调用）。它的主要职责就是把从数据库底层取回来的原始数据，转换成 get_row() 指定的格式。简单来说，它就是个数据格式转换器。

咱们来看看 _get_row_from_array() 的源码（基于 WordPress 6.3.1）：

<?php
/**
 * Transforms a row result from an array into an object, a hash,
 * or a numerically indexed array.
 *
 * @access protected
 * @since 3.5.0
 *
 * @param array  $row         The row result from the query.
 * @param string $output_type Optional. The required format of the result.
 *                              One of OBJECT, ARRAY_A, or ARRAY_N.
 *                              Default OBJECT.
 * @return object|array|null The row result in the required format. Null if $row is empty.
 */
protected function _get_row_from_array( $row, $output_type = OBJECT ) {
    if ( ! is_array( $row ) || empty( $row ) ) {
        return null;
    }

    if ( OBJECT === $output_type ) {
        return (object) $row;
    } elseif ( ARRAY_A === $output_type ) {
        return $row;
    } elseif ( ARRAY_N === $output_type ) {
        return array_values( $row );
    } else {
        return (object) $row; // 默认返回对象
    }
}
?>

这段代码看着挺唬人，其实逻辑很简单：

判空：首先检查 $row 是不是一个数组，并且是不是空的。如果是空的，那就直接返回 null，表示啥也没找到。
类型判断：然后根据 $output_type 参数的值，决定把 $row 转换成哪种格式。
- 如果 $output_type 是 OBJECT，就把 $row 强制转换成一个对象 (object) $row。这样，你就可以用 -> 符号来访问数据了，比如 $user->user_login。
- 如果 $output_type 是 ARRAY_A，那就直接返回 $row，不做任何修改。这样，你就可以用关联数组的方式来访问数据了，比如 $post['post_title']。
- 如果 $output_type 是 ARRAY_N，那就用 array_values() 函数把 $row 的键名去掉，只保留值，然后返回一个数字索引数组。这样，你就可以用数字索引来访问数据了，比如 $option[1]。
- 如果 $output_type 是其他值，那就默认返回一个对象。

代码剖析：逐行解读

咱们再来更细致地剖析一下 _get_row_from_array() 的代码，看看每一行都做了啥：

行号	代码	说明
1	`/** ... */`	这是文档注释，说明了这个函数的作用、参数和返回值。
11	`protected function _get_row_from_array( $row, $output_type = OBJECT ) {`	定义了一个受保护的函数 `_get_row_from_array()`，它接收两个参数：`$row` (要处理的数据数组) 和 `$output_type` (输出类型，默认为 `OBJECT`)。
12	`if ( ! is_array( $row ) \|\| empty( $row ) ) {`	检查 `$row` 是否不是数组或者是否为空。 `! is_array( $row )` 用于判断 `$row` 是否为数组，`empty( $row )` 用于判断 `$row` 是否为空。 `\|\|` 是逻辑或运算符，表示只要其中一个条件成立，整个表达式就成立。
13	`return null;`	如果 `$row` 不是数组或者为空，就返回 `null`。
16	`if ( OBJECT === $output_type ) {`	检查 `$output_type` 是否等于 `OBJECT`。 `===` 是全等运算符，表示不仅值相等，类型也要相等。
17	`return (object) $row;`	如果 `$output_type` 等于 `OBJECT`，就把 `$row` 强制转换成一个对象，并返回。
18	`} elseif ( ARRAY_A === $output_type ) {`	检查 `$output_type` 是否等于 `ARRAY_A`。 `elseif` 是 `else if` 的简写，表示如果前面的条件不成立，就检查这个条件。
19	`return $row;`	如果 `$output_type` 等于 `ARRAY_A`，就直接返回 `$row`，不做任何修改。
20	`} elseif ( ARRAY_N === $output_type ) {`	检查 `$output_type` 是否等于 `ARRAY_N`。
21	`return array_values( $row );`	如果 `$output_type` 等于 `ARRAY_N`，就使用 `array_values()` 函数把 `$row` 的值提取出来，组成一个新的数字索引数组，并返回。
22	`} else {`	如果 `$output_type` 不等于 `OBJECT`、`ARRAY_A` 或 `ARRAY_N`，就执行这个 `else` 块。
23	`return (object) $row;`	如果 `$output_type` 是其他值，就默认把 `$row` 强制转换成一个对象，并返回。
24	`}`	结束 `else` 块。
25	`}`	结束函数定义。

get_row() 内部的调用

_get_row_from_array() 并不是独立存在的，它是在 get_row() 内部被调用的。咱们来看看 get_row() 的源码（简化版，只保留关键部分）：

<?php
public function get_row( $query = null, $output = OBJECT, $y = 0 ) {
  // ... (执行查询，获取结果) ...

  if ( $this->last_result ) {
    if ( isset( $this->last_result[ $y ] ) ) {
      $row = $this->last_result[ $y ];
    } else {
      $row = null;
    }
    return $this->_get_row_from_array( $row, $output );
  }
  return null;
}
?>

可以看到，get_row() 在执行查询并获取结果后，会把结果数组中的第一行（或者第 $y 行）传递给 _get_row_from_array()，然后由 _get_row_from_array() 来决定如何格式化数据。

实例演示：三种输出类型的对比

为了更直观地理解 _get_row_from_array() 的作用，咱们来做一个简单的实例演示。假设咱们有一个名为 my_table 的表，结构如下：

列名	数据类型
id	INT
name	VARCHAR
value	TEXT

现在，咱们插入一条数据：

INSERT INTO my_table (name, value) VALUES ('test_name', 'test_value');

然后，咱们用 get_row() 来获取这条数据，并分别指定不同的 $output 类型：

<?php
global $wpdb;

// 获取对象
$row_object = $wpdb->get_row( "SELECT * FROM my_table WHERE name = 'test_name'", OBJECT );
echo "对象:n";
echo "ID: " . $row_object->id . "n";
echo "Name: " . $row_object->name . "n";
echo "Value: " . $row_object->value . "nn";

// 获取关联数组
$row_array_a = $wpdb->get_row( "SELECT * FROM my_table WHERE name = 'test_name'", ARRAY_A );
echo "关联数组:n";
echo "ID: " . $row_array_a['id'] . "n";
echo "Name: " . $row_array_a['name'] . "n";
echo "Value: " . $row_array_a['value'] . "nn";

// 获取数字索引数组
$row_array_n = $wpdb->get_row( "SELECT * FROM my_table WHERE name = 'test_name'", ARRAY_N );
echo "数字索引数组:n";
echo "ID: " . $row_array_n[0] . "n";
echo "Name: " . $row_array_n[1] . "n";
echo "Value: " . $row_array_n[2] . "n";
?>

运行这段代码，你会看到三种不同的输出格式。

选择合适的输出类型

那么，在实际开发中，我们应该选择哪种输出类型呢？这取决于你的具体需求和个人偏好。

OBJECT：如果你喜欢用 -> 符号来访问数据，或者你希望代码更具面向对象的风格，那么 OBJECT 是个不错的选择。
ARRAY_A：如果你喜欢用关联数组的方式来访问数据，或者你需要把数据传递给一些只能处理数组的函数，那么 ARRAY_A 可能会更方便。
ARRAY_N：除非你有特殊的需求，否则一般不建议使用 ARRAY_N。因为数字索引的可读性比较差，容易出错。

总而言之，选择哪种输出类型，最重要的是让你的代码更清晰、更易于维护。

总结：_get_row_from_array() 的价值

_get_row_from_array() 虽然只是个小小的私有方法，但它在 wpdb 类中扮演着重要的角色。它把数据格式转换的逻辑封装起来，使得 get_row() 方法更加灵活和易于使用。

通过对 _get_row_from_array() 的剖析，我们可以更深入地理解 wpdb 类的工作原理，也可以更好地利用 get_row() 方法来获取和处理数据库数据。

希望今天的讲座能对你有所帮助。记住，学习编程就像剥洋葱，一层一层地剥开，才能看到核心。咱们下回再见！

发表回复 取消回复

发表回复取消回复