详解 WordPress `update_post_meta()` 函数的源码：它如何调用 `wpdb` 类的 `update()` 方法。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位代码界的吃瓜群众，晚上好！欢迎来到今晚的“扒源码，啃WordPress”专场。今天，我们要扒的是WordPress里一个不起眼，但又至关重要的函数：update_post_meta()。别看它名字平平无奇，它可是掌管着你文章、页面的“元数据”的大佬！今天，我们就来把它扒个底朝天，看看它如何召唤 wpdb 类的 update() 方法，来搞事情的。

一、什么是 update_post_meta()？元数据是个啥？

先别急着看代码，咱们先来聊聊“元数据”。你可以把它想象成一个人的档案。除了姓名、年龄这些基本信息，还有兴趣爱好、特长等等。对于WordPress的文章来说，标题、内容是基本信息，而自定义字段，比如“作者心情”、“阅读难度”、“推荐指数”等等，就是元数据。

update_post_meta() 函数的作用，就是更新（也就是修改）这些元数据。它的原型是这样的：

function update_post_meta( int $post_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' ) : int|false

$post_id：文章ID，你想更新哪个文章的元数据？得告诉它。
$meta_key：元数据的键名，也就是“心情”、“难度”这种。
$meta_value：元数据的值，比如“心情”是“愉快”，“难度”是“困难”。
$prev_value：可选参数，只有当元数据的值等于这个值时，才更新。相当于加了个条件判断。

返回值：

如果更新成功，返回 true。
如果更新失败，返回 false。

二、update_post_meta() 源码剖析：抽丝剥茧，深入虎穴

好了，废话不多说，直接上代码！（注意，以下代码是简化版，去掉了不必要的注释和错误处理，方便大家理解）

function update_post_meta( int $post_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' ) : int|false {
    global $wpdb;

    // 1. 参数校验
    $post_id = absint( $post_id );
    if ( ! $post_id ) {
        return false;
    }

    $meta_key = trim( $meta_key );
    if ( empty( $meta_key ) ) {
        return false;
    }

    // 2. 序列化 meta_value （如果需要）
    $meta_value = maybe_serialize( $meta_value );

    // 3. 处理 prev_value
    if ( '' !== $prev_value ) {
        $prev_value = maybe_serialize( $prev_value );
    }

    // 4. 获取现有的 meta_id
    $meta_id = $wpdb->get_var( $wpdb->prepare(
        "SELECT meta_id FROM {$wpdb->postmeta} WHERE post_id = %d AND meta_key = %s",
        $post_id,
        $meta_key
    ) );

    // 5. 如果已经存在 meta_id
    if ( $meta_id ) {

        // 6. 如果指定了 prev_value
        if ( '' !== $prev_value ) {
            // 6.1 检查现有的 meta_value 是否等于 prev_value
            $old_value = $wpdb->get_var( $wpdb->prepare(
                "SELECT meta_value FROM {$wpdb->postmeta} WHERE meta_id = %d",
                $meta_id
            ) );

            if ( $old_value !== $prev_value ) {
                return false; // 值不匹配，不更新
            }
        }

        // 7. 调用 wpdb->update() 更新数据
        $result = $wpdb->update(
            $wpdb->postmeta,
            array( 'meta_value' => $meta_value ),
            array( 'meta_id'    => $meta_id ),
            array( '%s' ),
            array( '%d' )
        );

        if ( ! $result ) {
            return false;
        }

        // 8. 清理缓存
        wp_cache_delete( $post_id, 'post_meta' );

        return true;

    } else {
        // 9. 如果 meta_id 不存在，说明是新增 meta data, 调用 add_post_meta
        return add_post_meta( $post_id, $meta_key, $meta_value, true );
    }
}

代码解读：步步惊心，细节控

参数校验： 先检查 $post_id 和 $meta_key 是否有效，无效直接返回 false。就像保安一样，不合格的参数，统统拒之门外。
序列化： maybe_serialize() 函数会检查 $meta_value 是否是数组或对象。如果是，就把它序列化成字符串，方便存储到数据库。就像把复杂的乐高玩具拆成一个个零件，方便打包运输。
prev_value 处理： 如果指定了 $prev_value，也要进行序列化。
获取 meta_id： 通过 SQL 查询，找到与 $post_id 和 $meta_key 匹配的 meta_id。meta_id 是数据库表中的主键，相当于元数据的身份证号。
判断 meta_id 是否存在： 如果 meta_id 存在，说明是要更新已有的元数据；否则，说明是要新增元数据。
prev_value 校验： 如果指定了 $prev_value，需要先从数据库中取出当前的 meta_value，与 $prev_value 进行比较。只有当两者相等时，才进行更新。这就像一个保险机制，防止误操作。
调用 wpdb->update()： 终于到重点了！如果通过了所有校验，就调用 $wpdb->update() 方法来更新数据库。
清理缓存： 更新完成后，清理缓存，确保下次读取的是最新的数据。
新增元数据： 如果 meta_id 不存在，说明是新增元数据，调用 add_post_meta() 函数来完成新增操作。（add_post_meta() 也会调用wpdb->insert()）

三、wpdb->update() 方法：数据库的搬运工

现在，我们把目光聚焦到 wpdb->update() 方法上。它是 WordPress 操作数据库的核心类 wpdb 的一个重要成员。它的作用就是更新数据库表中的数据。

wpdb->update() 方法的原型是这样的：

public function update( string $table, array $data, array $where, array|string|null $format = null, array|string|null $where_format = null ) : int|false

$table：要更新的表名。
$data：一个关联数组，包含了要更新的字段和值。
$where：一个关联数组，包含了更新的条件。
$format：一个数组，包含了 $data 中每个值的格式。
$where_format：一个数组，包含了 $where 中每个值的格式。

回到 update_post_meta() 函数，我们看看它是如何调用 wpdb->update() 的：

$result = $wpdb->update(
    $wpdb->postmeta,                 // 表名：wp_postmeta
    array( 'meta_value' => $meta_value ),  // 要更新的数据：meta_value = $meta_value
    array( 'meta_id'    => $meta_id ),     // 更新条件：meta_id = $meta_id
    array( '%s' ),                      // meta_value 的格式：字符串
    array( '%d' )                       // meta_id 的格式：整数
);

$wpdb->postmeta：指定了要更新的表是 wp_postmeta 表。这个表存储了文章的元数据。
array( 'meta_value' => $meta_value )：指定了要更新的字段是 meta_value，新的值是 $meta_value。
array( 'meta_id' => $meta_id )：指定了更新的条件是 meta_id 等于 $meta_id。也就是说，只更新指定 meta_id 的那条记录。
array( '%s' )：告诉 wpdb，meta_value 是一个字符串类型的数据。
array( '%d' )：告诉 wpdb，meta_id 是一个整数类型的数据。

wpdb->update() 的内部逻辑：

wpdb->update() 内部会根据传入的参数，构建出一条 SQL UPDATE 语句，然后执行这条语句。

例如，根据上面的例子，构建出的 SQL 语句可能是这样的：

UPDATE wp_postmeta SET meta_value = '新的元数据值' WHERE meta_id = 123;

wpdb->update() 会使用 $wpdb->prepare() 方法来预处理 SQL 语句，防止 SQL 注入攻击。

四、update_post_meta() 的使用场景：元数据，无处不在

update_post_meta() 函数在WordPress开发中应用非常广泛。

自定义字段： 最常见的用法就是更新自定义字段。比如，你可以创建一个自定义字段来存储文章的“阅读时长”，然后使用 update_post_meta() 函数来更新这个字段的值。
插件设置： 许多插件会使用元数据来存储插件的设置。比如，一个 SEO 插件可能会使用元数据来存储文章的关键词和描述。
主题定制： 主题开发者也可以使用元数据来定制文章的显示方式。比如，可以创建一个自定义字段来控制文章的背景颜色。

五、update_post_meta() 的注意事项：小心驶得万年船

数据类型： 注意 $meta_value 的数据类型。如果 $meta_value 是数组或对象，需要先进行序列化，才能存储到数据库。
性能： 频繁调用 update_post_meta() 函数可能会影响性能。尽量避免在循环中调用它。
安全： 注意防止 SQL 注入攻击。使用 $wpdb->prepare() 方法来预处理 SQL 语句。

六、总结：庖丁解牛，豁然开朗

今天，我们深入剖析了 WordPress 的 update_post_meta() 函数，了解了它的工作原理，以及它如何调用 wpdb->update() 方法来更新数据库。希望通过今天的讲解，大家对 WordPress 的元数据管理机制有了更深入的理解。

希望大家以后再遇到 update_post_meta() 函数时，不再感到陌生，而是能够自信地说：“这玩意儿，我熟！” 感谢大家的收听，我们下期再见！

发表回复 取消回复

发表回复取消回复