剖析 WordPress `wpdb` 类的 `get_var()` 方法源码：如何获取单个变量值。

各位观众老爷，晚上好！ 今天咱们不聊风花雪月，只谈技术。今天的主题是：解剖WordPress的wpdb类中的get_var()方法，看看它是怎么从数据库里捞出一个“宝贝疙瘩”的。

一、 wpdb：WordPress的数据库“管家”

在WordPress的世界里，wpdb类就相当于你的私人数据库管家。它封装了数据库连接、查询、更新等一系列操作，让你不用直接面对那些复杂的SQL语句，就可以轻松地和数据库打交道。

首先，我们需要了解wpdb类的基本结构。它是一个全局对象，通常通过 $wpdb 访问。它包含了数据库连接信息（主机、用户名、密码、数据库名等），以及一系列用于执行SQL查询的方法。

二、 get_var()：单刀直入，取一个值

get_var()方法的作用很简单粗暴：从数据库里取出一个单独的值。就像你从一个宝箱里只拿走一件最心仪的宝贝一样。它只返回查询结果的第一行第一列的值。

三、源码剖析：一步一步，抽丝剥茧

我们先来看一下get_var()方法的源码（基于WordPress 6.x版本）：

    /**
     * Gets one variable from the database.
     *
     * @param string|null $query   Query to execute.
     * @param int         $column_offset Optional column offset. Default 0.
     * @param int         $row_offset    Optional row offset. Default 0.
     * @return string|null The value retrieved from the database. `null` if there is an error.
     */
    public function get_var( $query = null, $column_offset = 0, $row_offset = 0 ) {
        $return_val = null;

        $query = trim( $query );
        if ( empty( $query ) ) {
            return $return_val;
        }

        $this->func_call = __FUNCTION__;
        $this->call_args = func_get_args();

        // If caching is enabled, get the key and value.
        if ( $this->use_mysqli ) {
            $key = $this->get_cache_key( $query );
        } else {
            $key = md5( $query );
        }

        if ( isset( $this->query_cache[ $key ] ) ) {
            $return_val = $this->query_cache[ $key ][ $row_offset ][ $column_offset ];
            $this->num_queries++;
            $this->last_query = $query;
            $this->add_call_back( $query, $return_val );
            return $return_val;
        }

        $this->flush();

        // Query was not loaded into the cache yet.
        $this->result = @$this->query( $query );

        if ( $this->last_error ) {
            $this->add_error( $this->last_error );
            if ( $this->show_errors ) {
                wp_die( $this->last_error );
            }

            return $return_val;
        }

        if ( $this->num_rows ) {
            $this->last_result = $this->result;

            if ( is_object( $this->result ) ) {
                if ( $this->use_mysqli ) {
                    if ( $this->result->num_rows > 0 ) {
                        $this->result->data_seek( $row_offset );
                        $the_row = $this->result->fetch_row();
                        $return_val = $the_row[ $column_offset ];
                    }
                } else {
                    $this->seek( $row_offset );
                    $return_val = $this->vardata( $column_offset );
                }
            } else {
                $return_val = $this->result[ $row_offset ][ $column_offset ];
            }

            $this->query_cache[ $key ][ $row_offset ][ $column_offset ] = $return_val;

            if ( $this->use_mysqli ) {
                if ( is_object( $this->result ) ) {
                    $this->result->free();
                }
            } else {
                @mysql_free_result( $this->result );
            }

            $this->last_query = $query;
            $this->add_call_back( $query, $return_val );

            return $return_val;
        }

        return $return_val;
    }

现在，咱们一行一行地分析：

1. 参数接收：

   • $query：要执行的SQL查询语句。这是最重要的参数，决定了你要从数据库里捞什么。
   • $column_offset：指定要返回结果的列的偏移量，默认为0，也就是第一列。
   • $row_offset：指定要返回结果的行的偏移量，默认为0，也就是第一行。

2. 空查询检查：

   $query = trim( $query );
   if ( empty( $query ) ) {
       return $return_val;
   }

   首先去除$query首尾的空格，然后检查查询语句是否为空。如果为空，直接返回null。 避免执行空查询。

3. 函数调用信息记录：

   $this->func_call = __FUNCTION__;
   $this->call_args = func_get_args();

   这两行代码记录了函数名和参数，主要是为了方便调试和追踪。

4. 缓存机制：

   if ( $this->use_mysqli ) {
       $key = $this->get_cache_key( $query );
   } else {
       $key = md5( $query );
   }
   
   if ( isset( $this->query_cache[ $key ] ) ) {
       $return_val = $this->query_cache[ $key ][ $row_offset ][ $column_offset ];
       $this->num_queries++;
       $this->last_query = $query;
       $this->add_call_back( $query, $return_val );
       return $return_val;
   }

   WordPress为了提高效率，对查询结果进行了缓存。 首先，根据查询语句生成一个缓存键$key。如果缓存中已经存在该查询的结果，则直接从缓存中读取并返回，无需再次查询数据库。 注意，如果使用了 mysqli 扩展，会使用 get_cache_key() 方法生成更复杂的键，否则使用简单的 md5() 哈希。

5. 刷新结果：

   $this->flush();

   如果查询不在缓存中，则调用 $this->flush() 方法清空之前的查询结果，为新的查询腾出空间。

6. 执行查询：

   $this->result = @$this->query( $query );

   这是最关键的一步：执行SQL查询。$this->query() 方法负责将查询语句发送到数据库服务器，并获取查询结果。 @ 符号表示忽略错误，因为错误处理在后面的代码中进行。

7. 错误处理：

   if ( $this->last_error ) {
       $this->add_error( $this->last_error );
       if ( $this->show_errors ) {
           wp_die( $this->last_error );
       }
   
       return $return_val;
   }

   如果查询过程中发生错误（例如SQL语法错误、连接失败等），$this->last_error 会包含错误信息。这里会将错误信息添加到错误列表中，并根据 $this->show_errors 的值决定是否显示错误信息。

8. 结果处理：

   if ( $this->num_rows ) {
       $this->last_result = $this->result;
   
       if ( is_object( $this->result ) ) {
           if ( $this->use_mysqli ) {
               if ( $this->result->num_rows > 0 ) {
                   $this->result->data_seek( $row_offset );
                   $the_row = $this->result->fetch_row();
                   $return_val = $the_row[ $column_offset ];
               }
           } else {
               $this->seek( $row_offset );
               $return_val = $this->vardata( $column_offset );
           }
       } else {
           $return_val = $this->result[ $row_offset ][ $column_offset ];
       }
   
       $this->query_cache[ $key ][ $row_offset ][ $column_offset ] = $return_val;
   
       if ( $this->use_mysqli ) {
           if ( is_object( $this->result ) ) {
               $this->result->free();
           }
       } else {
           @mysql_free_result( $this->result );
       }
   
       $this->last_query = $query;
       $this->add_call_back( $query, $return_val );
   
       return $return_val;
   }

   如果查询成功，并且有结果返回（$this->num_rows > 0），则进入结果处理阶段。

   • 根据是否使用了 mysqli 扩展，以及结果的类型，选择不同的方式获取指定行和列的值。
     • 如果使用了 mysqli 扩展，并且结果是对象，则使用 $this->result->data_seek() 方法移动到指定的行，然后使用 $this->result->fetch_row() 方法获取该行的数据，最后从该行数据中取出指定列的值。
     • 如果没有使用 mysqli 扩展，则使用 $this->seek() 方法移动到指定的行，然后使用 $this->vardata() 方法获取指定列的值。
     • 如果结果不是对象，则直接通过数组索引的方式获取指定行和列的值。
   • 将查询结果缓存起来，以便下次使用。
   • 释放查询结果，释放内存。

9. 返回结果：

   return $return_val;

   返回最终获取的值。如果查询失败或没有结果，则返回 null。

四、 核心机制：query() 和 vardata()

上面源码中，query() 方法负责执行SQL查询，而 vardata() 方法（在未使用 mysqli 扩展时）负责从查询结果中提取数据。 query()方法根据配置选择使用 mysqli 或 mysql 扩展进行数据库操作，这里我们不做深入分析，重点看看vardata()。

vardata()方法的源码如下：

    /**
     * Returns the contents of the cell at the current row offset.
     *
     * @param int $num Optional column offset. Default 0.
     * @return string|null The value of the column.
     */
    public function vardata( $num = 0 ) {
        if ( $this->row_result ) {
            return $this->row_result[ $num ] ?? null;
        }

        return null;
    }

这个方法很简单，就是从 $this->row_result 数组中取出指定列的值。 $this->row_result 存储的是当前行的查询结果。如果 $this->row_result 为空，或者指定的列不存在，则返回 null。

五、 使用示例：手把手教你捞数据

下面，我们来看几个使用 get_var() 方法的例子：

1. 获取文章总数：

   global $wpdb;
   $count = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->posts} WHERE post_status = 'publish' AND post_type = 'post'" );
   echo "已发布的文章总数： " . $count;

   这条SQL语句查询的是 wp_posts 表中 post_status 为 publish 且 post_type 为 post 的记录总数。get_var() 方法会返回一个数字，表示已发布的文章总数。

2. 获取最新文章的标题：

   global $wpdb;
   $title = $wpdb->get_var( "SELECT post_title FROM {$wpdb->posts} WHERE post_status = 'publish' AND post_type = 'post' ORDER BY post_date DESC LIMIT 1" );
   echo "最新文章的标题： " . $title;

   这条SQL语句查询的是 wp_posts 表中最新发布的文章的标题。LIMIT 1 保证只返回一条记录，get_var() 方法会返回文章的标题字符串。

3. 获取用户ID为1的用户的用户名：

   global $wpdb;
   $username = $wpdb->get_var( $wpdb->prepare( "SELECT user_login FROM {$wpdb->users} WHERE ID = %d", 1 ) );
   echo "用户ID为1的用户名： " . $username;

   这里使用了 $wpdb->prepare() 方法来防止SQL注入攻击。%d 是一个占位符，会被后面的 1 替换。get_var() 方法会返回用户名字符串。

六、 安全注意事项：SQL注入的防范

在使用 get_var() 方法时，一定要注意SQL注入攻击的风险。不要直接将用户输入拼接到SQL语句中，而应该使用 $wpdb->prepare() 方法进行参数化查询。

例如，错误的写法：

$id = $_GET['id']; // 假设从URL获取用户ID
$sql = "SELECT user_login FROM {$wpdb->users} WHERE ID = " . $id; // 存在SQL注入风险
$username = $wpdb->get_var( $sql );

正确的写法：

$id = $_GET['id']; // 假设从URL获取用户ID
$sql = $wpdb->prepare( "SELECT user_login FROM {$wpdb->users} WHERE ID = %d", $id ); // 使用 prepare 方法
$username = $wpdb->get_var( $sql );

$wpdb->prepare() 方法会自动对用户输入进行转义，防止SQL注入攻击。

七、 性能优化：缓存的利用

get_var() 方法内部使用了缓存机制，可以有效提高查询效率。但是，如果查询结果经常变化，缓存可能会导致数据不一致。在这种情况下，可以考虑禁用缓存，或者手动刷新缓存。

禁用缓存：

$wpdb->suppress_errors = true; // 禁用错误显示
$wpdb->cache_flush(); // 清空缓存
$result = $wpdb->get_var( $query );
$wpdb->suppress_errors = false; // 恢复错误显示

注意，禁用缓存可能会影响性能，请谨慎使用。

八、 与其他方法对比：get_row()、get_results()

wpdb 类还提供了其他一些用于查询数据的方法，例如 get_row() 和 get_results()。

• get_row()：返回查询结果的第一行数据，以对象或数组的形式返回。
• get_results()：返回查询结果的所有行数据，以对象数组或关联数组的形式返回。

方法	返回值	适用场景
get_var()	查询结果的第一行第一列的值（单个变量）	只需要获取一个单独的值时，例如统计数量、获取单个字段的值等。
get_row()	查询结果的第一行数据（对象或数组）	需要获取一行数据的多个字段时，例如获取用户的信息、文章的详细信息等。
get_results()	查询结果的所有行数据（对象数组或关联数组）	需要获取多行数据的多个字段时，例如获取文章列表、用户列表等。

选择哪个方法取决于你的具体需求。如果只需要获取一个单独的值，get_var() 是最合适的选择。如果需要获取一行数据的多个字段，get_row() 更合适。如果需要获取多行数据，get_results() 则是最佳选择。

九、 总结：掌握 get_var()，玩转 WordPress 数据库

get_var() 方法是 wpdb 类中一个非常实用的方法，可以让你轻松地从数据库里获取单个变量的值。掌握了 get_var() 方法的使用，你就可以更加灵活地操作 WordPress 数据库，实现各种复杂的功能。

记住，在使用 get_var() 方法时，一定要注意SQL注入攻击的风险，并合理利用缓存机制，以提高查询效率。

好了，今天的讲座就到这里。希望大家有所收获！ 散会！