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

お勧め

Post-tag automaton：プラグイン作ってみました（2012年12月24日 更新）

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

常時SSL接続に変更しました（2018年5月27日 更新）

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」（CentOS 6系、Apache 2.2系）上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

5.3の新機能：サイト管理者のメールアドレスを定期的に確認する（2019年9月27日 更新）

「WordPress 5.3 Beta 1」に記載されていた「Admin Email Verification」の項目が目に留まる。管理者のメールアドレスを定期的に確認するという仕組みがどんなものなのか気になったので、ちょっと調べてみた。

5.3の新機能：JPEG画像の向きを自動調整（2019年10月17日 更新）

「WordPress 5.3 Beta 1」に記載されていた「Automatic image rotation during upload」という見出し。画像ファイルに含まれるEXIF情報内の「向き」により、画像の向きを自動的に調整するというもの。どんな実装なのか気になったのでソースコードをざっくり眺めてみた。

投稿画面のウェジェットを2列にする（2013年4月17日 更新）

ダッシュボード画面ではスクリーンレイアウトを最大4列まで選択できるのに、投稿画面は1列か2列のどちらか。高解像度のディスプレイを使っていると、投稿画面では大画面のメリットを生かせていない理由がここにあるのではと感じ、3列対応にしてみた。