发布于 由admin

分析 WordPress `get_post_meta()` 函数源码：与 `wp_postmeta` 表的交互流程。

咳咳，各位观众老爷，晚上好！我是今天的主讲人，江湖人称“代码界的包打听”。今儿个咱们聊聊 WordPress 里的 get_post_meta() 函数，看看它是怎么跟那个神秘兮兮的 wp_postmeta 表眉来眼去的。

准备好了吗？系好安全带，咱们这就发车！

一、 get_post_meta() ：你的私人小秘书

想象一下，你是个作家，写完一篇文章（也就是 WordPress 里的“Post”）。除了文章内容，你还想加点额外信息，比如“阅读难度”、“推荐指数”、“心情指数”等等。这些信息就叫做“Post Meta”，而 get_post_meta() 就像你的私人小秘书，专门负责帮你从 wp_postmeta 表里取出这些信息。

简单来说，get_post_meta() 的作用就是：根据 Post ID 和 Meta Key，从 wp_postmeta 表里检索出对应的 Meta Value。

函数原型长这样：

get_post_meta( int $post_id, string $key = '', bool $single = false ) : mixed
  • $post_id: 你要获取哪个 Post 的 Meta？必须是 Post 的 ID。
  • $key: 你要获取哪个 Meta 的值？ 比如 reading_difficulty 或者 recommendation_index。 如果为空，会返回这个 Post 的 所有 Meta 信息。
  • $single: 你希望返回一个值还是一个数组？ true 返回第一个值，false 返回一个数组（即使只有一个值）。

二、 wp_postmeta 表：Meta 信息的储存仓库

在深入 get_post_meta() 的源码之前，先来认识一下它的幕后功臣 wp_postmeta 表。 这个表就相当于一个巨大的 Excel 表格，用来存储 Post Meta 信息。 它通常有以下几个字段：

字段名 数据类型 说明
meta_id bigint(20) 自动递增的唯一 ID
post_id bigint(20) 关联的 Post 的 ID
meta_key varchar(255) Meta 的键名（比如 reading_difficulty）
meta_value longtext Meta 的值（比如 easy 或者 5 stars）

注意，meta_value 字段的数据类型是 longtext，这意味着它可以存储大量文本，理论上可以存储各种类型的数据，但通常都是字符串。

三、源码探秘：get_post_meta() 的内部运作

现在，让我们打开 wp-includes/post.php 文件，找到 get_post_meta() 函数，看看它到底是怎么工作的。

function get_post_meta( $post_id, $key = '', $single = false ) {
    return get_metadata( 'post', $post_id, $key, $single );
}

纳尼？就一行代码？ 别着急，好戏还在后头。 get_post_meta() 实际上是调用了更通用的 get_metadata() 函数。 这个函数可以处理各种类型的 Metadata，不仅仅是 Post Meta。

四、get_metadata()：真正的幕后 Boss

get_metadata() 函数才是真正和数据库打交道的家伙。 它的源码比较长，咱们一点一点分析：

function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) {
    global $wpdb, $_wp_suspend_cache_invalidation;

    $object_id = (int) $object_id;

    if ( ! $object_id ) {
        return false;
    }

    $meta_cache = wp_cache_get( $object_id, $meta_type . '_meta' );

    if ( ! $meta_cache ) {
        $meta_cache = update_meta_cache( $meta_type, array( $object_id ) );
        if ( isset( $meta_cache[ $object_id ] ) ) {
            $meta_cache = $meta_cache[ $object_id ];
        } else {
            $meta_cache = null;
        }
    }

    if ( ! $meta_key ) {
        if ( $single ) {
            return '';
        } else {
            return $meta_cache;
        }
    }

    if ( isset( $meta_cache[ $meta_key ] ) ) {
        if ( $single ) {
            return maybe_unserialize( $meta_cache[ $meta_key ][0] );
        } else {
            return array_map( 'maybe_unserialize', $meta_cache[ $meta_key ] );
        }
    }

    return '';
}

咱们来逐行解读：

  1. 准备工作

    global $wpdb, $_wp_suspend_cache_invalidation;

$object_id = (int) $object_id;

if ( ! $object_id ) {
    return false;
}
    • global $wpdb: 把全局的 $wpdb 对象拿过来。 $wpdb 是 WordPress 里专门用来操作数据库的家伙。
    • $object_id = (int) $object_id: 把 object_id 强制转换成整数。 安全第一！
    • if ( ! $object_id ) { return false; }: 如果 object_id 是空的，直接返回 false。 没东西可查，还费什么劲？

  2. 缓存优先

    $meta_cache = wp_cache_get( $object_id, $meta_type . '_meta' );

if ( ! $meta_cache ) {
    $meta_cache = update_meta_cache( $meta_type, array( $object_id ) );
    if ( isset( $meta_cache[ $object_id ] ) ) {
        $meta_cache = $meta_cache[ $object_id ];
    } else {
        $meta_cache = null;
    }
}
    • wp_cache_get(): 尝试从 WordPress 的缓存里获取 Meta 信息。 缓存就像你的电脑桌面，经常用的东西放在这里，下次用起来就快多了。 WordPress 使用缓存来避免频繁地查询数据库，提高性能。
    • update_meta_cache(): 如果缓存里没有，就调用 update_meta_cache() 函数从数据库里读取，并更新缓存。 这个函数才是真正和数据库打交道的。

  3. 没有 Meta Key 的情况

    if ( ! $meta_key ) {
    if ( $single ) {
        return '';
    } else {
        return $meta_cache;
    }
}
    • 如果 $meta_key 为空，说明用户想要获取这个 Post 的 所有 Meta 信息。
    • 如果 $single 是 true，说明用户只需要一个值，但是所有 Meta 信息都是数组，所以返回空字符串。
    • 如果 $single 是 false，直接返回缓存里的 $meta_cache。

  4. 从缓存中获取 Meta Value

    if ( isset( $meta_cache[ $meta_key ] ) ) {
    if ( $single ) {
        return maybe_unserialize( $meta_cache[ $meta_key ][0] );
    } else {
        return array_map( 'maybe_unserialize', $meta_cache[ $meta_key ] );
    }
}
    • 如果缓存里有对应的 $meta_key，就从缓存里取出 Meta Value。
    • maybe_unserialize(): Meta Value 存储的时候可能会被序列化（serialize），这里用 maybe_unserialize() 函数尝试反序列化，还原成原来的数据类型。
    • 如果 $single 是 true，返回数组的第一个元素。
    • 如果 $single 是 false，返回整个数组，并对每个元素进行反序列化。

  5. 啥都没找到

    return '';
    • 如果缓存里没有对应的 $meta_key，说明数据库里也没有这个 Meta 信息，返回空字符串。

五、update_meta_cache()：缓存更新的秘密

update_meta_cache() 函数负责从数据库里读取 Meta 信息，并更新缓存。 它的源码更长，咱们挑重点说：

function update_meta_cache( $meta_type, $object_ids ) {
    global $wpdb;

    $table = _get_meta_table( $meta_type );

    if ( ! $table ) {
        return false;
    }

    $object_ids = array_map( 'intval', (array) $object_ids );
    $object_ids = array_filter( $object_ids );

    if ( empty( $object_ids ) ) {
        return false;
    }

    $id_column = esc_sql( $meta_type . '_id' );

    $ids = implode( ',', $object_ids );

    $cache = array();

    $sql = "SELECT meta_id, $id_column, meta_key, meta_value FROM $table WHERE $id_column IN ($ids) ORDER BY meta_id ASC";

    $results = $wpdb->get_results( $sql, OBJECT_K );

    if ( ! $results ) {
        return $cache;
    }

    foreach ( $results as $result ) {
        $object_id = (int) $result->{$id_column};
        $meta_key  = $result->meta_key;
        $meta_value = $result->meta_value;

        $cache[ $object_id ][ $meta_key ][] = $meta_value;
    }

    foreach ( $object_ids as $id ) {
        if ( ! isset( $cache[ $id ] ) ) {
            $cache[ $id ] = array();
        }

        wp_cache_set( $id, $cache[ $id ], $meta_type . '_meta' );
    }

    return $cache;
}

关键步骤：

  1. 确定表名

    $table = _get_meta_table( $meta_type );

    _get_meta_table() 函数根据 $meta_type（比如 post）来确定对应的 Meta 表名（比如 wp_postmeta）。这是一个内部函数，不用太关心。

  2. 构造 SQL 查询语句

    $id_column = esc_sql( $meta_type . '_id' );

$ids = implode( ',', $object_ids );

$sql = "SELECT meta_id, $id_column, meta_key, meta_value FROM $table WHERE $id_column IN ($ids) ORDER BY meta_id ASC";
    • $id_column: 确定 ID 列的名称（比如 post_id）。
    • $ids: 把 $object_ids 数组转换成逗号分隔的字符串。
    • $sql: 构造 SQL 查询语句。 这个语句会从 wp_postmeta 表里查询所有 post_id 在 $ids 里的记录，并按照 meta_id 升序排序。

  3. 执行 SQL 查询

    $results = $wpdb->get_results( $sql, OBJECT_K );
    • $wpdb->get_results(): 执行 SQL 查询，并返回结果。 OBJECT_K 参数表示结果以对象的形式存储，并且以 meta_id 作为键名。

  4. 整理数据

    foreach ( $results as $result ) {
    $object_id = (int) $result->{$id_column};
    $meta_key  = $result->meta_key;
    $meta_value = $result->meta_value;

    $cache[ $object_id ][ $meta_key ][] = $meta_value;
}
    • 遍历查询结果，把数据整理成一个多维数组 $cache。
    • $cache[ $object_id ][ $meta_key ][] = $meta_value: 这个语句的意思是，把 meta_value 添加到 $object_id 对应的 $meta_key 的数组里。 因为一个 Post 可能有多个相同 Key 的 Meta 信息。

  5. 更新缓存

    foreach ( $object_ids as $id ) {
    if ( ! isset( $cache[ $id ] ) ) {
        $cache[ $id ] = array();
    }

    wp_cache_set( $id, $cache[ $id ], $meta_type . '_meta' );
}
    • 遍历 $object_ids，把整理好的数据更新到 WordPress 的缓存里。
    • wp_cache_set(): 把数据存入缓存。

六、流程总结

现在，咱们来总结一下 get_post_meta() 函数与 wp_postmeta 表的交互流程：

  1. get_post_meta() 接收 Post ID 和 Meta Key 作为参数。
  2. get_post_meta() 调用 get_metadata() 函数。
  3. get_metadata() 首先尝试从缓存里获取 Meta 信息。
  4. 如果缓存里没有，get_metadata() 调用 update_meta_cache() 函数。
  5. update_meta_cache() 函数构造 SQL 查询语句，从 wp_postmeta 表里查询 Meta 信息。
  6. update_meta_cache() 函数把查询结果整理成数组，并更新缓存。
  7. get_metadata() 从缓存里获取 Meta Value，并返回。
  8. get_post_meta() 返回 get_metadata() 返回的结果。

用表格表示更清晰：

步骤 函数 描述 与 wp_postmeta 表的交互
1 get_post_meta() 接收 Post ID 和 Meta Key。 无
2 get_metadata() 调用 update_meta_cache() 如果缓存中没有数据， 否则直接从缓存中读取 无
3 update_meta_cache() (如果缓存中没有数据) 生成 SQL 语句，查询 wp_postmeta 表，根据 post_id 获取所有相关的 Meta 信息，并更新缓存。 SELECT meta_id, post_id, meta_key, meta_value FROM wp_postmeta WHERE post_id IN (...) ORDER BY meta_id ASC
4 get_metadata() 从缓存读取数据 无
5 get_post_meta() 返回 get_metadata() 读取到的 Meta 信息。 无

七、总结与思考

get_post_meta() 函数看似简单，但它背后却隐藏着复杂的数据库交互和缓存机制。 理解它的工作原理，可以帮助我们更好地使用 WordPress，并优化网站性能。

  • 缓存的重要性: WordPress 极度依赖缓存来提升性能。get_post_meta() 优先从缓存读取数据，避免频繁查询数据库。
  • SQL 查询优化: update_meta_cache() 函数使用 IN 语句来批量查询 Meta 信息，这比每次查询一个 Meta Key 效率更高。
  • 数据序列化: Meta Value 存储的时候可能会被序列化，这是为了存储复杂的数据类型。

好了，今天的讲座就到这里。希望大家通过今天的学习，对 get_post_meta() 函数和 wp_postmeta 表有了更深入的了解。

下次再见！ (挥手)

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注