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

各位观众老爷，晚上好！我是你们的老朋友，今天咱们来聊聊WordPress里面一个“默默奉献”的函数：wp_insert_comment()。别看它名字平平无奇，但它可是评论界的中流砥柱，所有评论的插入、更新都离不开它。今天我们就来扒一扒它的源码，特别是它如何处理评论的元数据(metadata)的。

开场白：评论，WordPress的灵魂伴侣

在WordPress的世界里，评论就像是文章的灵魂伴侣，它们让文章不再孤单，让读者可以参与讨论，发表自己的看法。而wp_insert_comment()函数，就是连接文章和评论的桥梁。

正片开始：wp_insert_comment() 源码浅析

wp_insert_comment() 函数位于 wp-includes/comment.php 文件中。我们先来大致看一下它的结构：

function wp_insert_comment( $commentdata ) {
    global $wpdb;

    // 1. 数据预处理和验证

    // 2. 检查评论是否重复

    // 3. 准备 SQL 语句

    // 4. 执行 SQL 插入或更新评论

    // 5. 处理评论元数据

    // 6. 清理缓存

    // 7. 触发动作钩子

    // 8. 返回评论 ID
}

今天我们主要关注第5步： 处理评论元数据。

什么是评论元数据？

首先，得搞明白什么是“评论元数据”。简单来说，它就像是评论的“附加属性”，你可以用它来存储任何你想和评论关联的数据。比如，你可以记录评论者的IP地址，评论的评分，或者其他任何自定义信息。

评论元数据存储在 wp_commentmeta 表中。这个表有四个字段：

字段名	数据类型	描述
meta_id	bigint(20) unsigned	元数据的唯一ID，自增主键
comment_id	bigint(20) unsigned	关联的评论ID
meta_key	varchar(255)	元数据的键名，相当于“属性名”
meta_value	longtext	元数据的值，相当于“属性值”

wp_insert_comment() 如何处理元数据？

在 wp_insert_comment() 函数中，处理元数据的代码通常出现在评论插入/更新成功之后。它会检查 $commentdata 数组中是否有以 'meta_input' 为键的子数组。如果有，就遍历这个子数组，将里面的数据插入或更新到 wp_commentmeta 表中。

if ( isset( $commentdata['meta_input'] ) && is_array( $commentdata['meta_input'] ) ) {
    foreach ( $commentdata['meta_input'] as $meta_key => $meta_value ) {
        update_comment_meta( $comment_id, $meta_key, $meta_value );
    }
}

这段代码非常简洁明了：

检查是否存在 meta_input: 首先，它检查 $commentdata 数组中是否存在 'meta_input' 键，并且它的值是不是一个数组。只有满足这两个条件，才会执行后面的代码。
循环处理元数据: 然后，它使用 foreach 循环遍历 meta_input 数组。数组的键 $meta_key 就是元数据的键名，数组的值 $meta_value 就是元数据的值。
调用 update_comment_meta(): 在循环中，它会调用 update_comment_meta() 函数，将元数据插入或更新到 wp_commentmeta 表中。 update_comment_meta() 函数会智能地判断是插入新的元数据，还是更新已有的元数据。

update_comment_meta() 函数：元数据管理的幕后英雄

update_comment_meta() 函数是 WordPress 中管理评论元数据的核心函数。它位于 wp-includes/comment.php 文件中，负责插入、更新和删除评论元数据。

我们来看一下 update_comment_meta() 的源码（简化版）：

function update_comment_meta( $comment_id, $meta_key, $meta_value, $prev_value = '' ) {
    global $wpdb;

    // 1. 参数验证

    // 2. 清理 meta_key 和 meta_value

    // 3. 检查是否需要删除元数据

    // 4. 检查是否已经存在相同的元数据

    // 5. 插入或更新元数据

    // 6. 清理缓存

    // 7. 触发动作钩子

    // 8. 返回 meta_id
}

让我们重点关注第5步：插入或更新元数据。

update_comment_meta() 函数会先查询 wp_commentmeta 表，看看是否已经存在 comment_id 和 meta_key 都相同的记录。

如果不存在: 说明这是一个新的元数据，需要插入到 wp_commentmeta 表中。

$wpdb->insert(
    $wpdb->commentmeta,
    array(
        'comment_id' => $comment_id,
        'meta_key'   => $meta_key,
        'meta_value' => $meta_value,
    ),
    array( '%d', '%s', '%s' )
);

$meta_id = $wpdb->insert_id;

这段代码使用 $wpdb->insert() 函数将新的元数据插入到 wp_commentmeta 表中。 %d, %s, %s 是占位符，用于防止 SQL 注入。

如果存在: 说明这是一个已有的元数据，需要更新。

$wpdb->update(
    $wpdb->commentmeta,
    array( 'meta_value' => $meta_value ),
    array( 'meta_id' => $existing_meta['meta_id'] ),
    array( '%s' ),
    array( '%d' )
);

$meta_id = $existing_meta['meta_id'];

这段代码使用 $wpdb->update() 函数更新 wp_commentmeta 表中已有的元数据。

实战演练：添加自定义评论元数据

光说不练假把式，我们来做一个实战演练，演示如何使用 wp_insert_comment() 函数添加自定义的评论元数据。

假设我们想记录评论者的 IP 地址。我们可以这样做：

获取评论者的 IP 地址：
```
$comment_ip = $_SERVER['REMOTE_ADDR'];
```

准备 commentdata 数组：

$commentdata = array(
    'comment_post_ID' => $post_id, // 文章ID
    'comment_author' => $author_name, // 评论者姓名
    'comment_author_email' => $author_email, // 评论者邮箱
    'comment_content' => $comment_content, // 评论内容
    'comment_type' => '', // 评论类型
    'comment_parent' => 0, // 父评论ID
    'user_id' => $user_id, // 用户ID
    'comment_author_IP' => $comment_ip, // 评论者IP（可选，但推荐）
    'comment_agent' => $_SERVER['HTTP_USER_AGENT'], // 评论者浏览器信息 （可选）
    'comment_date' => current_time( 'mysql' ), // 评论时间
    'comment_approved' => 1, // 评论是否审核通过
    'meta_input' => array(
        'comment_ip' => $comment_ip, // 自定义元数据：评论者IP
        'comment_score' => 5, // 自定义元数据：评论评分
    ),
);

注意，我们添加了一个 meta_input 数组，并在其中添加了 'comment_ip' 和 'comment_score' 两个键值对。这就是我们要添加的自定义评论元数据。

调用 wp_insert_comment() 函数：
```
$comment_id = wp_insert_comment( $commentdata );

if ( $comment_id ) {
    // 评论插入成功
    echo '评论发表成功！';
} else {
    // 评论插入失败
    echo '评论发表失败！';
}
```
调用 wp_insert_comment() 函数，将 $commentdata 数组传递给它。函数会自动处理评论元数据，将 'comment_ip' 和 'comment_score' 存储到 wp_commentmeta 表中。

如何获取评论元数据？

添加了评论元数据之后，我们当然也需要能够获取它。 WordPress 提供了 get_comment_meta() 函数来获取评论元数据。

$comment_ip = get_comment_meta( $comment_id, 'comment_ip', true );
$comment_score = get_comment_meta( $comment_id, 'comment_score', true );

echo '评论者IP：' . $comment_ip . '<br>';
echo '评论评分：' . $comment_score . '<br>';

get_comment_meta() 函数有三个参数：

$comment_id: 评论ID。
$meta_key: 元数据的键名。
$single: 是否只返回单个值。如果设置为 true，则返回单个值；如果设置为 false，则返回一个数组。

删除评论元数据

WordPress 提供了 delete_comment_meta() 函数来删除评论元数据。

delete_comment_meta( $comment_id, 'comment_ip' );

delete_comment_meta() 函数有两个参数：

$comment_id: 评论ID。
$meta_key: 要删除的元数据的键名。

注意事项

安全第一: 在处理评论元数据时，一定要注意安全性，防止恶意用户通过修改元数据来攻击你的网站。要对用户输入进行验证和过滤，避免 SQL 注入等安全问题。
性能优化: 如果你的网站有很多评论，并且每个评论都有大量的元数据，可能会影响网站的性能。要合理设计元数据的结构，避免存储过多的冗余数据。可以考虑使用缓存来提高性能。
数据类型: meta_value 字段是 longtext 类型，可以存储任意长度的字符串。但是，为了提高性能，建议尽量使用较短的字符串。如果需要存储数字或其他类型的数据，可以在插入数据之前进行类型转换。
钩子的妙用: wp_insert_comment， update_comment_meta, delete_comment_meta 等函数都提供了丰富的动作钩子，你可以在这些钩子上添加自定义代码，实现更复杂的功能。例如，你可以在评论插入之后，自动发送邮件通知管理员。

总结

wp_insert_comment() 函数是 WordPress 评论系统的核心函数，它负责评论的插入和更新。评论元数据是评论的附加属性，可以用来存储任何你想和评论关联的数据。 wp_insert_comment() 函数通过 meta_input 数组来处理评论元数据，并使用 update_comment_meta() 函数将元数据插入或更新到 wp_commentmeta 表中。通过 get_comment_meta() 和 delete_comment_meta() 函数，我们可以方便地获取和删除评论元数据。

掌握了这些知识，你就可以更好地理解 WordPress 的评论系统，并根据自己的需求进行定制和扩展。

彩蛋：一些建议

善用Transient API，你可以将一些常用的评论元数据缓存起来，减少数据库查询的次数，提高网站的性能。
对于一些敏感的元数据，比如用户的IP地址，要进行加密存储，防止泄露。
使用自定义字段管理工具，可以更方便地管理评论元数据。例如，可以使用 Advanced Custom Fields (ACF) 插件。

今天的讲座就到这里，希望对大家有所帮助。下次有机会再和大家分享更多 WordPress 的技术知识。感谢大家的收听！祝大家编程愉快！

发表回复 取消回复

发表回复取消回复