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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。