wp_list_comments

パラメータ

• $args
  連想配列でパラメータを指定（省略時はarray()）。

  キー名	意味	省略時の値
  'walker'	HTMLを生成するWalkerオブジェクト	null
  'max_depth'	深度	''
  'style'	スタイルとして'ul'、'ol'（または'div'）	'ul'
  'callback'	コールバック関数	null
  'end-callback'	終了時のコールバック関数	null
  'type'	有効なコメントタイプとして'all'、'comment'、'pingback'、'trackback'、'pings'のいずれか	'all'
  'page'	ページID	''
  'per_page'	1ページのコメント件数	''
  'avatar_size'	アバターサイズ	32
  'reverse_top_level'	トップレベルの表示順として'desc'、'asc'のいずれか	null
  'reverse_children'	子コメントを逆転する場合はtrue	''
  'format	フォーマットとして'html5'、'xhtml'のいずれか	テーマがHTML5をサポートしている場合は'html5'
  'short_ping'	ショートping	false
  'echo'	表示する場合はtrueを指定	true

• $comments
  コメントオブジェクトの配列を指定（省略時はnull）。

返り値

パラメータ$args['echo']がfalseの場合はコメントリストのHTMLテキストを返す。パラメータ$args['echo']がfalse（コメントリストを表示）の場合、明示的には何も返さない（nullを返す）。

注意

コメントリストの生成は、デフォルトではWalker_Commentオブジェクトで行うが、パラメータ$args['walker']に任意のWalkerオブジェクトを指定できる。

この関数内でメインクエリー（WP_Query）オブジェクトである$wp_query->max_num_comment_pagesを更新している。

使用例

• 現在の投稿のコメントリストを表示する。
  <?php wp_list_comments(); ?>
• 現在の投稿のコメントリストを取得する。
  <?php $list = wp_list_comments( array( 'echo'=>false ) ); ?>
• パラメータ$commentsをol要素で表示する。
  <?php wp_list_comments( array( 'style'=>'ol' ), $comments ); ?>

フィルター

[4.0.0]パラメータ$argsの初期設定後、'wp_list_comments_args'フィルターを呼び出す。パラメータ$rには$argsに各要素のデフォルト値を設定した連想配列となる。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/comment-template.php