发布于 由admin

深入理解 `get_comment_meta()` 函数的源码，它是如何从 `wp_commentmeta` 表中获取评论元数据的？

各位观众老爷们，晚上好！我是你们今晚的导游，即将带领大家深入WordPress的腹地，探索get_comment_meta()这个小可爱是如何从wp_commentmeta表里扒拉数据的。准备好了吗？ Let’s go!

第一站：认识一下我们的主角和舞台

首先，咱们得认识一下今天的主角：get_comment_meta()。这货是WordPress里用来获取评论元数据的函数，简单来说，就是获取与特定评论相关联的额外信息。比如，你可能想给评论添加一个“点赞数”或者“举报理由”之类的，这些都可以用评论元数据来存储。

我们的舞台是wp_commentmeta表。这是一个专门用来存放评论元数据的数据库表。它的结构大致如下：

字段名 数据类型 描述
meta_id bigint(20) unsigned 元数据 ID，主键，自增长。
comment_id bigint(20) unsigned 评论 ID，关联到 wp_comments 表。
meta_key varchar(255) 元数据的键名，用来标识元数据的类型。
meta_value longtext 元数据的值，可以是字符串、数字、数组、对象等。

第二站：get_comment_meta() 的庐山真面目

别急，先别直接啃源码，咱们先看看get_comment_meta()函数的基本用法。

<?php
$comment_id = 123; // 假设我们要获取评论ID为123的元数据
$meta_key = 'like_count'; // 假设我们要获取点赞数
$single = true; // 如果设置为true，则只返回单个值，否则返回数组

$like_count = get_comment_meta( $comment_id, $meta_key, $single );

if ( $like_count ) {
    echo "评论点赞数: " . $like_count;
} else {
    echo "该评论还没有点赞数元数据";
}
?>

上面的代码就是从评论ID为123的评论中，获取like_count这个元数据的值。$single参数如果设置为true，那么get_comment_meta()会直接返回这个值，否则返回一个包含这个值的数组。

第三站：源码探险之旅 – 深入 get_comment_meta()

现在，重头戏来了！让我们一起扒开get_comment_meta()的源码，看看它到底是怎么工作的。 get_comment_meta 函数位于 /wp-includes/meta.php 文件中 (大约在 349 行)。简化后的代码如下（去除了部分过滤和兼容性代码，以便更好地理解核心逻辑）：

<?php
function get_comment_meta( $comment_id, $key = '', $single = false ) {
    global $wpdb, $wp_commentmeta_table;

    $comment_id = absint( $comment_id );
    if ( empty( $comment_id ) ) {
        return false;
    }

    $key = wp_unslash( $key );

    $meta_cache = wp_cache_get( $comment_id, 'comment_meta' );

    if ( ! $meta_cache || ! is_array( $meta_cache ) || ( ( ! empty( $key ) && ! isset( $meta_cache[ $key ] ) ) ) ) {
        $meta_cache = update_comment_meta_cache( $comment_id );
    }

    if ( empty( $key ) ) {
        return $meta_cache;
    }

    if ( isset( $meta_cache[ $key ] ) ) {
        $value = $meta_cache[ $key ];
    } else {
        return false;
    }

    if ( $single ) {
        if ( is_array( $value ) ) {
            return $value[0];
        } else {
            return $value;
        }
    } else {
        return $value;
    }
}
?>

让我们一步一步地分析这段代码：

  1. 函数签名和参数处理:

    function get_comment_meta( $comment_id, $key = '', $single = false ) {
   global $wpdb, $wp_commentmeta_table;

   $comment_id = absint( $comment_id );
   if ( empty( $comment_id ) ) {
       return false;
   }

   $key = wp_unslash( $key );
    • 函数接受三个参数：$comment_id (评论ID)，$key (元数据的键名，可选)，$single (是否只返回单个值，可选)。
    • 使用global关键字引入全局变量$wpdb（WordPress数据库对象）和$wp_commentmeta_table（评论元数据表名）。
    • 对$comment_id进行安全处理，确保它是一个整数。如果$comment_id为空，直接返回false。
    • 使用 wp_unslash 对 $key 进行反斜杠转义处理，确保键名安全。

  2. 缓存机制：wp_cache_get() 和 update_comment_meta_cache()

    $meta_cache = wp_cache_get( $comment_id, 'comment_meta' );

if ( ! $meta_cache || ! is_array( $meta_cache ) || ( ( ! empty( $key ) && ! isset( $meta_cache[ $key ] ) ) ) ) {
   $meta_cache = update_comment_meta_cache( $comment_id );
}
    • WordPress使用了缓存机制来提高性能。这里首先尝试从缓存中获取评论的元数据。wp_cache_get()函数会尝试从缓存中获取指定评论ID的元数据，缓存组为'comment_meta'。
    • 如果缓存不存在、不是数组，或者指定的键名$key不在缓存中，那么就调用update_comment_meta_cache()函数来更新缓存。
    • update_comment_meta_cache()函数负责从数据库中查询评论的所有元数据，并将其存储到缓存中。这个函数是性能优化的关键，因为它避免了多次查询数据库。

  3. 从缓存中获取数据:

    if ( empty( $key ) ) {
   return $meta_cache;
}

if ( isset( $meta_cache[ $key ] ) ) {
   $value = $meta_cache[ $key ];
} else {
   return false;
}
    • 如果没有指定$key，那么直接返回整个缓存数组。
    • 如果指定了$key，那么从缓存数组中查找对应的键值。如果找到了，就将值赋给$value；否则，返回false。

  4. 处理 $single 参数:

    if ( $single ) {
   if ( is_array( $value ) ) {
       return $value[0];
   } else {
       return $value;
   }
} else {
   return $value;
}
    • 根据$single参数的值，决定返回单个值还是数组。
    • 如果$single为true，并且$value是一个数组，那么返回数组的第一个元素；否则，直接返回$value。
    • 如果$single为false，那么直接返回$value（也就是整个数组）。

第四站：深入 update_comment_meta_cache()

现在，我们再深入一下update_comment_meta_cache()函数，看看它是如何从数据库中获取数据的。 update_comment_meta_cache 函数位于 /wp-includes/meta.php 文件中(大约在 140 行)。 同样，我将简化代码如下：

<?php
function update_comment_meta_cache( $comment_ids ) {
    global $wpdb, $wp_commentmeta_table;

    $comment_ids = array_map( 'absint', (array) $comment_ids );
    $comment_ids = array_filter( $comment_ids );

    if ( empty( $comment_ids ) ) {
        return false;
    }

    $ids = implode( ',', $comment_ids );

    $cache = array();
    $results = $wpdb->get_results( "SELECT comment_id, meta_key, meta_value FROM $wp_commentmeta_table WHERE comment_id IN ($ids)", OBJECT );

    if ( ! empty( $results ) ) {
        foreach ( $results as $result ) {
            $comment_id = intval( $result->comment_id );
            $meta_key = $result->meta_key;
            $meta_value = $result->meta_value;

            $meta_value = maybe_unserialize( $meta_value );

            $cache[ $comment_id ][ $meta_key ][] = $meta_value;
        }
    }

    foreach ( $comment_ids as $comment_id ) {
        if ( ! isset( $cache[ $comment_id ] ) ) {
            $cache[ $comment_id ] = array();
        }

        wp_cache_set( $comment_id, $cache[ $comment_id ], 'comment_meta' );
    }

    return $cache;
}
?>

这段代码主要做了以下几件事：

  1. 参数处理:

    $comment_ids = array_map( 'absint', (array) $comment_ids );
$comment_ids = array_filter( $comment_ids );

if ( empty( $comment_ids ) ) {
   return false;
}

$ids = implode( ',', $comment_ids );
    • 将$comment_ids转换为数组，并使用array_map()和absint()函数将数组中的每个元素转换为整数。
    • 使用array_filter()函数移除数组中的空元素。
    • 如果$comment_ids为空，直接返回false。
    • 将$comment_ids数组转换为一个以逗号分隔的字符串，用于构建SQL查询语句。

  2. 数据库查询:

    $results = $wpdb->get_results( "SELECT comment_id, meta_key, meta_value FROM $wp_commentmeta_table WHERE comment_id IN ($ids)", OBJECT );
    • 使用$wpdb->get_results()函数执行SQL查询语句，从wp_commentmeta表中获取指定评论ID的所有元数据。
    • 查询结果以对象数组的形式返回。

  3. 数据处理和缓存:

    if ( ! empty( $results ) ) {
   foreach ( $results as $result ) {
       $comment_id = intval( $result->comment_id );
       $meta_key = $result->meta_key;
       $meta_value = $result->meta_value;

       $meta_value = maybe_unserialize( $meta_value );

       $cache[ $comment_id ][ $meta_key ][] = $meta_value;
   }
}

foreach ( $comment_ids as $comment_id ) {
   if ( ! isset( $cache[ $comment_id ] ) ) {
       $cache[ $comment_id ] = array();
   }

   wp_cache_set( $comment_id, $cache[ $comment_id ], 'comment_meta' );
}
    • 遍历查询结果，将每一条元数据存储到$cache数组中。
    • 使用maybe_unserialize()函数对meta_value进行反序列化，因为存储在数据库中的值可能是序列化后的数据。
    • $cache数组的结构是这样的：$cache[评论ID][元数据键名][] = 元数据值。 同一个评论ID和元数据键名下可能有多个值，所以这里使用了[]来添加值。
    • 遍历$comment_ids数组，将每个评论ID的元数据存储到缓存中，使用wp_cache_set()函数。

  4. 返回值:

    return $cache;
    • 返回包含所有评论元数据的$cache数组。

第五站：总结与思考

通过这次源码探险，我们了解了get_comment_meta()函数是如何从wp_commentmeta表中获取评论元数据的。 总结一下：

  1. get_comment_meta()函数首先尝试从缓存中获取数据。
  2. 如果缓存不存在，或者指定的键名不在缓存中，那么就调用update_comment_meta_cache()函数来更新缓存。
  3. update_comment_meta_cache()函数从数据库中查询评论的所有元数据，并将其存储到缓存中。
  4. get_comment_meta()函数根据$single参数的值，决定返回单个值还是数组。

一些额外的思考:

  • 缓存的重要性: 缓存机制是提高WordPress性能的关键。get_comment_meta()函数充分利用了缓存，避免了频繁的数据库查询。
  • 数据序列化: 评论元数据的值可以是各种类型，包括字符串、数字、数组、对象等。为了将这些值存储到数据库中，WordPress使用了序列化技术。maybe_unserialize()函数用于将序列化后的数据还原为原始类型。
  • 安全性: 在处理用户输入时，一定要注意安全性。get_comment_meta()函数使用了absint()和wp_unslash()等函数来确保数据的安全。
  • 批量更新: update_comment_meta_cache 支持批量更新评论元数据缓存，这在处理大量评论时非常有用，可以显著减少数据库查询次数。

一些优化建议：

  • 避免过度使用元数据: 虽然元数据很方便，但是过度使用会增加数据库的负担，影响性能。尽量避免存储不必要的数据。
  • 合理设置缓存时间: 根据实际情况，合理设置缓存时间，避免缓存过期导致频繁的数据库查询。
  • 使用索引: 如果经常根据meta_key查询数据，可以考虑在wp_commentmeta表的meta_key字段上创建索引，提高查询效率。

好了，今天的讲座就到这里。希望大家通过这次源码探险，对get_comment_meta()函数有了更深入的了解。 记住，理解源码是成为WordPress高手的必经之路！ 感谢大家的光临，下次再见！

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注