阐述 WordPress `update_post_meta()` 函数的源码：它如何处理单个元数据和数组元数据的更新。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位听众，大家好！我是你们今天的WordPress元数据讲师，咱们今天来扒一扒WordPress update_post_meta() 这个函数的老底，看看它是怎么处理那些五花八门的元数据，尤其是单个儿的和数组形式的。别害怕，虽然是源码分析，我会尽量说得有趣易懂，保证你们听完之后，能对着代码哈哈大笑，而不是挠头叹气。

开场白：元数据是个啥玩意儿？

在开始之前，咱们先简单回顾一下元数据是个啥。想象一下，你写了一篇文章，除了文章内容本身，你可能还想记录一些额外的信息，比如这篇文章的作者心情指数（1-10），或者这篇文章的关键词列表。这些额外的信息，就是元数据。它就像是给文章贴上的标签，方便我们管理和查找。

在WordPress里，元数据可以用来存储各种各样的信息，比如文章的自定义字段、产品的价格、用户的头像等等。

update_post_meta()：元数据界的万金油

update_post_meta() 函数就像是元数据界的万金油，它可以用来更新、添加或删除元数据。它的基本用法是这样的：

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: 可选参数，表示要更新的旧值。如果设置了这个参数，函数只会更新那些旧值和 $prev_value 相等的元数据。

源码剖析：update_post_meta() 的内心世界

好了，现在咱们就来深入 update_post_meta() 的源码，看看它到底是怎么工作的。

function update_post_meta( $post_id, $meta_key, $meta_value, $prev_value = '' ) {
    return update_metadata( 'post', $post_id, $meta_key, $meta_value, $prev_value );
}

咦？竟然这么简单！ update_post_meta() 实际上只是调用了 update_metadata() 函数，并把 'post' 作为第一个参数传递了进去。 update_metadata() 才是真正干活的函数。

深入 update_metadata()：元数据管理的幕后英雄

update_metadata() 函数是一个通用的元数据更新函数，它可以用来更新任何类型的元数据，比如文章元数据、用户元数据、分类元数据等等。

function update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_value = '' ) {
    global $wpdb;

    $object_id = absint( $object_id );
    if ( ! $object_id ) {
        return false;
    }

    $meta_key = wp_unslash( $meta_key );
    $sanitize_callback = apply_filters( "sanitize_{$meta_type}_meta_{$meta_key}", null, $meta_key, $object_id, 'update' );

    if ( is_callable( $sanitize_callback ) ) {
        $meta_value = call_user_func( $sanitize_callback, $meta_value, $meta_key, $object_id, 'update' );
    }

    $meta_value = wp_unslash( $meta_value );
    $meta_value = maybe_serialize( $meta_value );

    $table = _get_meta_table( $meta_type );

    if ( ! $table ) {
        return false;
    }

    $column = sanitize_key( $meta_type . '_id' );

    $id_column = 'meta_id';

    $meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT {$id_column} FROM {$table} WHERE {$column} = %d AND meta_key = %s", $object_id, $meta_key ) );

    if ( empty( $meta_ids ) ) {
        if ( '' === $prev_value ) {
            return add_metadata( $meta_type, $object_id, $meta_key, $meta_value );
        } else {
            return false;
        }
    }

    $meta_value = maybe_serialize( $meta_value );

    if ( is_array( $prev_value ) ) {
        $prev_value = array_map( 'maybe_serialize', $prev_value );
    } else {
        $prev_value = maybe_serialize( $prev_value );
    }

    $data  = array( 'meta_value' => $meta_value );
    $where = array( $column => $object_id, 'meta_key' => $meta_key );

    if ( '' !== $prev_value ) {
        $where['meta_value'] = $prev_value;
    }

    $updated = $wpdb->update( $table, $data, $where );

    if ( $updated ) {
        wp_cache_delete_by_group( $meta_type . '_meta' );

        /**
         * Fires immediately after updating metadata of a specific type.
         *
         * The dynamic portion of the hook name, `$meta_type`, refers to the metadata object type.
         *
         * Possible values for `$meta_type` include 'post', 'comment', 'term', 'user',
         * and any other object type with associated meta data.
         *
         * @since 2.9.0
         *
         * @param int    $meta_id    ID of the metadata entry that was updated.
         * @param int    $object_id  ID of the object the metadata was for.
         * @param string $meta_key   Key of the metadata entry that was updated.
         * @param mixed  $meta_value Metadata value. Serialized if non-scalar.
         */
        do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $meta_value );

        return true;
    } else {
        return false;
    }
}

看起来代码有点长，咱们一步一步来分析：

参数验证和数据准备：
- 首先，函数会对 $object_id 进行验证，确保它是一个有效的整数。
- 然后，它会对 $meta_key 进行 wp_unslash() 处理，去除反斜杠。
- 接着，它会应用一个过滤器 sanitize_{$meta_type}_meta_{$meta_key}，允许开发者对元数据进行自定义的清理和验证。
- 最后，它会对 $meta_value 进行 wp_unslash() 处理，去除反斜杠，并使用 maybe_serialize() 函数进行序列化。 maybe_serialize() 函数会判断 $meta_value 是否是数组或对象，如果是，就把它序列化成字符串，否则就保持原样。
确定数据表：
- _get_meta_table( $meta_type ) 函数会根据 $meta_type （比如 ‘post’）来确定要操作的元数据表。对于文章元数据来说，这个表通常是 wp_postmeta。
构建查询条件：
- sanitize_key( $meta_type . '_id' ) 函数会根据 $meta_type 构建一个安全的列名，用于查询。对于文章元数据来说，这个列名通常是 post_id。
- $wpdb->get_col() 函数会查询数据库，查找所有符合条件的元数据ID。条件是 $object_id （文章ID）和 $meta_key （元数据键名）。
判断操作类型：
- 如果查询结果为空，说明这个元数据不存在。
  - 如果 $prev_value 为空，说明我们想要添加一个新的元数据，于是函数会调用 add_metadata() 函数来添加元数据。
  - 如果 $prev_value 不为空，说明我们想要更新一个不存在的元数据，但是我们指定了旧值，所以函数会返回 false。
- 如果查询结果不为空，说明这个元数据已经存在。
更新元数据：
- 如果元数据已经存在，函数会构建一个 UPDATE 语句，更新数据库中的元数据。
- maybe_serialize() 函数会对 $meta_value 和 $prev_value 进行序列化，确保它们可以安全地存储到数据库中。
- $wpdb->update() 函数会执行 UPDATE 语句，更新数据库。
清理缓存和触发钩子：
- 如果更新成功，函数会清理缓存，并触发一个钩子 updated_{$meta_type}_meta，允许开发者在元数据更新后执行一些自定义的操作。

单个元数据 vs 数组元数据：maybe_serialize() 的妙用

现在咱们来重点看看 maybe_serialize() 函数在处理单个元数据和数组元数据时的作用。

单个元数据：

如果 $meta_value 是一个字符串、数字或布尔值，maybe_serialize() 函数会直接返回这个值，不做任何处理。这意味着，你可以直接存储这些简单类型的数据到数据库中。
数组元数据：

如果 $meta_value 是一个数组，maybe_serialize() 函数会使用 serialize() 函数将数组序列化成一个字符串。这个字符串可以安全地存储到数据库中，并且可以通过 unserialize() 函数还原成数组。

举个栗子：更新文章的关键词列表

假设我们想更新一篇ID为 123 的文章的关键词列表，关键词列表是一个数组：

$post_id = 123;
$meta_key = 'keywords';
$meta_value = array( 'WordPress', '元数据', '源码分析' );

update_post_meta( $post_id, $meta_key, $meta_value );

在这个例子中，update_post_meta() 函数会将 $meta_value 数组序列化成一个字符串，然后存储到 wp_postmeta 表中。

再举个栗子：更新文章的作者心情指数

假设我们想更新一篇ID为 456 的文章的作者心情指数，心情指数是一个数字：

$post_id = 456;
$meta_key = 'mood_index';
$meta_value = 8; // 1-10

update_post_meta( $post_id, $meta_key, $meta_value );

在这个例子中，update_post_meta() 函数会直接存储数字 8 到 wp_postmeta 表中。

表格总结：update_post_meta() 的处理流程

步骤	描述
1. 参数验证和准备	验证 `$object_id`，去除 `$meta_key` 和 `$meta_value` 的反斜杠，应用过滤器，序列化 `$meta_value`。
2. 确定数据表	根据 `$meta_type` 确定要操作的元数据表。
3. 构建查询条件	构建查询条件，查找符合条件的元数据ID。
4. 判断操作类型	如果元数据不存在，根据 `$prev_value` 的值决定是添加元数据还是返回 `false`；如果元数据存在，则更新元数据。
5. 更新元数据	构建 `UPDATE` 语句，更新数据库中的元数据。
6. 清理缓存和钩子	清理缓存，触发钩子 `updated_{$meta_type}_meta`。

注意事项：$prev_value 的用法

$prev_value 参数是一个可选参数，它可以用来指定要更新的旧值。如果设置了这个参数，函数只会更新那些旧值和 $prev_value 相等的元数据。

这个参数在以下情况下非常有用：

防止并发更新： 如果多个用户同时更新同一个元数据，$prev_value 可以用来防止数据冲突。
条件更新： 只有当元数据的旧值满足特定条件时，才更新元数据。

举个栗子：使用 $prev_value 防止并发更新

假设我们想更新一篇ID为 789 的文章的浏览次数，但是我们只想在浏览次数没有被其他用户修改的情况下才更新：

$post_id = 789;
$meta_key = 'views';
$old_views = get_post_meta( $post_id, $meta_key, true ); // 获取旧的浏览次数
$new_views = $old_views + 1;

update_post_meta( $post_id, $meta_key, $new_views, $old_views );

在这个例子中，我们首先获取旧的浏览次数，然后将 $prev_value 设置为旧的浏览次数。这样，只有当数据库中的浏览次数和 $old_views 相等时，update_post_meta() 函数才会更新浏览次数。

总结：update_post_meta() 的精髓

update_post_meta() 函数看似简单，但它背后隐藏着很多细节。它通过 update_metadata() 函数来实现元数据的更新，并且利用 maybe_serialize() 函数来处理单个元数据和数组元数据。$prev_value 参数可以用来防止并发更新和实现条件更新。

掌握了 update_post_meta() 函数的用法，你就可以轻松地管理WordPress的元数据，为你的网站添加各种各样的自定义功能。

课后练习：

尝试使用 update_post_meta() 函数更新一篇文章的多个元数据，包括字符串、数字和数组。
尝试使用 $prev_value 参数来防止并发更新。
查找 WordPress 官方文档，了解更多关于 update_post_meta() 函数的信息。

好了，今天的讲座就到这里，希望大家有所收获！如果还有什么疑问，欢迎随时提问。下次再见！

发表回复 取消回复

发表回复取消回复