• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

テンプレートタグ/comment class

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「テンプレートタグ/comment class」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

この関数はコメントに付けるクラスを表示します。これを利用するとテーマ作成者がスタイル指定を簡単に行えるようになります。

詳細については post_class() も見てください。

使い方

デフォルトの使い方:

<?php comment_class(); ?>

すべてのパラメータを指定する場合:

<?php comment_class( $class, $comment_id, $post_id, $echo ) ?>

パラメータ

$class
文字列|配列) (オプション) クラスのリストに追加する一つ以上のクラス
初期値: 空文字列
$comment_id
整数) (オプション) コメント ID
初期値: null
$post_id
整数) (オプション) 投稿 ID
初期値: null
$echo
真偽値) (オプション) 表示するか、値として返すか
初期値: true
  • true - 表示する
  • false - 表示せず、値として返す

戻り値

(文字列) 
コメントに付けるクラス属性。$echofalse の場合のみ値を返す。

用例

<li <?php comment_class(); ?> id="li-comment-<?php comment_ID() ?>">

comment_class()div などの HTML タグに付ける class="何々" の部分を出力します。これには comment, even (または odd), thread-even, depth-1 など幾つかの異なるクラスを含みます。これを使えば、テーマのそれぞれの部分にそれぞれのやり方でスタイルを簡単に付けることができます。

具体的には、以下のクラスがそれぞれの条件に応じて追加されます:

  • コメントの種類: 普通のコメントの場合、"comment" クラスを追加します。他の種類(トラックバックピンバック)の場合は comment_type の値をクラスとして追加します。
  • ユーザー ID: 登録済みユーザーのコメントの場合、"byuser" と、"comment-author-" に無害化(スペースを除去)した user_nicename を繋げたクラスを追加します。また、投稿の作成者がコメントした場合は "bypostauthor" クラスを追加します。
  • 奇数/偶数: コメント数が偶数の場合、"even" クラスを追加します。そうでなければ "alt""odd" クラスを追加します。
  • コメントの深さ: "depth-" にコメントの深さを表す数値を繋げたクラスを常に追加します。
  • 最上位のコメント: コメントの深さが最上位(1)である場合、コメント数が偶数なら "thread-even" クラスを、奇数なら "thread-alt""thread-odd" クラスを追加します。
  • comment_class() にオプションの $class パラメータが指定されると、それが上記のクラスに追加されます。これは独自のカスタムコメントクラスを定義するのに利用できます。

独自のクラスを追加するには comment_class() を次のように呼び出します:

<?php comment_class( 'special' ); ?>

これはクラスのリストに "special" を追加します。

参考

  • comment_class() は以下のグローバル変数を使用します。comment_class() を呼び出す前にこれらの変数をセットすると出力を変えることができます:
  • $comment_alt
  • $comment_depth
  • $comment_thread_alt
例えば先頭のコメントを偶数番目にするには $comment_alt = FALSE とします。その後 comment_class() が変数の値を更新します。
  • コメントのクラスを表示する前に apply_filters() を使って 'comment_class' フィルターフックを呼び出します。パラメータは、表示するクラス、$class, $comment_id, $post_id です。

変更履歴

  • 2.7.0 から導入されました。

ソースファイル

comment_class()wp-includes/comment-template.php にあります。

コメント関数: cancel_comment_reply_link(), comment_author(), comment_author_email(), comment_author_email_link(), comment_author_IP(), comment_author_link(), comment_author_rss(), comment_author_url(), comment_author_url_link(), comment_class(), comment_date(), comment_excerpt(), comment_form_title(), comment_form(), comment_ID(), comment_id_fields() / en, comment_reply_link(), comment_text(), comment_text_rss(), comment_time(), comment_type(), comments_link, comments_number(), comments_open(), comments_popup_link(), comments_popup_script(), comments_rss_link(), get_avatar(), next_comments_link(), paginate_comments_links(), permalink_comments_rss(), previous_comments_link(), wp_list_comments()



関数リファレンステンプレートタグ目次もご覧ください。


この記事は翻訳時に編集が必要であるとマークされていました。その為Codex原文が大きく編集されている可能性があります。内容を確認される際は原文を参照していただき、可能であれば本項目へ反映させてください。よりよいCodexを作成するためのお手伝いをお願いします。

最新英語版: WordPress Codex » Function Reference/comment_class最新版との差分