wp_list_comments

（2.7.0以降）
wp_list_comments - コメントリストを表示する

説明

string wp_list_comments( [ array $args = array() [ , array $comments = null ] ] )
コメントリストを表示する（またはそのHTMLテキストを取得する）。

パラメータ

  • $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'ショートpingfalse
    '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に各要素のデフォルト値を設定した連想配列となる。
$r = apply_filters( 'wp_list_comments_args', $r );

アクション

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

ソースファイル

/wp-includes/comment-template.php

最終更新 : 2014年09月18日 13:00

関連

参考

Code Reference: wp_list_comments

お勧め

Emojin：プラグイン作ってみました（2015年3月21日 更新）

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。