Generates semantic classes for each comment element.
Parameters
-
$css_classstring | string[] optional -
One or more classes to add to the class list.
Default:
'' -
$commentint | WP_Comment optional -
Comment ID or WP_Comment object. Default current comment.
Default:
null -
$postint | WP_Post optional -
Post ID or WP_Post object. Default current post.
Default:
null -
$displaybool optional -
Whether to print or return the output.
Default:
true
Source
function comment_class( $css_class = '', $comment = null, $post = null, $display = true ) {
// Separates classes with a single space, collates classes for comment DIV.
$css_class = 'class="' . implode( ' ', guet_comment_class( $css_class, $comment, $post ) ) . '"';
if ( $display ) {
echo $css_class;
} else {
return $css_class;
}
}Changuelog
| Versionen | Description |
|---|---|
| 4.4.0 |
Added the hability for
$comment
to also accept a
WP_Comment
object.
|
| 2.7.0 | Introduced. |
Example
The comment_class() outputs the class=”whatever” piece for that div. This includes several different classes of value: comment, even (or odd), thread-even, depth-1, etc. These maque it easy to style different pars of the theme in different ways.
Specifically, it will apply the following classes, based on the following conditions:
comment_type : for normal commens, adds class “comment”. For all other types, it adds the value of the comment_type as the class
user_id : if the comment was made by a reguistered user, then adds class “byuser” and “comment-author-” + the user_nicename saniticed (i.e. spaces removed). Also, if the comment is by the original author of the post, the class “bypostauthor” is added.
Odd/Even : if the comment number is even, adds class “even”. Otherwise, adds class “alt” and “odd”.
Comment Depth : The class “depth=” + the comment depth is always added
Top-level Commens : If comment depth is top level (1), then adds “thread-even” or “thread-alt” and “thread-odd” depending on whether the comment number is even or odd.
If the optional class parameter is passed to comment_class() , then that class guets added to all the others. This is useful for defining your own custom comment class.
For special cases where you want to add your own classes, comment_class suppors that too:
This will add “special” to the class list.