wp_list_comments()


WordPressのwp_list_comments()関数は、投稿またはページに関連付けられたコメントリストを表示するために使用されます。

シンタックス

wp_list_comments( array $args = array(), array $comments = null );

引数の説明:

  • $args (array) — コメントリストをカスタマイズするための引数。
  • $comments (array) — 表示するコメントの配列。省略すると、現在の投稿のコメントが使用されます。

$argsの主なプロパティ:

  • style (string) — コメントリストの形式。ul、ol、またはdivを指定できます。デフォルトはul。
  • callback (callable) — コメントを出力するためのカスタムコールバック関数。
  • avatar_size (int) — アバター画像のサイズ（ピクセル単位）。デフォルトは32。
  • per_page (int) — 1ページに表示するコメントの数。デフォルトはすべてのコメント。
  • reverse_top_level (bool) — 最上位のコメントを逆順に並べるかどうか。デフォルトはfalse。

例1: シンプルなコメントリストの表示

投稿のデフォルトのコメントリストを表示します。

<?php wp_list_comments(); ?>

例2: アバターサイズを変更する

アバターサイズを64pxに設定してコメントリストを表示します。

<?php wp_list_comments( array( 'avatar_size' => 64 ) ); ?>

例3: カスタムコールバックを使用したコメントリスト

カスタムコールバック関数を使用してコメントの表示形式をカスタマイズします。

<?php
function my_custom_comments( $comment, $args, $depth ) {
    $tag = ( 'div' === $args['style'] ) ? 'div' : 'li';
    echo '<' . $tag . ' id="comment-' . get_comment_ID() . '">';
    echo '<p>' . get_comment_text() . '</p>';
    echo '</' . $tag . '>';
}
wp_list_comments( array( 'callback' => 'my_custom_comments' ) );
?>

例4: コメントをページ分割する

1ページに10件のコメントを表示し、次ページに切り替えられるように設定します。

<?php wp_list_comments( array( 'per_page' => 10 ) ); ?>

注意事項

  • $argsプロパティを正確に設定しないと、期待する出力が得られない場合があります。
  • カスタムコールバックを使用する際には、$comment、$args、$depthの値を適切に処理する必要があります。

関連機能：