分析 WordPress `wpdb` 类的 `get_results()` 方法源码：如何将查询结果转换为对象数组或关联数组。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

大家好，我是今天的主讲人，咱们今天聊聊WordPress数据库操作的核心——wpdb 类的 get_results() 方法，重点是它如何把数据库里冷冰冰的数据，变成我们程序里活灵活现的对象数组或关联数组。准备好了吗？咱们开始！

一、开场白：认识一下老朋友 wpdb 和 get_results()

在WordPress的世界里，wpdb 类就是你的数据库代理人，你和数据库之间的桥梁。它封装了各种数据库操作，让你可以用面向对象的方式来操作数据库，而不用直接写那些复杂的SQL语句（当然，直接写SQL也没问题，wpdb 也支持）。

get_results() 方法，顾名思义，就是用来获取查询结果的。你可以用它执行任何SELECT查询，然后它会把结果按照你指定的方式返回给你。

二、 get_results() 方法的签名和参数

咱们先看看 get_results() 方法的庐山真面目：

/**
 * Executes a SQL query and returns the entire result set as an array.
 *
 * @since 0.71
 *
 * @param string      $query     The SQL query to execute.
 * @param string|int  $output    Optional. The required return type. One of OBJECT, OBJECT_K, ARRAY_A, ARRAY_N, or an integer representing the column to fetch. Default OBJECT.
 * @param int|int     $y         Optional. Offset for starting row. For integer values of `$output` this specifies which column to return. Default 0.
 *
 * @return array|object|null May return an array of database query results, or null if query is empty.
 *                          (Might return an empty array if query is valid with no results.)
 */
public function get_results( $query = null, $output = OBJECT ) {
    // 方法体内容
}

参数解释：

$query: 这是你要执行的SQL查询语句，字符串类型。比如 "SELECT * FROM wp_posts WHERE post_status = 'publish'"。
$output: 这是最重要的参数，决定了结果的返回形式。它有几个可选值：
- OBJECT: 返回对象数组，数组的每个元素都是一个对象，对象的属性对应数据库表的字段。
- OBJECT_K: 返回对象数组，数组的键是数据库表的第一列的值，值是对象。
- ARRAY_A: 返回关联数组，数组的每个元素都是一个关联数组，键是数据库表的字段名，值是字段的值。
- ARRAY_N: 返回数字索引数组，数组的每个元素都是一个数字索引数组，索引对应数据库表的列的顺序，值是字段的值。
- int: 返回单列数组，数组的每个元素都是指定的列的值。$y 参数会指定列的索引。
$y: 这个参数只有在 $output 为整数时才有效，用来指定要返回的列的索引。默认是0，也就是第一列。

返回值：

成功：返回查询结果数组（类型取决于 $output 参数）。
失败/无结果：返回 null (旧版本可能返回空数组)。

三、源码解析：深入 get_results() 方法的内部世界

get_results() 的核心逻辑都在其方法体内部。咱们简化一下，提取关键部分，方便理解：

public function get_results( $query = null, $output = OBJECT ) {
    // 1. 预处理和安全检查（省略）

    // 2. 执行查询
    $this->query( $query );

    // 3. 处理结果
    $return_value = null;
    if ( $this->num_rows ) {
        $return_value = array();
        while ( $row = $this->fetch_object() ) { // 获取一行数据，默认是对象
            $return_value[] = $row;
        }

        // 根据 $output 参数转换结果
        if ( OBJECT == $output ) {
            // 已经是对象数组，不需要转换
        } elseif ( OBJECT_K == $output ) {
            $return_value = $this->index_by_column( $return_value, 0 );
        } elseif ( ARRAY_A == $output ) {
            $return_value = array_map( array( $this, 'convert_to_array' ), $return_value );
        } elseif ( ARRAY_N == $output ) {
            $return_value = array_map( array( $this, 'convert_to_numeric_array' ), $return_value );
        } elseif ( is_int( $output ) ) {
            $return_value = $this->get_col( $output );
        }
    }

    // 4. 返回结果
    return $return_value;
}

主要步骤：

预处理和安全检查: 这部分代码主要是对查询语句进行一些处理，比如检查是否为空，是否需要转义等等。咱们重点关注结果转换，所以这部分就省略了。
执行查询: $this->query( $query ) 负责执行SQL查询。这是wpdb类的核心方法，它会连接数据库，发送SQL语句，并获取结果。
处理结果: 这是最关键的部分，根据 $output 参数来决定如何转换查询结果。
- 获取原始数据: while ( $row = $this->fetch_object() ) 循环获取查询结果的每一行。 $this->fetch_object() 默认返回一个对象，对象的属性对应数据库表的字段。
- 结果转换: 根据 $output 的值，对原始数据进行转换。
  - OBJECT: 如果 $output 是 OBJECT，那么 $return_value 已经是对象数组了，不需要做任何转换。
  - OBJECT_K: 如果 $output 是 OBJECT_K，调用 $this->index_by_column( $return_value, 0 ) 方法，将对象数组转换为键值对形式的数组，键是第一列的值。
  - ARRAY_A: 如果 $output 是 ARRAY_A，调用 array_map( array( $this, 'convert_to_array' ), $return_value ) 方法，将对象数组转换为关联数组数组。convert_to_array 方法负责将一个对象转换为关联数组。
  - ARRAY_N: 如果 $output 是 ARRAY_N，调用 array_map( array( $this, 'convert_to_numeric_array' ), $return_value ) 方法，将对象数组转换为数字索引数组数组。convert_to_numeric_array 方法负责将一个对象转换为数字索引数组。
  - int: 如果 $output 是一个整数，调用 $this->get_col( $output ) 方法，获取指定列的值，返回一个单列数组。
返回结果: 最后，将转换后的结果 $return_value 返回。

四、关键辅助方法：index_by_column(), convert_to_array(), convert_to_numeric_array(), get_col()

为了更好地理解 get_results() 的工作原理，咱们需要深入了解几个辅助方法：

index_by_column( $array, $index ):

这个方法用于将一个数组按照指定的列进行索引。也就是说，将数组的键设置为指定列的值，值设置为数组的元素。

protected function index_by_column( $array, $index ) {
    $new_array = array();
    if ( ! is_array( $array ) ) {
        return $new_array;
    }

    foreach ( (array) $array as $row ) {
        if ( is_object( $row ) ) {
            $row = get_object_vars( $row );
        }

        if ( isset( $row[ $index ] ) ) {
            $new_array[ $row[ $index ] ] = $row;
        }
    }

    return $new_array;
}

简单来说，它遍历数组，取出每个元素的指定列的值，作为新数组的键，元素本身作为值。

convert_to_array( $object ):

这个方法用于将一个对象转换为关联数组。
```
protected function convert_to_array( $object ) {
    return (array) $object;
}
```
非常简单粗暴，直接使用 (array) 强制类型转换。
convert_to_numeric_array( $object ):

这个方法用于将一个对象转换为数字索引数组。
```
protected function convert_to_numeric_array( $object ) {
    return array_values( (array) $object );
}
```
先将对象转换为关联数组，然后使用 array_values() 函数取出关联数组的值，组成一个新的数字索引数组。

get_col( $column_number = 0 ):

这个方法用于获取指定列的值，返回一个单列数组。

public function get_col( $column_number = 0 ) {
    if ( ! isset( $this->last_result[0] ) ) {
        return array();
    }

    $return = array();
    foreach ( (array) $this->last_result as $row ) {
        $row = (array) $row;
        if ( array_key_exists( $column_number, $row ) ) {
            $return[] = $row[ $column_number ];
        } else {
            return array();
        }
    }

    return $return;
}

它遍历 $this->last_result (存储了上次查询的结果)，取出每一行的指定列的值，组成一个新的数组。

五、代码示例：演示不同 $output 值的效果

咱们来几个例子，看看不同 $output 值会产生什么样的结果：

global $wpdb;

// 1. 获取对象数组
$posts = $wpdb->get_results( "SELECT ID, post_title FROM wp_posts LIMIT 3", OBJECT );

echo "对象数组：n";
echo "<pre>";
print_r( $posts );
echo "</pre>";

// 2. 获取键值对形式的对象数组 (ID 作为键)
$posts_keyed = $wpdb->get_results( "SELECT ID, post_title FROM wp_posts LIMIT 3", OBJECT_K );

echo "键值对形式的对象数组：n";
echo "<pre>";
print_r( $posts_keyed );
echo "</pre>";

// 3. 获取关联数组
$posts_array_a = $wpdb->get_results( "SELECT ID, post_title FROM wp_posts LIMIT 3", ARRAY_A );

echo "关联数组：n";
echo "<pre>";
print_r( $posts_array_a );
echo "</pre>";

// 4. 获取数字索引数组
$posts_array_n = $wpdb->get_results( "SELECT ID, post_title FROM wp_posts LIMIT 3", ARRAY_N );

echo "数字索引数组：n";
echo "<pre>";
print_r( $posts_array_n );
echo "</pre>";

// 5. 获取ID列的单列数组
$post_ids = $wpdb->get_results( "SELECT ID, post_title FROM wp_posts LIMIT 3", 0 ); // 0 表示第一列 (ID)

echo "ID列的单列数组：n";
echo "<pre>";
print_r( $post_ids );
echo "</pre>";

运行这段代码，你会看到不同的输出结果，对应不同的 $output 值。

六、表格总结：各种 $output 值的特性

为了更清晰地对比各种 $output 值，咱们用一个表格来总结一下：

`$output` 值	返回类型	数组结构	访问方式	适用场景
`OBJECT`	对象数组	`[object(stdClass), object(stdClass), ...]`	`$post->ID`, `$post->post_title`	默认值，方便使用对象属性访问数据，代码可读性好。
`OBJECT_K`	对象数组	`[ 'ID' => object(stdClass), ... ]`	`$posts['ID']->post_title`	需要根据某个字段的值来快速查找对象时。
`ARRAY_A`	关联数组	`[ ['ID' => 1, 'post_title' => '...'], ... ]`	`$post['ID']`, `$post['post_title']`	需要将数据传递给期望关联数组的函数时，例如 `wp_parse_args()`。
`ARRAY_N`	数字索引数组	`[ [1, '...'], ... ]`	`$post[0]`, `$post[1]`	对性能要求较高，且不关心字段名时。
`int`	单列数组	`[1, 2, 3, ... ]`	`$post_id`	只需要获取某一列的值时，例如获取所有文章ID。

七、注意事项：一些避坑指南

SQL注入： 永远不要直接将用户输入拼接到SQL查询语句中。使用 $wpdb->prepare() 方法来防止SQL注入。
性能： 尽量只查询需要的字段，避免 SELECT *。
错误处理： get_results() 方法在查询失败时可能返回 null，所以要检查返回值是否为 null。
编码： 确保数据库连接和WordPress的编码一致，避免乱码问题。
数据类型： 数据库字段的数据类型会影响返回值的类型。例如，如果数据库字段是整数类型，那么返回的值也是整数类型。
查询优化： 合理使用索引，优化SQL查询语句，提高查询效率。
$wpdb->last_error: 使用$wpdb->last_error可以查看最后一次查询的错误信息，方便调试。

八、总结：灵活运用 get_results()，玩转WordPress数据库

wpdb 类的 get_results() 方法是一个非常强大和灵活的工具，可以帮助我们轻松地从WordPress数据库中获取数据，并将其转换为各种不同的形式。理解它的工作原理，掌握各种 $output 值的特性，可以让我们更加高效地开发WordPress主题和插件。希望今天的讲解能帮助大家更好地理解和使用 get_results() 方法。下次遇到数据库查询的问题，别忘了想起今天的内容哦！

祝大家编程愉快！

发表回复 取消回复

发表回复取消回复