説明
パラメータ
- $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最終更新 : 2014年09月18日 13:00
関連
お勧め
ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)
今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。
the_date関数で投稿日を確実に表示する(2011年12月20日 更新)
投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。投稿内容に応じてwpautopを制御する(2013年8月13日 更新)
投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。
xmlrpc.phpへのアクセスについてちょっと考えた(2018年5月27日 更新)
少し前のことですが、こちらのサーバーを何度かダウンさせてしまったのですが、その原因はxmlrpc.phpへアクセスが集中したことによってサーバーが過負荷となってしまったというものでした。すぐにサーバー性能を上げることはできないため、xmlrpc.phpのアクセスを全部拒否するという暫定対応してしまいました。
メディアライブラリに絞り込み用の「投稿タグ」を追加する(2014年6月24日 更新)
この記事は、先月投稿したコラム「メディア(attachment)を拡張してより便利に活用する」の続編。メディアで「投稿タグ」を追加するだけで「メディアライブラリ」ページの投稿一覧の中には「タグ」カラムが追加されるが、今回はその「投稿タグ」で絞り込み検索に対応してみる。