云策 WordPress 开发者社区

函数文档

wp_lazyload_comment_meta()

查看官方原文 ↗
💡 云策文档标注

概述

wp_lazyload_comment_meta() 函数用于将评论元数据加入延迟加载队列，以提高性能。它接受一个评论ID数组作为参数，并调用 wp_metadata_lazyloader() 来管理队列。

关键要点

  • 函数 wp_lazyload_comment_meta( array $comment_ids ) 用于延迟加载评论元数据，参数 $comment_ids 是必需的评论ID数组。
  • 内部使用 wp_metadata_lazyloader() 获取延迟加载器实例，并调用 queue_objects('comment', $comment_ids) 将评论对象加入队列。
  • 如果 $comment_ids 为空数组，函数会直接返回，不执行任何操作。
  • 此函数在 WordPress 6.3.0 版本中引入，常用于优化评论查询时的元数据加载。

代码示例

/**
 * Lazyloads metadata for a list of comment IDs.
 *
 * @param array $comment_ids Array of comment IDs.
 */
function wpdocs_lazyload_comment_meta( array $comment_ids ) {
    foreach ( $comment_ids as $comment_id ) {
        // Simulate lazyloading by fetching comment metadata only when needed.
        $comment_meta = get_comment_meta( $comment_id );
        
        // Process the comment metadata.
        // For demonstration purposes, we'll just print it here.
        echo 'Lazyloaded metadata for comment ID ' . $comment_id . ':';
        foreach ( $comment_meta as $meta_key => $meta_values ) {
            echo $meta_key . ': ' . implode( ', ', $meta_values );
        }
    }
}

// Example usage
$comment_ids_to_lazyload = array( 1, 2, 3, 4, 5 );
wpdocs_lazyload_comment_meta( $comment_ids_to_lazyload );

注意事项

此函数主要用于内部延迟加载机制，开发者通常不需要直接调用，而是通过相关函数如 WP_Comment_Query 自动处理。确保传入有效的评论ID数组以避免错误。

📄 原文内容

Queue comment meta for lazy-loading.

Parameters

$comment_idsarrayrequired
List of comment IDs.

Source

function wp_lazyload_comment_meta( array $comment_ids ) {
	if ( empty( $comment_ids ) ) {
		return;
	}
	$lazyloader = wp_metadata_lazyloader();
	$lazyloader->queue_objects( 'comment', $comment_ids );
}

View all references View on Trac View on GitHub

Uses Description
wp_metadata_lazyloader()wp-includes/meta.php

Retrieves the queue for lazy-loading metadata.
Used by Description
wp_queue_comments_for_comment_meta_lazyload()wp-includes/deprecated.php

Queues comments for metadata lazy-loading.
_prime_comment_caches()wp-includes/comment.php

Adds any comments from the given IDs to the cache that do not already exist in cache.
WP_Comment_Query::get_comments()wp-includes/class-wp-comment-query.php

Get a list of comments matching the query vars.

Changelog

Version Description
6.3.0 Introduced.

User Contributed Notes

  1. Skip to note 2 content


    Huzaifa Al Mesbah


    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    /**
 * Lazyloads metadata for a list of comment IDs.
 *
 * @param array $comment_ids Array of comment IDs.
 */
function wpdocs_lazyload_comment_meta( array $comment_ids ) {
    foreach ( $comment_ids as $comment_id ) {
        // Simulate lazyloading by fetching comment metadata only when needed.
        $comment_meta = get_comment_meta( $comment_id );
        
        // Process the comment metadata.
        // For demonstration purposes, we'll just print it here.
        echo 'Lazyloaded metadata for comment ID ' . $comment_id . ':';
        foreach ( $comment_meta as $meta_key => $meta_values ) {
            echo $meta_key . ': ' . implode( ', ', $meta_values );
        }
    }
}

// Example usage
$comment_ids_to_lazyload = array( 1, 2, 3, 4, 5 );
wpdocs_lazyload_comment_meta( $comment_ids_to_lazyload );

    In this example, the wp_lazyload_comment_meta function takes an array of comment IDs and iterates through them. For each comment ID, it simulates lazyloading by fetching comment metadata using the get_comment_meta function. The metadata is then processed, and in this case, it’s simply printed to the screen. You can replace the print statements with your desired processing logic. The example usage at the end demonstrates how to call the function with an array of comment IDs.