概要
wp_list_comments関数は、WordPressにおいてコメントリストを表示するために使用されます。この関数は、テーマ内でコメントを表示する際によく利用されるもので、以下のような機能を実装する際に役立ちます：
- 投稿に対するユーザーからのコメントの一覧表示
- コメントの発表順序をカスタマイズ
- 各コメントに対するメタ情報（例えば、投稿者名や投稿日など）の表示
- コメントごとのHTMLマークアップのカスタマイズ
- スタイルやクラス名を指定して、コメントリストを整形
- コメントの数をカウントし、表示内容を切り替え
- 子コメント（返信）を含むコメントツリーの表示
- AJAXを用いたページネーションをサポート
構文
wp_list_comments( $args );
パラメータ
$args（配列）: コメントを表示するためのオプション設定を含む配列。主なオプションには、style,short_ping,avatar_size,callback,end-callbackなどがあり、詳細な表示方法を指定できます。
戻り値
- この関数は出力を直接行うため、特に値を返しません。HTML形式でコメントリストを出力します。
関連する関数
使用可能なバージョン
- この関数は、WordPress 1.5.0以降のバージョンから使用可能です。
コアファイルのパス
wp-includes/comment-template.php
サンプルコード
サンプル1: デフォルトのコメントリスト表示
<?php
if ( have_comments() ) {
wp_list_comments();
}
?>
このコードは、コメントが存在する場合にデフォルトのスタイルでコメントリストを表示します。
サンプル2: カスタムコールバック関数の使用
<?php
function my_custom_comments($comment, $args, $depth) {
echo '<li>' . get_comment_author($comment) . ': ' . get_comment_text($comment) . '</li>';
}
wp_list_comments( array( 'callback' => 'my_custom_comments' ) );
?>
このコードでは、カスタムコールバック関数 my_custom_comments を使用して、各コメントを独自の形式で表示します。
サンプル3: アバターサイズの指定
<?php
wp_list_comments( array( 'avatar_size' => 40 ) );
?>
このコードは、コメントのアバターのサイズを40pxに設定して、コメントリストを表示します。
サンプル4: スタイルの指定
<?php
wp_list_comments( array( 'style' => 'ol' ) );
?>
このコードでは、コメントリストを順序付きリスト（<ol>）として表示します。
サンプル5: 短いピンバックの表示制限
<?php
wp_list_comments( array( 'short_ping' => true ) );
?>
このコードは、短いピンバックを表示し、よりシンプルにコメントリストを表示します。
この関数のアクションでの使用可能性
| アクション名 | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
wp_list_comments関数は、特定のWordPressバージョンで非推奨や削除はされていません。