説明
パラメータ
- $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
関連
お勧め
oEmbed対応サイトを整理した(2020年4月6日 更新)
投稿記事にTwitterやYouTubeのURL(アドレス)を記述したとき、表示されるページにはリンクとしてではなく、埋め込んだURLの内容が表示される。この仕組み(機能)はoEmbedというもので、対応サイトは随時バージョンアップしている。
5.7の機能拡張:エクスポートファイルに更新日時が追加ほか(2021年2月23日 更新)
WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。
絵文字画像がPNGからSVGへ(2018年5月27日 更新)
WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。
投稿記事でrubyタグを使えるようにする(前編)(2012年1月25日 更新)
rubyなどのルビ関連タグはIEの独自サポートから始まり、少し前のChrome/Safariが追随して利用できるようになっている。Firefoxはいまだにサポートしていないのだが、それなりに代替表示されるので、投稿記事で使えるようにしてみた。個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。