説明
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' ショート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に各要素のデフォルト値を設定した連想配列となる。$r = apply_filters( 'wp_list_comments_args', $r );
アクション
実行するアクションはありません。ソースファイル
/wp-includes/comment-template.php最終更新 : 2014年09月18日 13:00
関連
お勧め
Posts filter multiselect:プラグイン作ってみました(2022年4月8日 更新)
先週の金曜日、知り合いの方から「投稿一覧ページで絞り込みを行う際、複数選択できないか」といった問い合わせがあり、その時には「標準では無理ですね」と返答しました。このこと自体は事実なのですが、要するに「複数選択可能なドロップダウンメニュー」が実現できれば対応するのはそれほど難しくないような気がしました。この週末、そんなノリでちょっとコーディングしてできたのがこのプラグインです。全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)
query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?Contact Form 7に確認フェーズを(2012年12月16日 更新)
Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。古めのリビジョンを削除した時のメモ(2022年5月16日 更新)
大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。
プラグインで注意が必要な関数(2013年11月27日 更新)
先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。