发布于 由admin

详解 WordPress `WP_Comment_Query` 类的源码：如何查询评论，并支持多种过滤条件。

各位观众，掌声鼓励一下！今天咱们不讲段子，来点硬货，一起扒一扒 WordPress 评论查询的利器——WP_Comment_Query 类。这玩意儿，你如果想在 WordPress 里像个老中医一样精准地抓取评论，那可就绕不开它了。

开场白：评论查询，没那么简单

想象一下，你运营一个博客，每天评论如潮水般涌来。你想找出某个特定用户的评论？或者想找到未审核的评论？又或者想找到包含特定关键词的评论？ 如果没有一个强大的工具，那简直就是大海捞针。

WP_Comment_Query 就是你的大海捞针神器！它允许你构建复杂的查询条件，从数据库中检索出满足你需求的评论数据。别看名字长，用起来其实挺顺手的。

第一幕：WP_Comment_Query 的诞生

首先，我们看看如何创建一个 WP_Comment_Query 对象。

$args = array(
    // 查询参数，稍后详细讲解
);

$comment_query = new WP_Comment_Query( $args );

是不是很简单？ 关键在于 $args 这个数组，它决定了你的查询条件。 接下来，我们深入了解这个 $args 数组。

第二幕：$args 参数详解，参数表格来袭

$args 数组可以包含各种各样的参数，控制着评论查询的方方面面。为了方便大家理解，我整理了一个表格，把常用的参数都列出来了：

参数名 数据类型 描述 示例
number integer 返回评论的最大数量。如果设置为 0，则返回所有评论。 number => 10, // 返回最多 10 条评论
offset integer 从结果集中跳过的评论数量。 offset => 5, // 跳过前 5 条评论
orderby string 排序字段。可选值包括 comment_ID, comment_post_ID, comment_date, comment_author_email, comment_author_url, comment_author_IP, comment_karma, comment_approved, comment_type, comment_parent, user_id 和 comment_content。 orderby => ‘comment_date’, // 按评论日期排序
order string 排序方式。可选值包括 ASC (升序) 和 DESC (降序)。 order => ‘DESC’, // 降序排列
status string 评论状态。可选值包括 hold (待审核), approve (已审核), spam (垃圾评论), trash (已删除), all (所有状态)。 status => ‘approve’, // 只获取已审核的评论
post_id integer 只获取指定文章 ID 的评论。 post_id => 123, // 只获取文章 ID 为 123 的评论
post_ids array 获取指定多个文章 ID 的评论。 post_ids => array( 123, 456, 789 ), // 获取文章 ID 为 123, 456, 789 的评论
author_email string 只获取指定作者邮箱的评论。 author_email => ‘[email protected]’, // 只获取邮箱为 [email protected] 的评论
author_url string 只获取指定作者 URL 的评论。 author_url => ‘https://example.com‘, // 只获取 URL 为 https://example.com 的评论
author_IP string 只获取指定作者 IP 地址的评论。 author_IP => ‘127.0.0.1’, // 只获取 IP 地址为 127.0.0.1 的评论
keyword string 只获取包含指定关键词的评论。 keyword => ‘WordPress’, // 只获取包含关键词 "WordPress" 的评论
comment__in array 只获取指定评论 ID 的评论。 comment__in => array( 1, 2, 3 ), // 只获取 ID 为 1, 2, 3 的评论
comment__not_in array 排除指定评论 ID 的评论。 comment__not_in => array( 4, 5, 6 ), // 排除 ID 为 4, 5, 6 的评论
user_id integer 只获取指定用户 ID 的评论。 user_id => 7, // 只获取用户 ID 为 7 的评论
date_query array 按日期范围查询评论。 date_query => array(
array(
‘after’ => ‘2023-01-01’,
‘before’ => ‘2023-01-31’,
‘inclusive’ => true,
),
), // 获取 2023 年 1 月份的评论
fields string 返回的字段。可选值包括 ids (只返回评论 ID), id=>parent (返回评论 ID 和父评论 ID), all (返回所有字段)。 fields => ‘ids’, // 只返回评论 ID
hierarchical boolean 是否按层级结构返回评论。默认值为 false。 hierarchical => true, // 按层级结构返回评论
no_found_rows boolean 是否禁用 SQL_CALC_FOUND_ROWS。 如果你知道不需要总数，可以设置为 true 以提高性能。 no_found_rows => true, // 禁用 SQL_CALC_FOUND_ROWS
update_comment_meta_cache boolean 是否更新评论元数据缓存。 默认值为 true。 update_comment_meta_cache => false, // 不更新评论元数据缓存
update_comment_post_cache boolean 是否更新评论文章缓存。 默认值为 true。 update_comment_post_cache => false, // 不更新评论文章缓存

重要提示： 参数可以组合使用，构建出非常复杂的查询条件。 灵活运用这些参数，你就能精准地找到你想要的评论。

第三幕：实战演练，代码说话

光说不练假把式，我们来几个实际的例子。

例子 1：获取最近 10 条已审核的评论，按日期降序排列

$args = array(
    'number'  => 10,
    'status'  => 'approve',
    'orderby' => 'comment_date',
    'order'   => 'DESC',
);

$comment_query = new WP_Comment_Query( $args );

$comments = $comment_query->comments;

if ( $comments ) {
    foreach ( $comments as $comment ) {
        echo '<p>' . $comment->comment_content . '</p>';
    }
} else {
    echo '没有评论';
}

这段代码首先定义了一个 $args 数组，指定了查询条件：最多返回 10 条评论，状态为已审核，按评论日期降序排列。 然后，创建 WP_Comment_Query 对象，并将 $args 传递给它。 最后，通过 $comment_query->comments 获取查询结果，并遍历输出评论内容。

例子 2：获取指定文章 ID 的所有待审核评论

$post_id = 123; // 替换为你的文章 ID

$args = array(
    'post_id' => $post_id,
    'status'  => 'hold',
);

$comment_query = new WP_Comment_Query( $args );

$comments = $comment_query->comments;

if ( $comments ) {
    echo '<ul>';
    foreach ( $comments as $comment ) {
        echo '<li>' . $comment->comment_content . '</li>';
    }
    echo '</ul>';
} else {
    echo '该文章没有待审核的评论';
}

这个例子演示了如何获取指定文章 ID 的评论，并将评论状态设置为待审核。

例子 3：按日期范围查询评论

$args = array(
    'date_query' => array(
        array(
            'after'  => '2023-10-26',
            'before' => '2023-10-28',
            'inclusive' => true,
        ),
    ),
);

$comment_query = new WP_Comment_Query( $args );

$comments = $comment_query->comments;

if ( $comments ) {
    foreach ( $comments as $comment ) {
        echo '<p>' . $comment->comment_content . '</p>';
    }
} else {
    echo '该日期范围内没有评论';
}

这个例子展示了如何使用 date_query 参数来获取指定日期范围内的评论。

第四幕：进阶技巧，提升效率

除了基本的查询功能，WP_Comment_Query 还有一些进阶技巧，可以帮助你提升查询效率。

  • 使用 fields 参数： 如果你只需要评论 ID，可以将 fields 参数设置为 ids，这样可以减少数据库查询的数据量，提高查询速度。

    $args = array(
    'fields' => 'ids',
);

$comment_query = new WP_Comment_Query( $args );

$comment_ids = $comment_query->comments; // 此时 $comment_ids 是一个评论 ID 数组

  • 使用 no_found_rows 参数： 如果你不需要知道查询结果的总数量，可以将 no_found_rows 参数设置为 true，这样可以避免执行 SQL_CALC_FOUND_ROWS，提高查询速度。

    $args = array(
    'no_found_rows' => true,
);

$comment_query = new WP_Comment_Query( $args );

  • 利用缓存： WordPress 自身有缓存机制，可以缓存评论数据。 如果你频繁地查询相同的评论数据，可以考虑使用 WordPress 的缓存 API 来提高查询效率。

第五幕：避坑指南，小心驶得万年船

在使用 WP_Comment_Query 时，有一些常见的坑需要注意：

  • 参数类型错误： 确保你的参数类型与 WP_Comment_Query 要求的类型一致。 例如，post_id 必须是整数，status 必须是字符串。
  • SQL 注入风险： 虽然 WP_Comment_Query 会对参数进行一定的安全处理，但仍然要注意避免 SQL 注入风险。 特别是当参数来自用户输入时，一定要进行严格的验证和过滤。
  • 性能问题： 复杂的查询条件可能会导致性能问题。 尽量优化你的查询条件，避免一次性查询大量数据。 可以考虑使用分页或者延迟加载等技术来提高性能。
  • 不恰当的排序字段： 有些排序字段可能需要额外的索引才能高效地排序。例如，按 comment_content 排序可能需要全文索引，否则性能会很差。

第六幕：与其他函数的配合

WP_Comment_Query 通常不是孤立使用的。 它可以和其他 WordPress 函数配合使用，实现更强大的功能。

  • get_comment_meta() 和 update_comment_meta(): 这两个函数可以用来获取和更新评论的元数据。 你可以使用 WP_Comment_Query 找到特定的评论，然后使用这两个函数来操作评论的元数据。

  • wp_update_comment(): 这个函数可以用来更新评论的属性，例如评论内容、评论状态等。

压轴戏：总结与展望

WP_Comment_Query 是一个非常强大的评论查询工具，它可以帮助你轻松地从 WordPress 数据库中检索出你想要的评论数据。 掌握 WP_Comment_Query 的使用方法，可以让你更高效地管理你的 WordPress 评论。

希望今天的讲解对大家有所帮助。 记住，熟能生巧，多练习，多实践，你也能成为评论查询的高手！

感谢大家的观看，下次再见！ (掌声雷动)

发表回复

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