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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。