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

嘿，大家好！今天咱们来扒一扒 WordPress 里一个非常重要的函数——update_post_meta()。这玩意儿天天打交道，但你真的了解它吗？尤其是它处理单个元数据和数组元数据的方式，里面可是藏着不少门道。准备好，咱们开始！

开场白：元数据这玩意儿，到底是个啥？

简单来说，元数据就是关于数据的数据。想象一下，你写了一篇文章，文章本身是数据，而文章的标题、作者、发布日期、关键词，这些都是描述这篇文章的数据，也就是元数据。在 WordPress 里，元数据允许你给文章、页面、自定义文章类型添加额外的信息，而 update_post_meta() 就是负责更新这些信息的关键函数。

update_post_meta() 函数的基本用法

先来复习一下 update_post_meta() 的基本用法。它长这样：

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

$post_id: 要更新的文章 ID。
$meta_key: 元数据的键名，相当于给元数据起个名字。
$meta_value: 元数据的值，你要保存的实际数据。
$prev_value: (可选) 如果指定了，只有当当前元数据的值等于 $prev_value 时才更新。这玩意儿有点像乐观锁，避免并发修改冲突。

源码剖析：单打独斗的元数据

咱们先来看看 update_post_meta() 是如何处理单个元数据的。为了简化分析，我们只关注核心逻辑，忽略一些错误处理和钩子。

function update_post_meta( $post_id, $meta_key, $meta_value, $prev_value = '' ) {
    global $wpdb;

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

    $meta_key = wp_unslash( $meta_key );
    $sanitize_callback = apply_filters( "sanitize_{$meta_key}_meta_key", null, $meta_key, $post_id, 'post' );
    if ( is_callable( $sanitize_callback ) ) {
        $meta_key = call_user_func( $sanitize_callback, $meta_key, $post_id, 'post' );
    }
    $meta_key = wp_slash( $meta_key );

    if ( ! is_protected_meta( $meta_key, 'post' ) ) {
        $meta_value = wp_slash_strings_only( $meta_value );
    }

    $meta_type = 'post';
    $table = _get_meta_table( $meta_type );

    if ( is_null( $table ) ) {
        return false;
    }

    $column = sanitize_key( str_replace( $wpdb->prefix, '', $table ) );
    $id_column = "{$meta_type}_id";

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

    if ( empty( $meta_ids ) ) {
        return add_post_meta( $post_id, $meta_key, $meta_value );
    }

    $meta_value = maybe_serialize( $meta_value );

    if ( '' === $prev_value ) {
        $data  = array( 'meta_value' => $meta_value );
        $where = array( 'meta_key' => $meta_key, $id_column => $post_id );
        $format = array( '%s' );
        $where_format = array( '%s', '%d' );
        $updated = $wpdb->update( $table, $data, $where, $format, $where_format );
    } else {
        $prev_value = maybe_serialize( $prev_value );
        $data  = array( 'meta_value' => $meta_value );
        $where = array( 'meta_key' => $meta_key, $id_column => $post_id, 'meta_value' => $prev_value );
        $format = array( '%s' );
        $where_format = array( '%s', '%d', '%s' );
        $updated = $wpdb->update( $table, $data, $where, $format, $where_format );
    }

    if ( false === $updated ) {
        return false;
    }

    if ( $updated ) {
        wp_cache_delete( $post_id, "{$column}_meta" );
        do_action( 'updated_post_meta', $meta_id, $post_id, $meta_key, $meta_value );
    }

    return true;
}

流程分解：

参数校验和清理： 首先，函数会对 $post_id 进行校验，确保它是一个有效的整数。然后，对 $meta_key 进行清理，包括移除反斜杠 (wp_unslash) 和应用 sanitize_{$meta_key}_meta_key 过滤器。
检查是否为受保护的元数据： 如果元数据键名是受保护的（比如以 _ 开头），则跳过一些处理。
获取元数据表名： 根据 $meta_type (这里是 post) 获取存储元数据的数据库表名。通常是 wp_postmeta。
查找现有的元数据： 使用 $wpdb->get_col() 查询数据库，看看是否存在 meta_key 和 $post_id 匹配的记录。
如果不存在，则添加： 如果没有找到匹配的元数据，说明这是一个新的元数据，调用 add_post_meta() 函数来添加。
序列化数据： 使用 maybe_serialize() 函数对 $meta_value 进行序列化。这是关键一步，它可以将各种类型的数据（包括数组和对象）转换为字符串，以便存储到数据库中。
更新数据：
- 没有 $prev_value： 如果没有提供 $prev_value，就直接更新 meta_key 和 $post_id 匹配的所有记录的 meta_value。
- 有 $prev_value： 如果提供了 $prev_value，则只有当 meta_key、$post_id 和 meta_value 都匹配时，才更新 meta_value。
清理缓存和触发钩子： 如果更新成功，则清理缓存，并触发 updated_post_meta 钩子，允许其他代码执行额外的操作。

重点：maybe_serialize() 函数

maybe_serialize() 函数是处理数据类型的关键。它的作用是：

如果 $data 是数组或对象，则使用 serialize() 函数将其序列化为字符串。
如果 $data 不是数组或对象，则直接返回 $data。

这意味着，无论你传递给 $meta_value 的是什么类型的数据，update_post_meta() 都会将其转换为字符串存储到数据库中。

数组元数据：化整为零的艺术

当 $meta_value 是一个数组时，maybe_serialize() 会将其序列化为一个字符串。例如：

$my_array = array(
    'name' => '张三',
    'age' => 30,
    'city' => '北京'
);

update_post_meta( 123, 'my_array_data', $my_array );

在这个例子中，$my_array 会被序列化成一个字符串，然后存储到 wp_postmeta 表的 meta_value 字段中。

如何取出数组元数据？

要取出数组元数据，你需要使用 get_post_meta() 函数，并将其第三个参数设置为 true：

$my_array = get_post_meta( 123, 'my_array_data', true );

if ( is_array( $my_array ) ) {
    echo $my_array['name']; // 输出：张三
}

如果第三个参数设置为 false (或者省略)，get_post_meta() 会返回一个包含序列化字符串的数组。所以，一定要设置为 true，才能自动反序列化数据。

代码示例：添加、更新、删除数组元数据

// 添加数组元数据
$data = array(
    'color' => 'red',
    'size' => 'large',
    'price' => 99.99
);
add_post_meta( $post_id, 'product_details', $data );

// 更新数组元数据
$data['price'] = 129.99;
update_post_meta( $post_id, 'product_details', $data );

// 删除数组元数据
delete_post_meta( $post_id, 'product_details' );

$prev_value 的妙用

$prev_value 参数可以用来实现乐观锁。例如，你想更新一个商品的库存，但前提是当前的库存数量和你预期的一致：

$post_id = 456;
$meta_key = 'stock_quantity';
$expected_quantity = 10;
$new_quantity = 8;

$updated = update_post_meta( $post_id, $meta_key, $new_quantity, $expected_quantity );

if ( $updated ) {
    echo '库存更新成功！';
} else {
    echo '库存更新失败，可能已被其他用户修改！';
}

只有当数据库中 stock_quantity 的值等于 10 时，才会更新为 8。否则，update_post_meta() 会返回 false，表示更新失败。

一些需要注意的点

性能： 频繁地更新元数据可能会影响性能，特别是当你有大量的文章和元数据时。尽量减少不必要的更新操作。
数据类型： 虽然 update_post_meta() 可以存储各种类型的数据，但最好保持数据类型的一致性。例如，如果你存储的是数字，就不要一会儿存储字符串，一会儿存储整数。
安全： 对 $meta_key 和 $meta_value 进行适当的验证和清理，防止 SQL 注入和 XSS 攻击。
钩子： 利用 updated_post_meta 等钩子，可以在元数据更新前后执行自定义的操作。

单条数据和数组数据的对比

特性	单条数据	数组数据
存储方式	直接存储（经过序列化）	序列化为字符串后存储
获取方式	`get_post_meta(..., true)`	`get_post_meta(..., true)` 返回反序列化后的数组
更新方式	直接更新	需要先获取数组，修改后再更新整个数组
适用场景	简单的、独立的信息	多个相关联的信息集合，例如商品详情、作者信息等
序列化影响	无明显影响	序列化和反序列化会带来一定的性能开销

高级技巧：自定义元数据表

如果你需要存储大量的元数据，或者需要对元数据进行复杂的查询，可以考虑使用自定义元数据表。这可以提高性能和灵活性。但是，使用自定义元数据表需要更多的开发工作。

总结

update_post_meta() 是 WordPress 中一个非常强大和灵活的函数，它可以让你轻松地管理文章的元数据。无论是单个元数据还是数组元数据，它都能处理得井井有条。但是，要充分利用它的功能，你需要了解它的工作原理和一些注意事项。希望今天的讲解能让你对 update_post_meta() 有更深入的理解。

记住，编程就像烹饪，掌握了基本食材和调料，就能做出各种美味佳肴。update_post_meta() 就是 WordPress 开发中的一个重要调料，好好利用它，你的代码也会变得更加美味！

好了，今天的分享就到这里。大家有什么问题可以提出来，我们一起讨论。

发表回复 取消回复

发表回复取消回复