分析 WordPress `wp_insert_comment()` 函数的源码：如何处理评论的元数据。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众，晚上好！我是你们的老朋友，今天咱们来聊聊WordPress里一个挺重要的函数——wp_insert_comment()，特别是它如何处理评论的元数据。简单来说，就是评论的其他信息，比如点赞数、用户评分等等，这些“额外信息”是如何被wp_insert_comment()管理的。

准备好了吗？咱们这就开始这场“掘地三尺”式的源码分析之旅！

`wp_insert_comment()` 总览

首先，简单回顾一下wp_insert_comment()的作用：它负责向WordPress数据库中插入一条新的评论。这可不仅仅是把评论内容丢进去就完事了，它还涉及到各种校验、过滤，以及我们今天要重点关注的——元数据的处理。

wp_insert_comment()函数位于 wp-includes/comment.php 文件中。它的基本结构如下 (简化版，只保留关键部分):

function wp_insert_comment( $commentdata ) {
    global $wpdb;

    // 1. 数据预处理和验证 (省略)

    // 2. 插入评论到数据库
    $wpdb->insert( $wpdb->comments, $data );
    $comment_id = $wpdb->insert_id;

    // 3. 处理元数据 (我们今天要深入研究的部分!)
    if ( ! empty( $commentdata['comment_meta'] ) && is_array( $commentdata['comment_meta'] ) ) {
        foreach ( $commentdata['comment_meta'] as $meta_key => $meta_value ) {
            add_comment_meta( $comment_id, $meta_key, $meta_value );
        }
    }

    // 4. 清理缓存、发送通知等等 (省略)

    return $comment_id;
}

可以看到，在评论插入数据库之后，紧接着就是处理元数据的部分。核心代码就那么几行，但是“麻雀虽小，五脏俱全”，这里面包含了不少值得深究的细节。

`comment_meta` 数组：元数据的载体

在wp_insert_comment()函数中，元数据主要通过 $commentdata['comment_meta'] 数组传递。这是一个关联数组，key是元数据的键名 (meta key)，value是元数据的值 (meta value)。

举个例子，假设我们想在插入评论的同时，添加一个名为 rating 的元数据，值为 5，以及一个名为 helpful_count 的元数据，值为 10。那么，$commentdata 数组应该像这样：

$commentdata = array(
    'comment_post_ID' => 1, // 文章ID
    'comment_author' => '张三',
    'comment_author_email' => '[email protected]',
    'comment_content' => '这文章写得真不错！',
    'comment_type' => '', // 默认为空，表示普通评论
    'comment_meta' => array(
        'rating' => 5,
        'helpful_count' => 10,
    ),
);

$comment_id = wp_insert_comment( $commentdata );

在wp_insert_comment()函数内部，会遍历 $commentdata['comment_meta'] 数组，并将每个键值对传递给 add_comment_meta() 函数。

`add_comment_meta()`：添加元数据的“主力干将”

add_comment_meta() 函数位于 wp-includes/comment.php 文件中，负责将元数据添加到数据库中。它的源码如下 (简化版):

function add_comment_meta( $comment_id, $meta_key, $meta_value, $unique = false ) {
    global $wpdb;

    if ( ! is_numeric( $comment_id ) || $comment_id <= 0 ) {
        return false;
    }

    $meta_key = wp_unslash( $meta_key );
    $meta_value = wp_unslash( $meta_value );

    $meta_key = apply_filters( 'add_comment_meta_key', $meta_key, $comment_id );

    if ( is_protected_meta( $meta_key, 'comment' ) ) {
        return false;
    }

    if ( $unique ) {
        // 检查是否已经存在相同的 meta_key 和 meta_value
        $check = $wpdb->get_var( $wpdb->prepare(
            "SELECT meta_id FROM $wpdb->commentmeta WHERE comment_id = %d AND meta_key = %s",
            $comment_id,
            $meta_key
        ) );
        if ( $check ) {
            return false; // 如果已经存在，则不添加
        }
    }

    $meta_value = maybe_serialize( $meta_value );

    $data = compact( 'comment_id', 'meta_key', 'meta_value' );

    $result = $wpdb->insert( $wpdb->commentmeta, $data );

    if ( ! $result ) {
        return false;
    }

    wp_cache_delete( $comment_id, 'comment_meta' );

    return $wpdb->insert_id;
}

让我们逐行分析一下：

参数校验： 首先，检查 $comment_id 是否为有效的数字。
数据清洗： 使用 wp_unslash() 函数去除 $meta_key 和 $meta_value 中的反斜杠。这是为了防止SQL注入攻击。
add_comment_meta_key 过滤器： 允许开发者通过过滤器修改 $meta_key。这提供了一个灵活的扩展点。
保护元数据： 使用 is_protected_meta() 函数检查 $meta_key 是否为受保护的元数据。如果是，则不添加。受保护的元数据通常是一些内部使用的、不希望被随意修改的元数据。WordPress 默认会过滤以下划线 _ 开头的元数据。
unique 参数： 如果 $unique 参数为 true，则检查是否已经存在相同的 $meta_key。如果已经存在，则不添加。这个参数可以用来防止重复添加相同的元数据。
序列化： 使用 maybe_serialize() 函数序列化 $meta_value。如果 $meta_value 是一个数组或对象，则会被序列化成字符串，以便存储到数据库中。
插入数据： 使用 $wpdb->insert() 函数将元数据插入到 wp_commentmeta 表中。
清理缓存： 使用 wp_cache_delete() 函数清理评论元数据的缓存。
返回值： 返回新插入的元数据的 ID。

`wp_commentmeta` 表：元数据的“安身之所”

所有的评论元数据都存储在 wp_commentmeta 表中。这个表的结构如下：

字段名	数据类型	描述
meta_id	bigint(20) unsigned	元数据ID，主键，自增长。
comment_id	bigint(20) unsigned	评论ID，外键，关联到 `wp_comments` 表的 `comment_ID` 字段。
meta_key	varchar(255)	元数据键名。
meta_value	longtext	元数据值。

可以看到，wp_commentmeta 表通过 comment_id 字段与 wp_comments 表关联，实现了评论和元数据之间的关联。

获取评论元数据

既然能添加，那自然也能获取。 WordPress 提供了以下函数来获取评论元数据：

get_comment_meta( $comment_id, $key = '', $single = false )：获取评论的元数据。
- $comment_id：评论ID。
- $key：要获取的元数据的键名。如果为空，则返回所有元数据。
- $single：是否只返回单个值。如果为 true，则只返回第一个值。如果为 false，则返回一个数组。

例如，要获取评论 ID 为 123 的 rating 元数据，可以使用以下代码：

$rating = get_comment_meta( 123, 'rating', true );

if ( $rating ) {
    echo '评分：' . $rating;
} else {
    echo '没有评分信息';
}

更新和删除评论元数据

除了添加和获取，WordPress 还提供了更新和删除评论元数据的函数：

update_comment_meta( $comment_id, $meta_key, $meta_value, $prev_value = '' )：更新评论的元数据。
- $comment_id：评论ID。
- $meta_key：要更新的元数据的键名。
- $meta_value：新的元数据值。
- $prev_value：旧的元数据值。如果指定了 $prev_value，则只有当数据库中已存在的元数据值与 $prev_value 相同时，才会更新。
delete_comment_meta( $comment_id, $meta_key, $meta_value = '' )：删除评论的元数据。
- $comment_id：评论ID。
- $meta_key：要删除的元数据的键名。
- $meta_value：要删除的元数据值。如果指定了 $meta_value，则只有当数据库中已存在的元数据值与 $meta_value 相同时，才会删除。

实际应用场景

评论元数据在实际开发中有很多应用场景，例如：

用户评分： 允许用户对评论进行评分，并将评分存储为元数据。
点赞/踩： 记录用户对评论的点赞和踩数。
评论举报： 标记评论是否被举报，以及举报的原因。
自定义字段： 添加自定义字段，例如评论的来源、评论的设备等等。

总结

wp_insert_comment() 函数通过 $commentdata['comment_meta'] 数组和 add_comment_meta() 函数，实现了评论元数据的添加。WordPress 提供了完整的 API，包括添加、获取、更新和删除评论元数据，方便开发者进行灵活的扩展和定制。理解了这些，你就可以在WordPress中自由地玩转评论元数据了！

希望今天的分析对大家有所帮助。记住，源码的世界充满了惊喜，只要你敢于探索，就能发现更多有趣的知识！下次再见！

wp_insert_comment() 总览

comment_meta 数组：元数据的载体

add_comment_meta()：添加元数据的“主力干将”

wp_commentmeta 表：元数据的“安身之所”