3 * Comment template functions
5 * These functions are meant to live inside of the WordPress loop.
12 * Retrieve the author of the current comment.
14 * If the comment has an empty comment_author field, then 'Anonymous' person is
18 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
20 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to retrieve the author.
21 * Default current comment.
22 * @return string The comment author
24 function get_comment_author( $comment_ID = 0 ) {
25 $comment = get_comment( $comment_ID );
27 if ( empty( $comment->comment_author ) ) {
28 if ( $comment->user_id && $user = get_userdata( $comment->user_id ) )
29 $author = $user->display_name;
31 $author = __('Anonymous');
33 $author = $comment->comment_author;
37 * Filters the returned comment author name.
40 * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
42 * @param string $author The comment author's username.
43 * @param int $comment_ID The comment ID.
44 * @param WP_Comment $comment The comment object.
46 return apply_filters( 'get_comment_author', $author, $comment->comment_ID, $comment );
50 * Displays the author of the current comment.
53 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
55 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author.
56 * Default current comment.
58 function comment_author( $comment_ID = 0 ) {
59 $comment = get_comment( $comment_ID );
60 $author = get_comment_author( $comment );
63 * Filters the comment author's name for display.
66 * @since 4.1.0 The `$comment_ID` parameter was added.
68 * @param string $author The comment author's username.
69 * @param int $comment_ID The comment ID.
71 echo apply_filters( 'comment_author', $author, $comment->comment_ID );
75 * Retrieve the email of the author of the current comment.
78 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
80 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's email.
81 * Default current comment.
82 * @return string The current comment author's email
84 function get_comment_author_email( $comment_ID = 0 ) {
85 $comment = get_comment( $comment_ID );
88 * Filters the comment author's returned email address.
91 * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
93 * @param string $comment_author_email The comment author's email address.
94 * @param int $comment_ID The comment ID.
95 * @param WP_Comment $comment The comment object.
97 return apply_filters( 'get_comment_author_email', $comment->comment_author_email, $comment->comment_ID, $comment );
101 * Display the email of the author of the current global $comment.
103 * Care should be taken to protect the email address and assure that email
104 * harvesters do not capture your commentors' email address. Most assume that
105 * their email address will not appear in raw form on the site. Doing so will
106 * enable anyone, including those that people don't want to get the email
107 * address and use it for their own means good and bad.
110 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
112 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's email.
113 * Default current comment.
115 function comment_author_email( $comment_ID = 0 ) {
116 $comment = get_comment( $comment_ID );
117 $author_email = get_comment_author_email( $comment );
120 * Filters the comment author's email for display.
123 * @since 4.1.0 The `$comment_ID` parameter was added.
125 * @param string $author_email The comment author's email address.
126 * @param int $comment_ID The comment ID.
128 echo apply_filters( 'author_email', $author_email, $comment->comment_ID );
132 * Display the html email link to the author of the current comment.
134 * Care should be taken to protect the email address and assure that email
135 * harvesters do not capture your commentors' email address. Most assume that
136 * their email address will not appear in raw form on the site. Doing so will
137 * enable anyone, including those that people don't want to get the email
138 * address and use it for their own means good and bad.
141 * @since 4.6.0 Added the `$comment` parameter.
143 * @param string $linktext Optional. Text to display instead of the comment author's email address.
145 * @param string $before Optional. Text or HTML to display before the email link. Default empty.
146 * @param string $after Optional. Text or HTML to display after the email link. Default empty.
147 * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment.
149 function comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) {
150 if ( $link = get_comment_author_email_link( $linktext, $before, $after, $comment ) ) {
156 * Return the html email link to the author of the current comment.
158 * Care should be taken to protect the email address and assure that email
159 * harvesters do not capture your commentors' email address. Most assume that
160 * their email address will not appear in raw form on the site. Doing so will
161 * enable anyone, including those that people don't want to get the email
162 * address and use it for their own means good and bad.
165 * @since 4.6.0 Added the `$comment` parameter.
167 * @param string $linktext Optional. Text to display instead of the comment author's email address.
169 * @param string $before Optional. Text or HTML to display before the email link. Default empty.
170 * @param string $after Optional. Text or HTML to display after the email link. Default empty.
171 * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment.
172 * @return string HTML markup for the comment author email link. By default, the email address is obfuscated
173 * via the {@see 'comment_email'} filter with antispambot().
175 function get_comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) {
176 $comment = get_comment( $comment );
179 * Filters the comment author's email for display.
181 * Care should be taken to protect the email address and assure that email
182 * harvesters do not capture your commenter's email address.
185 * @since 4.1.0 The `$comment` parameter was added.
187 * @param string $comment_author_email The comment author's email address.
188 * @param WP_Comment $comment The comment object.
190 $email = apply_filters( 'comment_email', $comment->comment_author_email, $comment );
192 if ((!empty($email)) && ($email != '@')) {
193 $display = ($linktext != '') ? $linktext : $email;
195 $return .= sprintf( '<a href="%1$s">%2$s</a>', esc_url( 'mailto:' . $email ), esc_html( $display ) );
204 * Retrieve the HTML link to the URL of the author of the current comment.
206 * Both get_comment_author_url() and get_comment_author() rely on get_comment(),
207 * which falls back to the global comment variable if the $comment_ID argument is empty.
210 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
212 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's link.
213 * Default current comment.
214 * @return string The comment author name or HTML link for author's URL.
216 function get_comment_author_link( $comment_ID = 0 ) {
217 $comment = get_comment( $comment_ID );
218 $url = get_comment_author_url( $comment );
219 $author = get_comment_author( $comment );
221 if ( empty( $url ) || 'http://' == $url )
224 $return = "<a href='$url' rel='external nofollow' class='url'>$author</a>";
227 * Filters the comment author's link for display.
230 * @since 4.1.0 The `$author` and `$comment_ID` parameters were added.
232 * @param string $return The HTML-formatted comment author link.
233 * Empty for an invalid URL.
234 * @param string $author The comment author's username.
235 * @param int $comment_ID The comment ID.
237 return apply_filters( 'get_comment_author_link', $return, $author, $comment->comment_ID );
241 * Display the html link to the url of the author of the current comment.
244 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
246 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's link.
247 * Default current comment.
249 function comment_author_link( $comment_ID = 0 ) {
250 echo get_comment_author_link( $comment_ID );
254 * Retrieve the IP address of the author of the current comment.
257 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
259 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's IP address.
260 * Default current comment.
261 * @return string Comment author's IP address.
263 function get_comment_author_IP( $comment_ID = 0 ) {
264 $comment = get_comment( $comment_ID );
267 * Filters the comment author's returned IP address.
270 * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
272 * @param string $comment_author_IP The comment author's IP address.
273 * @param int $comment_ID The comment ID.
274 * @param WP_Comment $comment The comment object.
276 return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP, $comment->comment_ID, $comment );
280 * Display the IP address of the author of the current comment.
283 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
285 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's IP address.
286 * Default current comment.
288 function comment_author_IP( $comment_ID = 0 ) {
289 echo esc_html( get_comment_author_IP( $comment_ID ) );
293 * Retrieve the url of the author of the current comment.
296 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
298 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's URL.
299 * Default current comment.
300 * @return string Comment author URL.
302 function get_comment_author_url( $comment_ID = 0 ) {
303 $comment = get_comment( $comment_ID );
306 if ( ! empty( $comment ) ) {
307 $author_url = ( 'http://' == $comment->comment_author_url ) ? '' : $comment->comment_author_url;
308 $url = esc_url( $author_url, array( 'http', 'https' ) );
313 * Filters the comment author's URL.
316 * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
318 * @param string $url The comment author's URL.
319 * @param int $comment_ID The comment ID.
320 * @param WP_Comment $comment The comment object.
322 return apply_filters( 'get_comment_author_url', $url, $id, $comment );
326 * Display the url of the author of the current comment.
329 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
331 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's URL.
332 * Default current comment.
334 function comment_author_url( $comment_ID = 0 ) {
335 $comment = get_comment( $comment_ID );
336 $author_url = get_comment_author_url( $comment );
339 * Filters the comment author's URL for display.
342 * @since 4.1.0 The `$comment_ID` parameter was added.
344 * @param string $author_url The comment author's URL.
345 * @param int $comment_ID The comment ID.
347 echo apply_filters( 'comment_url', $author_url, $comment->comment_ID );
351 * Retrieves the HTML link of the url of the author of the current comment.
353 * $linktext parameter is only used if the URL does not exist for the comment
354 * author. If the URL does exist then the URL will be used and the $linktext
357 * Encapsulate the HTML link between the $before and $after. So it will appear
358 * in the order of $before, link, and finally $after.
361 * @since 4.6.0 Added the `$comment` parameter.
363 * @param string $linktext Optional. The text to display instead of the comment
364 * author's email address. Default empty.
365 * @param string $before Optional. The text or HTML to display before the email link.
367 * @param string $after Optional. The text or HTML to display after the email link.
369 * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object.
370 * Default is the current comment.
371 * @return string The HTML link between the $before and $after parameters.
373 function get_comment_author_url_link( $linktext = '', $before = '', $after = '', $comment = 0 ) {
374 $url = get_comment_author_url( $comment );
375 $display = ($linktext != '') ? $linktext : $url;
376 $display = str_replace( 'http://www.', '', $display );
377 $display = str_replace( 'http://', '', $display );
379 if ( '/' == substr($display, -1) ) {
380 $display = substr($display, 0, -1);
383 $return = "$before<a href='$url' rel='external'>$display</a>$after";
386 * Filters the comment author's returned URL link.
390 * @param string $return The HTML-formatted comment author URL link.
392 return apply_filters( 'get_comment_author_url_link', $return );
396 * Displays the HTML link of the url of the author of the current comment.
399 * @since 4.6.0 Added the `$comment` parameter.
401 * @param string $linktext Optional. Text to display instead of the comment author's
402 * email address. Default empty.
403 * @param string $before Optional. Text or HTML to display before the email link.
405 * @param string $after Optional. Text or HTML to display after the email link.
407 * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object.
408 * Default is the current comment.
410 function comment_author_url_link( $linktext = '', $before = '', $after = '', $comment = 0 ) {
411 echo get_comment_author_url_link( $linktext, $before, $after, $comment );
415 * Generates semantic classes for each comment element.
418 * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object.
420 * @param string|array $class Optional. One or more classes to add to the class list.
422 * @param int|WP_Comment $comment Comment ID or WP_Comment object. Default current comment.
423 * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
424 * @param bool $echo Optional. Whether to cho or return the output.
426 * @return string If `$echo` is false, the class will be returned. Void otherwise.
428 function comment_class( $class = '', $comment = null, $post_id = null, $echo = true ) {
429 // Separates classes with a single space, collates classes for comment DIV
430 $class = 'class="' . join( ' ', get_comment_class( $class, $comment, $post_id ) ) . '"';
438 * Returns the classes for the comment div as an array.
441 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object.
443 * @global int $comment_alt
444 * @global int $comment_depth
445 * @global int $comment_thread_alt
447 * @param string|array $class Optional. One or more classes to add to the class list. Default empty.
448 * @param int|WP_Comment $comment_id Comment ID or WP_Comment object. Default current comment.
449 * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
450 * @return array An array of classes.
452 function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {
453 global $comment_alt, $comment_depth, $comment_thread_alt;
457 $comment = get_comment( $comment_id );
462 // Get the comment type (comment, trackback),
463 $classes[] = ( empty( $comment->comment_type ) ) ? 'comment' : $comment->comment_type;
465 // Add classes for comment authors that are registered users.
466 if ( $comment->user_id > 0 && $user = get_userdata( $comment->user_id ) ) {
467 $classes[] = 'byuser';
468 $classes[] = 'comment-author-' . sanitize_html_class( $user->user_nicename, $comment->user_id );
469 // For comment authors who are the author of the post
470 if ( $post = get_post($post_id) ) {
471 if ( $comment->user_id === $post->post_author ) {
472 $classes[] = 'bypostauthor';
477 if ( empty($comment_alt) )
479 if ( empty($comment_depth) )
481 if ( empty($comment_thread_alt) )
482 $comment_thread_alt = 0;
484 if ( $comment_alt % 2 ) {
493 // Alt for top-level comments
494 if ( 1 == $comment_depth ) {
495 if ( $comment_thread_alt % 2 ) {
496 $classes[] = 'thread-odd';
497 $classes[] = 'thread-alt';
499 $classes[] = 'thread-even';
501 $comment_thread_alt++;
504 $classes[] = "depth-$comment_depth";
506 if ( !empty($class) ) {
507 if ( !is_array( $class ) )
508 $class = preg_split('#\s+#', $class);
509 $classes = array_merge($classes, $class);
512 $classes = array_map('esc_attr', $classes);
515 * Filters the returned CSS classes for the current comment.
519 * @param array $classes An array of comment classes.
520 * @param string $class A comma-separated list of additional classes added to the list.
521 * @param int $comment_id The comment id.
522 * @param WP_Comment $comment The comment object.
523 * @param int|WP_Post $post_id The post ID or WP_Post object.
525 return apply_filters( 'comment_class', $classes, $class, $comment->comment_ID, $comment, $post_id );
529 * Retrieve the comment date of the current comment.
532 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
534 * @param string $d Optional. The format of the date. Default user's setting.
535 * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to get the date.
536 * Default current comment.
537 * @return string The comment's date.
539 function get_comment_date( $d = '', $comment_ID = 0 ) {
540 $comment = get_comment( $comment_ID );
542 $date = mysql2date(get_option('date_format'), $comment->comment_date);
544 $date = mysql2date($d, $comment->comment_date);
546 * Filters the returned comment date.
550 * @param string|int $date Formatted date string or Unix timestamp.
551 * @param string $d The format of the date.
552 * @param WP_Comment $comment The comment object.
554 return apply_filters( 'get_comment_date', $date, $d, $comment );
558 * Display the comment date of the current comment.
561 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
563 * @param string $d Optional. The format of the date. Default user's settings.
564 * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the date.
565 * Default current comment.
567 function comment_date( $d = '', $comment_ID = 0 ) {
568 echo get_comment_date( $d, $comment_ID );
572 * Retrieve the excerpt of the current comment.
574 * Will cut each word and only output the first 20 words with '…' at the end.
575 * If the word count is less than 20, then no truncating is done and no '…'
579 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
581 * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to get the excerpt.
582 * Default current comment.
583 * @return string The maybe truncated comment with 20 words or less.
585 function get_comment_excerpt( $comment_ID = 0 ) {
586 $comment = get_comment( $comment_ID );
587 $comment_text = strip_tags( str_replace( array( "\n", "\r" ), ' ', $comment->comment_content ) );
588 $words = explode( ' ', $comment_text );
591 * Filters the amount of words used in the comment excerpt.
595 * @param int $comment_excerpt_length The amount of words you want to display in the comment excerpt.
597 $comment_excerpt_length = apply_filters( 'comment_excerpt_length', 20 );
599 $use_ellipsis = count( $words ) > $comment_excerpt_length;
600 if ( $use_ellipsis ) {
601 $words = array_slice( $words, 0, $comment_excerpt_length );
604 $excerpt = trim( join( ' ', $words ) );
605 if ( $use_ellipsis ) {
606 $excerpt .= '…';
609 * Filters the retrieved comment excerpt.
612 * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
614 * @param string $excerpt The comment excerpt text.
615 * @param int $comment_ID The comment ID.
616 * @param WP_Comment $comment The comment object.
618 return apply_filters( 'get_comment_excerpt', $excerpt, $comment->comment_ID, $comment );
622 * Display the excerpt of the current comment.
625 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
627 * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the excerpt.
628 * Default current comment.
630 function comment_excerpt( $comment_ID = 0 ) {
631 $comment = get_comment( $comment_ID );
632 $comment_excerpt = get_comment_excerpt( $comment );
635 * Filters the comment excerpt for display.
638 * @since 4.1.0 The `$comment_ID` parameter was added.
640 * @param string $comment_excerpt The comment excerpt text.
641 * @param int $comment_ID The comment ID.
643 echo apply_filters( 'comment_excerpt', $comment_excerpt, $comment->comment_ID );
647 * Retrieve the comment id of the current comment.
651 * @return int The comment ID.
653 function get_comment_ID() {
654 $comment = get_comment();
657 * Filters the returned comment ID.
660 * @since 4.1.0 The `$comment_ID` parameter was added.
662 * @param int $comment_ID The current comment ID.
663 * @param WP_Comment $comment The comment object.
665 return apply_filters( 'get_comment_ID', $comment->comment_ID, $comment );
669 * Display the comment id of the current comment.
673 function comment_ID() {
674 echo get_comment_ID();
678 * Retrieve the link to a given comment.
681 * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object. Added `$cpage` argument.
683 * @see get_page_of_comment()
685 * @global WP_Rewrite $wp_rewrite
686 * @global bool $in_comment_loop
688 * @param WP_Comment|int|null $comment Comment to retrieve. Default current comment.
689 * @param array $args {
690 * An array of optional arguments to override the defaults.
692 * @type string $type Passed to get_page_of_comment().
693 * @type int $page Current page of comments, for calculating comment pagination.
694 * @type int $per_page Per-page value for comment pagination.
695 * @type int $max_depth Passed to get_page_of_comment().
696 * @type int|string $cpage Value to use for the comment's "comment-page" or "cpage" value.
697 * If provided, this value overrides any value calculated from `$page`
700 * @return string The permalink to the given comment.
702 function get_comment_link( $comment = null, $args = array() ) {
703 global $wp_rewrite, $in_comment_loop;
705 $comment = get_comment($comment);
708 if ( ! is_array( $args ) ) {
709 $args = array( 'page' => $args );
719 $args = wp_parse_args( $args, $defaults );
721 $link = get_permalink( $comment->comment_post_ID );
723 // The 'cpage' param takes precedence.
724 if ( ! is_null( $args['cpage'] ) ) {
725 $cpage = $args['cpage'];
727 // No 'cpage' is provided, so we calculate one.
729 if ( '' === $args['per_page'] && get_option( 'page_comments' ) ) {
730 $args['per_page'] = get_option('comments_per_page');
733 if ( empty( $args['per_page'] ) ) {
734 $args['per_page'] = 0;
738 $cpage = $args['page'];
740 if ( '' == $cpage ) {
741 if ( ! empty( $in_comment_loop ) ) {
742 $cpage = get_query_var( 'cpage' );
744 // Requires a database hit, so we only do it when we can't figure out from context.
745 $cpage = get_page_of_comment( $comment->comment_ID, $args );
750 * If the default page displays the oldest comments, the permalinks for comments on the default page
751 * do not need a 'cpage' query var.
753 if ( 'oldest' === get_option( 'default_comments_page' ) && 1 === $cpage ) {
758 if ( $cpage && get_option( 'page_comments' ) ) {
759 if ( $wp_rewrite->using_permalinks() ) {
761 $link = trailingslashit( $link ) . $wp_rewrite->comments_pagination_base . '-' . $cpage;
764 $link = user_trailingslashit( $link, 'comment' );
765 } elseif ( $cpage ) {
766 $link = add_query_arg( 'cpage', $cpage, $link );
771 if ( $wp_rewrite->using_permalinks() ) {
772 $link = user_trailingslashit( $link, 'comment' );
775 $link = $link . '#comment-' . $comment->comment_ID;
778 * Filters the returned single comment permalink.
781 * @since 4.4.0 Added the `$cpage` parameter.
783 * @see get_page_of_comment()
785 * @param string $link The comment permalink with '#comment-$id' appended.
786 * @param WP_Comment $comment The current comment object.
787 * @param array $args An array of arguments to override the defaults.
788 * @param int $cpage The calculated 'cpage' value.
790 return apply_filters( 'get_comment_link', $link, $comment, $args, $cpage );
794 * Retrieves the link to the current post comments.
798 * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
799 * @return string The link to the comments.
801 function get_comments_link( $post_id = 0 ) {
802 $hash = get_comments_number( $post_id ) ? '#comments' : '#respond';
803 $comments_link = get_permalink( $post_id ) . $hash;
806 * Filters the returned post comments permalink.
810 * @param string $comments_link Post comments permalink with '#comments' appended.
811 * @param int|WP_Post $post_id Post ID or WP_Post object.
813 return apply_filters( 'get_comments_link', $comments_link, $post_id );
817 * Display the link to the current post comments.
821 * @param string $deprecated Not Used.
822 * @param string $deprecated_2 Not Used.
824 function comments_link( $deprecated = '', $deprecated_2 = '' ) {
825 if ( !empty( $deprecated ) )
826 _deprecated_argument( __FUNCTION__, '0.72' );
827 if ( !empty( $deprecated_2 ) )
828 _deprecated_argument( __FUNCTION__, '1.3.0' );
829 echo esc_url( get_comments_link() );
833 * Retrieve the amount of comments a post has.
837 * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
838 * @return int The number of comments a post has.
840 function get_comments_number( $post_id = 0 ) {
841 $post = get_post( $post_id );
846 $count = $post->comment_count;
847 $post_id = $post->ID;
851 * Filters the returned comment count for a post.
855 * @param int $count Number of comments a post has.
856 * @param int $post_id Post ID.
858 return apply_filters( 'get_comments_number', $count, $post_id );
862 * Display the language string for the number of comments the current post has.
866 * @param string $zero Optional. Text for no comments. Default false.
867 * @param string $one Optional. Text for one comment. Default false.
868 * @param string $more Optional. Text for more than one comment. Default false.
869 * @param string $deprecated Not used.
871 function comments_number( $zero = false, $one = false, $more = false, $deprecated = '' ) {
872 if ( ! empty( $deprecated ) ) {
873 _deprecated_argument( __FUNCTION__, '1.3.0' );
875 echo get_comments_number_text( $zero, $one, $more );
879 * Display the language string for the number of comments the current post has.
883 * @param string $zero Optional. Text for no comments. Default false.
884 * @param string $one Optional. Text for one comment. Default false.
885 * @param string $more Optional. Text for more than one comment. Default false.
887 function get_comments_number_text( $zero = false, $one = false, $more = false ) {
888 $number = get_comments_number();
891 if ( false === $more ) {
892 /* translators: %s: number of comments */
893 $output = sprintf( _n( '%s Comment', '%s Comments', $number ), number_format_i18n( $number ) );
896 /* translators: If comment number in your language requires declension,
897 * translate this to 'on'. Do not translate into your own language.
899 if ( 'on' === _x( 'off', 'Comment number declension: on or off' ) ) {
900 $text = preg_replace( '#<span class="screen-reader-text">.+?</span>#', '', $more );
901 $text = preg_replace( '/&.+?;/', '', $text ); // Kill entities
902 $text = trim( strip_tags( $text ), '% ' );
904 // Replace '% Comments' with a proper plural form
905 if ( $text && ! preg_match( '/[0-9]+/', $text ) && false !== strpos( $more, '%' ) ) {
906 /* translators: %s: number of comments */
907 $new_text = _n( '%s Comment', '%s Comments', $number );
908 $new_text = trim( sprintf( $new_text, '' ) );
910 $more = str_replace( $text, $new_text, $more );
911 if ( false === strpos( $more, '%' ) ) {
912 $more = '% ' . $more;
917 $output = str_replace( '%', number_format_i18n( $number ), $more );
919 } elseif ( $number == 0 ) {
920 $output = ( false === $zero ) ? __( 'No Comments' ) : $zero;
921 } else { // must be one
922 $output = ( false === $one ) ? __( '1 Comment' ) : $one;
925 * Filters the comments count for display.
931 * @param string $output A translatable string formatted based on whether the count
932 * is equal to 0, 1, or 1+.
933 * @param int $number The number of post comments.
935 return apply_filters( 'comments_number', $output, $number );
939 * Retrieve the text of the current comment.
942 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
944 * @see Walker_Comment::comment()
946 * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to get the text.
947 * Default current comment.
948 * @param array $args Optional. An array of arguments. Default empty.
949 * @return string The comment content.
951 function get_comment_text( $comment_ID = 0, $args = array() ) {
952 $comment = get_comment( $comment_ID );
955 * Filters the text of a comment.
959 * @see Walker_Comment::comment()
961 * @param string $comment_content Text of the comment.
962 * @param WP_Comment $comment The comment object.
963 * @param array $args An array of arguments.
965 return apply_filters( 'get_comment_text', $comment->comment_content, $comment, $args );
969 * Display the text of the current comment.
972 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
974 * @see Walker_Comment::comment()
976 * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the text.
977 * Default current comment.
978 * @param array $args Optional. An array of arguments. Default empty array. Default empty.
980 function comment_text( $comment_ID = 0, $args = array() ) {
981 $comment = get_comment( $comment_ID );
983 $comment_text = get_comment_text( $comment, $args );
985 * Filters the text of a comment to be displayed.
989 * @see Walker_Comment::comment()
991 * @param string $comment_text Text of the current comment.
992 * @param WP_Comment $comment The comment object.
993 * @param array $args An array of arguments.
995 echo apply_filters( 'comment_text', $comment_text, $comment, $args );
999 * Retrieve the comment time of the current comment.
1003 * @param string $d Optional. The format of the time. Default user's settings.
1004 * @param bool $gmt Optional. Whether to use the GMT date. Default false.
1005 * @param bool $translate Optional. Whether to translate the time (for use in feeds).
1007 * @return string The formatted time.
1009 function get_comment_time( $d = '', $gmt = false, $translate = true ) {
1010 $comment = get_comment();
1012 $comment_date = $gmt ? $comment->comment_date_gmt : $comment->comment_date;
1014 $date = mysql2date(get_option('time_format'), $comment_date, $translate);
1016 $date = mysql2date($d, $comment_date, $translate);
1019 * Filters the returned comment time.
1023 * @param string|int $date The comment time, formatted as a date string or Unix timestamp.
1024 * @param string $d Date format.
1025 * @param bool $gmt Whether the GMT date is in use.
1026 * @param bool $translate Whether the time is translated.
1027 * @param WP_Comment $comment The comment object.
1029 return apply_filters( 'get_comment_time', $date, $d, $gmt, $translate, $comment );
1033 * Display the comment time of the current comment.
1037 * @param string $d Optional. The format of the time. Default user's settings.
1039 function comment_time( $d = '' ) {
1040 echo get_comment_time($d);
1044 * Retrieve the comment type of the current comment.
1047 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
1049 * @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to get the type.
1050 * Default current comment.
1051 * @return string The comment type.
1053 function get_comment_type( $comment_ID = 0 ) {
1054 $comment = get_comment( $comment_ID );
1055 if ( '' == $comment->comment_type )
1056 $comment->comment_type = 'comment';
1059 * Filters the returned comment type.
1062 * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
1064 * @param string $comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
1065 * @param int $comment_ID The comment ID.
1066 * @param WP_Comment $comment The comment object.
1068 return apply_filters( 'get_comment_type', $comment->comment_type, $comment->comment_ID, $comment );
1072 * Display the comment type of the current comment.
1076 * @param string $commenttxt Optional. String to display for comment type. Default false.
1077 * @param string $trackbacktxt Optional. String to display for trackback type. Default false.
1078 * @param string $pingbacktxt Optional. String to display for pingback type. Default false.
1080 function comment_type( $commenttxt = false, $trackbacktxt = false, $pingbacktxt = false ) {
1081 if ( false === $commenttxt ) $commenttxt = _x( 'Comment', 'noun' );
1082 if ( false === $trackbacktxt ) $trackbacktxt = __( 'Trackback' );
1083 if ( false === $pingbacktxt ) $pingbacktxt = __( 'Pingback' );
1084 $type = get_comment_type();
1098 * Retrieve The current post's trackback URL.
1100 * There is a check to see if permalink's have been enabled and if so, will
1101 * retrieve the pretty path. If permalinks weren't enabled, the ID of the
1102 * current post is used and appended to the correct page to go to.
1106 * @return string The trackback URL after being filtered.
1108 function get_trackback_url() {
1109 if ( '' != get_option('permalink_structure') )
1110 $tb_url = trailingslashit(get_permalink()) . user_trailingslashit('trackback', 'single_trackback');
1112 $tb_url = get_option('siteurl') . '/wp-trackback.php?p=' . get_the_ID();
1115 * Filters the returned trackback URL.
1119 * @param string $tb_url The trackback URL.
1121 return apply_filters( 'trackback_url', $tb_url );
1125 * Display the current post's trackback URL.
1129 * @param bool $deprecated_echo Not used.
1130 * @return void|string Should only be used to echo the trackback URL, use get_trackback_url()
1131 * for the result instead.
1133 function trackback_url( $deprecated_echo = true ) {
1134 if ( true !== $deprecated_echo ) {
1135 _deprecated_argument( __FUNCTION__, '2.5.0',
1136 /* translators: %s: get_trackback_url() */
1137 sprintf( __( 'Use %s instead if you do not want the value echoed.' ),
1138 '<code>get_trackback_url()</code>'
1143 if ( $deprecated_echo ) {
1144 echo get_trackback_url();
1146 return get_trackback_url();
1151 * Generate and display the RDF for the trackback information of current post.
1153 * Deprecated in 3.0.0, and restored in 3.0.1.
1157 * @param int $deprecated Not used (Was $timezone = 0).
1159 function trackback_rdf( $deprecated = '' ) {
1160 if ( ! empty( $deprecated ) ) {
1161 _deprecated_argument( __FUNCTION__, '2.5.0' );
1164 if ( isset( $_SERVER['HTTP_USER_AGENT'] ) && false !== stripos( $_SERVER['HTTP_USER_AGENT'], 'W3C_Validator' ) ) {
1168 echo '<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
1169 xmlns:dc="http://purl.org/dc/elements/1.1/"
1170 xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/">
1171 <rdf:Description rdf:about="';
1174 echo ' dc:identifier="';
1177 echo ' dc:title="'.str_replace('--', '--', wptexturize(strip_tags(get_the_title()))).'"'."\n";
1178 echo ' trackback:ping="'.get_trackback_url().'"'." />\n";
1183 * Whether the current post is open for comments.
1187 * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
1188 * @return bool True if the comments are open.
1190 function comments_open( $post_id = null ) {
1192 $_post = get_post($post_id);
1194 $open = ( 'open' == $_post->comment_status );
1197 * Filters whether the current post is open for comments.
1201 * @param bool $open Whether the current post is open for comments.
1202 * @param int|WP_Post $post_id The post ID or WP_Post object.
1204 return apply_filters( 'comments_open', $open, $post_id );
1208 * Whether the current post is open for pings.
1212 * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
1213 * @return bool True if pings are accepted
1215 function pings_open( $post_id = null ) {
1217 $_post = get_post($post_id);
1219 $open = ( 'open' == $_post->ping_status );
1222 * Filters whether the current post is open for pings.
1226 * @param bool $open Whether the current post is open for pings.
1227 * @param int|WP_Post $post_id The post ID or WP_Post object.
1229 return apply_filters( 'pings_open', $open, $post_id );
1233 * Display form token for unfiltered comments.
1235 * Will only display nonce token if the current user has permissions for
1236 * unfiltered html. Won't display the token for other users.
1238 * The function was backported to 2.0.10 and was added to versions 2.1.3 and
1239 * above. Does not exist in versions prior to 2.0.10 in the 2.0 branch and in
1240 * the 2.1 branch, prior to 2.1.3. Technically added in 2.2.0.
1242 * Backported to 2.0.10.
1246 function wp_comment_form_unfiltered_html_nonce() {
1248 $post_id = $post ? $post->ID : 0;
1250 if ( current_user_can( 'unfiltered_html' ) ) {
1251 wp_nonce_field( 'unfiltered-html-comment_' . $post_id, '_wp_unfiltered_html_comment_disabled', false );
1252 echo "<script>(function(){if(window===window.parent){document.getElementById('_wp_unfiltered_html_comment_disabled').name='_wp_unfiltered_html_comment';}})();</script>\n";
1257 * Load the comment template specified in $file.
1259 * Will not display the comments template if not on single post or page, or if
1260 * the post does not have comments.
1262 * Uses the WordPress database object to query for the comments. The comments
1263 * are passed through the {@see 'comments_array'} filter hook with the list of comments
1264 * and the post ID respectively.
1266 * The `$file` path is passed through a filter hook called {@see 'comments_template'},
1267 * which includes the TEMPLATEPATH and $file combined. Tries the $filtered path
1268 * first and if it fails it will require the default comment template from the
1269 * default theme. If either does not exist, then the WordPress process will be
1270 * halted. It is advised for that reason, that the default theme is not deleted.
1272 * Will not try to get the comments if the post has none.
1276 * @global WP_Query $wp_query
1277 * @global WP_Post $post
1278 * @global wpdb $wpdb
1280 * @global WP_Comment $comment
1281 * @global string $user_login
1282 * @global int $user_ID
1283 * @global string $user_identity
1284 * @global bool $overridden_cpage
1285 * @global bool $withcomments
1287 * @param string $file Optional. The file to load. Default '/comments.php'.
1288 * @param bool $separate_comments Optional. Whether to separate the comments by comment type.
1291 function comments_template( $file = '/comments.php', $separate_comments = false ) {
1292 global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_ID, $user_identity, $overridden_cpage;
1294 if ( !(is_single() || is_page() || $withcomments) || empty($post) )
1298 $file = '/comments.php';
1300 $req = get_option('require_name_email');
1303 * Comment author information fetched from the comment cookies.
1305 $commenter = wp_get_current_commenter();
1308 * The name of the current comment author escaped for use in attributes.
1309 * Escaped by sanitize_comment_cookies().
1311 $comment_author = $commenter['comment_author'];
1314 * The email address of the current comment author escaped for use in attributes.
1315 * Escaped by sanitize_comment_cookies().
1317 $comment_author_email = $commenter['comment_author_email'];
1320 * The url of the current comment author escaped for use in attributes.
1322 $comment_author_url = esc_url($commenter['comment_author_url']);
1324 $comment_args = array(
1325 'orderby' => 'comment_date_gmt',
1327 'status' => 'approve',
1328 'post_id' => $post->ID,
1329 'no_found_rows' => false,
1330 'update_comment_meta_cache' => false, // We lazy-load comment meta for performance.
1333 if ( get_option('thread_comments') ) {
1334 $comment_args['hierarchical'] = 'threaded';
1336 $comment_args['hierarchical'] = false;
1340 $comment_args['include_unapproved'] = array( $user_ID );
1341 } elseif ( ! empty( $comment_author_email ) ) {
1342 $comment_args['include_unapproved'] = array( $comment_author_email );
1346 if ( get_option( 'page_comments' ) ) {
1347 $per_page = (int) get_query_var( 'comments_per_page' );
1348 if ( 0 === $per_page ) {
1349 $per_page = (int) get_option( 'comments_per_page' );
1352 $comment_args['number'] = $per_page;
1353 $page = (int) get_query_var( 'cpage' );
1356 $comment_args['offset'] = ( $page - 1 ) * $per_page;
1357 } elseif ( 'oldest' === get_option( 'default_comments_page' ) ) {
1358 $comment_args['offset'] = 0;
1360 // If fetching the first page of 'newest', we need a top-level comment count.
1361 $top_level_query = new WP_Comment_Query();
1362 $top_level_args = array(
1365 'post_id' => $post->ID,
1366 'status' => 'approve',
1369 if ( $comment_args['hierarchical'] ) {
1370 $top_level_args['parent'] = 0;
1373 if ( isset( $comment_args['include_unapproved'] ) ) {
1374 $top_level_args['include_unapproved'] = $comment_args['include_unapproved'];
1377 $top_level_count = $top_level_query->query( $top_level_args );
1379 $comment_args['offset'] = ( ceil( $top_level_count / $per_page ) - 1 ) * $per_page;
1384 * Filters the arguments used to query comments in comments_template().
1388 * @see WP_Comment_Query::__construct()
1390 * @param array $comment_args {
1391 * Array of WP_Comment_Query arguments.
1393 * @type string|array $orderby Field(s) to order by.
1394 * @type string $order Order of results. Accepts 'ASC' or 'DESC'.
1395 * @type string $status Comment status.
1396 * @type array $include_unapproved Array of IDs or email addresses whose unapproved comments
1397 * will be included in results.
1398 * @type int $post_id ID of the post.
1399 * @type bool $no_found_rows Whether to refrain from querying for found rows.
1400 * @type bool $update_comment_meta_cache Whether to prime cache for comment meta.
1401 * @type bool|string $hierarchical Whether to query for comments hierarchically.
1402 * @type int $offset Comment offset.
1403 * @type int $number Number of comments to fetch.
1406 $comment_args = apply_filters( 'comments_template_query_args', $comment_args );
1407 $comment_query = new WP_Comment_Query( $comment_args );
1408 $_comments = $comment_query->comments;
1410 // Trees must be flattened before they're passed to the walker.
1411 if ( $comment_args['hierarchical'] ) {
1412 $comments_flat = array();
1413 foreach ( $_comments as $_comment ) {
1414 $comments_flat[] = $_comment;
1415 $comment_children = $_comment->get_children( array(
1417 'status' => $comment_args['status'],
1418 'orderby' => $comment_args['orderby']
1421 foreach ( $comment_children as $comment_child ) {
1422 $comments_flat[] = $comment_child;
1426 $comments_flat = $_comments;
1430 * Filters the comments array.
1434 * @param array $comments Array of comments supplied to the comments template.
1435 * @param int $post_ID Post ID.
1437 $wp_query->comments = apply_filters( 'comments_array', $comments_flat, $post->ID );
1439 $comments = &$wp_query->comments;
1440 $wp_query->comment_count = count($wp_query->comments);
1441 $wp_query->max_num_comment_pages = $comment_query->max_num_pages;
1443 if ( $separate_comments ) {
1444 $wp_query->comments_by_type = separate_comments($comments);
1445 $comments_by_type = &$wp_query->comments_by_type;
1447 $wp_query->comments_by_type = array();
1450 $overridden_cpage = false;
1451 if ( '' == get_query_var( 'cpage' ) && $wp_query->max_num_comment_pages > 1 ) {
1452 set_query_var( 'cpage', 'newest' == get_option('default_comments_page') ? get_comment_pages_count() : 1 );
1453 $overridden_cpage = true;
1456 if ( !defined('COMMENTS_TEMPLATE') )
1457 define('COMMENTS_TEMPLATE', true);
1459 $theme_template = STYLESHEETPATH . $file;
1461 * Filters the path to the theme template file used for the comments template.
1465 * @param string $theme_template The path to the theme template file.
1467 $include = apply_filters( 'comments_template', $theme_template );
1468 if ( file_exists( $include ) )
1469 require( $include );
1470 elseif ( file_exists( TEMPLATEPATH . $file ) )
1471 require( TEMPLATEPATH . $file );
1472 else // Backward compat code will be removed in a future release
1473 require( ABSPATH . WPINC . '/theme-compat/comments.php');
1477 * Displays the link to the comments for the current post ID.
1481 * @param string $zero Optional. String to display when no comments. Default false.
1482 * @param string $one Optional. String to display when only one comment is available.
1484 * @param string $more Optional. String to display when there are more than one comment.
1486 * @param string $css_class Optional. CSS class to use for comments. Default empty.
1487 * @param string $none Optional. String to display when comments have been turned off.
1490 function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) {
1492 $title = get_the_title();
1493 $number = get_comments_number( $id );
1495 if ( false === $zero ) {
1496 /* translators: %s: post title */
1497 $zero = sprintf( __( 'No Comments<span class="screen-reader-text"> on %s</span>' ), $title );
1500 if ( false === $one ) {
1501 /* translators: %s: post title */
1502 $one = sprintf( __( '1 Comment<span class="screen-reader-text"> on %s</span>' ), $title );
1505 if ( false === $more ) {
1506 /* translators: 1: Number of comments 2: post title */
1507 $more = _n( '%1$s Comment<span class="screen-reader-text"> on %2$s</span>', '%1$s Comments<span class="screen-reader-text"> on %2$s</span>', $number );
1508 $more = sprintf( $more, number_format_i18n( $number ), $title );
1511 if ( false === $none ) {
1512 /* translators: %s: post title */
1513 $none = sprintf( __( 'Comments Off<span class="screen-reader-text"> on %s</span>' ), $title );
1516 if ( 0 == $number && !comments_open() && !pings_open() ) {
1517 echo '<span' . ((!empty($css_class)) ? ' class="' . esc_attr( $css_class ) . '"' : '') . '>' . $none . '</span>';
1521 if ( post_password_required() ) {
1522 _e( 'Enter your password to view comments.' );
1527 if ( 0 == $number ) {
1528 $respond_link = get_permalink() . '#respond';
1530 * Filters the respond link when a post has no comments.
1534 * @param string $respond_link The default response link.
1535 * @param integer $id The post ID.
1537 echo apply_filters( 'respond_link', $respond_link, $id );
1543 if ( !empty( $css_class ) ) {
1544 echo ' class="'.$css_class.'" ';
1549 * Filters the comments link attributes for display.
1553 * @param string $attributes The comments link attributes. Default empty.
1555 echo apply_filters( 'comments_popup_link_attributes', $attributes );
1558 comments_number( $zero, $one, $more );
1563 * Retrieve HTML content for reply to comment link.
1566 * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object.
1568 * @param array $args {
1569 * Optional. Override default arguments.
1571 * @type string $add_below The first part of the selector used to identify the comment to respond below.
1572 * The resulting value is passed as the first parameter to addComment.moveForm(),
1573 * concatenated as $add_below-$comment->comment_ID. Default 'comment'.
1574 * @type string $respond_id The selector identifying the responding comment. Passed as the third parameter
1575 * to addComment.moveForm(), and appended to the link URL as a hash value.
1576 * Default 'respond'.
1577 * @type string $reply_text The text of the Reply link. Default 'Reply'.
1578 * @type string $login_text The text of the link to reply if logged out. Default 'Log in to Reply'.
1579 * @type int $depth' The depth of the new comment. Must be greater than 0 and less than the value
1580 * of the 'thread_comments_depth' option set in Settings > Discussion. Default 0.
1581 * @type string $before The text or HTML to add before the reply link. Default empty.
1582 * @type string $after The text or HTML to add after the reply link. Default empty.
1584 * @param int|WP_Comment $comment Comment being replied to. Default current comment.
1585 * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
1586 * Default current post.
1587 * @return void|false|string Link to show comment form, if successful. False, if comments are closed.
1589 function get_comment_reply_link( $args = array(), $comment = null, $post = null ) {
1591 'add_below' => 'comment',
1592 'respond_id' => 'respond',
1593 'reply_text' => __( 'Reply' ),
1594 'reply_to_text' => __( 'Reply to %s' ),
1595 'login_text' => __( 'Log in to Reply' ),
1601 $args = wp_parse_args( $args, $defaults );
1603 if ( 0 == $args['depth'] || $args['max_depth'] <= $args['depth'] ) {
1607 $comment = get_comment( $comment );
1609 if ( empty( $post ) ) {
1610 $post = $comment->comment_post_ID;
1613 $post = get_post( $post );
1615 if ( ! comments_open( $post->ID ) ) {
1620 * Filters the comment reply link arguments.
1624 * @param array $args Comment reply link arguments. See get_comment_reply_link()
1625 * for more information on accepted arguments.
1626 * @param WP_Comment $comment The object of the comment being replied to.
1627 * @param WP_Post $post The WP_Post object.
1629 $args = apply_filters( 'comment_reply_link_args', $args, $comment, $post );
1631 if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) {
1632 $link = sprintf( '<a rel="nofollow" class="comment-reply-login" href="%s">%s</a>',
1633 esc_url( wp_login_url( get_permalink() ) ),
1637 $onclick = sprintf( 'return addComment.moveForm( "%1$s-%2$s", "%2$s", "%3$s", "%4$s" )',
1638 $args['add_below'], $comment->comment_ID, $args['respond_id'], $post->ID
1641 $link = sprintf( "<a rel='nofollow' class='comment-reply-link' href='%s' onclick='%s' aria-label='%s'>%s</a>",
1642 esc_url( add_query_arg( 'replytocom', $comment->comment_ID, get_permalink( $post->ID ) ) ) . "#" . $args['respond_id'],
1644 esc_attr( sprintf( $args['reply_to_text'], $comment->comment_author ) ),
1650 * Filters the comment reply link.
1654 * @param string $link The HTML markup for the comment reply link.
1655 * @param array $args An array of arguments overriding the defaults.
1656 * @param object $comment The object of the comment being replied.
1657 * @param WP_Post $post The WP_Post object.
1659 return apply_filters( 'comment_reply_link', $args['before'] . $link . $args['after'], $args, $comment, $post );
1663 * Displays the HTML content for reply to comment link.
1667 * @see get_comment_reply_link()
1669 * @param array $args Optional. Override default options.
1670 * @param int $comment Comment being replied to. Default current comment.
1671 * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
1672 * Default current post.
1673 * @return mixed Link to show comment form, if successful. False, if comments are closed.
1675 function comment_reply_link($args = array(), $comment = null, $post = null) {
1676 echo get_comment_reply_link($args, $comment, $post);
1680 * Retrieve HTML content for reply to post link.
1684 * @param array $args {
1685 * Optional. Override default arguments.
1687 * @type string $add_below The first part of the selector used to identify the comment to respond below.
1688 * The resulting value is passed as the first parameter to addComment.moveForm(),
1689 * concatenated as $add_below-$comment->comment_ID. Default is 'post'.
1690 * @type string $respond_id The selector identifying the responding comment. Passed as the third parameter
1691 * to addComment.moveForm(), and appended to the link URL as a hash value.
1692 * Default 'respond'.
1693 * @type string $reply_text Text of the Reply link. Default is 'Leave a Comment'.
1694 * @type string $login_text Text of the link to reply if logged out. Default is 'Log in to leave a Comment'.
1695 * @type string $before Text or HTML to add before the reply link. Default empty.
1696 * @type string $after Text or HTML to add after the reply link. Default empty.
1698 * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on.
1699 * Default current post.
1700 * @return false|null|string Link to show comment form, if successful. False, if comments are closed.
1702 function get_post_reply_link($args = array(), $post = null) {
1704 'add_below' => 'post',
1705 'respond_id' => 'respond',
1706 'reply_text' => __('Leave a Comment'),
1707 'login_text' => __('Log in to leave a Comment'),
1712 $args = wp_parse_args($args, $defaults);
1714 $post = get_post($post);
1716 if ( ! comments_open( $post->ID ) ) {
1720 if ( get_option('comment_registration') && ! is_user_logged_in() ) {
1721 $link = sprintf( '<a rel="nofollow" class="comment-reply-login" href="%s">%s</a>',
1722 wp_login_url( get_permalink() ),
1726 $onclick = sprintf( 'return addComment.moveForm( "%1$s-%2$s", "0", "%3$s", "%2$s" )',
1727 $args['add_below'], $post->ID, $args['respond_id']
1730 $link = sprintf( "<a rel='nofollow' class='comment-reply-link' href='%s' onclick='%s'>%s</a>",
1731 get_permalink( $post->ID ) . '#' . $args['respond_id'],
1736 $formatted_link = $args['before'] . $link . $args['after'];
1739 * Filters the formatted post comments link HTML.
1743 * @param string $formatted The HTML-formatted post comments link.
1744 * @param int|WP_Post $post The post ID or WP_Post object.
1746 return apply_filters( 'post_comments_link', $formatted_link, $post );
1750 * Displays the HTML content for reply to post link.
1754 * @see get_post_reply_link()
1756 * @param array $args Optional. Override default options,
1757 * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
1758 * Default current post.
1759 * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1761 function post_reply_link($args = array(), $post = null) {
1762 echo get_post_reply_link($args, $post);
1766 * Retrieve HTML content for cancel comment reply link.
1770 * @param string $text Optional. Text to display for cancel reply link. Default empty.
1773 function get_cancel_comment_reply_link( $text = '' ) {
1775 $text = __('Click here to cancel reply.');
1777 $style = isset($_GET['replytocom']) ? '' : ' style="display:none;"';
1778 $link = esc_html( remove_query_arg('replytocom') ) . '#respond';
1780 $formatted_link = '<a rel="nofollow" id="cancel-comment-reply-link" href="' . $link . '"' . $style . '>' . $text . '</a>';
1783 * Filters the cancel comment reply link HTML.
1787 * @param string $formatted_link The HTML-formatted cancel comment reply link.
1788 * @param string $link Cancel comment reply link URL.
1789 * @param string $text Cancel comment reply link text.
1791 return apply_filters( 'cancel_comment_reply_link', $formatted_link, $link, $text );
1795 * Display HTML content for cancel comment reply link.
1799 * @param string $text Optional. Text to display for cancel reply link. Default empty.
1801 function cancel_comment_reply_link( $text = '' ) {
1802 echo get_cancel_comment_reply_link($text);
1806 * Retrieve hidden input HTML for replying to comments.
1810 * @param int $id Optional. Post ID. Default current post ID.
1811 * @return string Hidden input HTML for replying to comments
1813 function get_comment_id_fields( $id = 0 ) {
1817 $replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
1818 $result = "<input type='hidden' name='comment_post_ID' value='$id' id='comment_post_ID' />\n";
1819 $result .= "<input type='hidden' name='comment_parent' id='comment_parent' value='$replytoid' />\n";
1822 * Filters the returned comment id fields.
1826 * @param string $result The HTML-formatted hidden id field comment elements.
1827 * @param int $id The post ID.
1828 * @param int $replytoid The id of the comment being replied to.
1830 return apply_filters( 'comment_id_fields', $result, $id, $replytoid );
1834 * Output hidden input HTML for replying to comments.
1838 * @param int $id Optional. Post ID. Default current post ID.
1840 function comment_id_fields( $id = 0 ) {
1841 echo get_comment_id_fields( $id );
1845 * Display text based on comment reply status.
1847 * Only affects users with JavaScript disabled.
1849 * @internal The $comment global must be present to allow template tags access to the current
1850 * comment. See https://core.trac.wordpress.org/changeset/36512.
1854 * @global WP_Comment $comment Current comment.
1856 * @param string $noreplytext Optional. Text to display when not replying to a comment.
1858 * @param string $replytext Optional. Text to display when replying to a comment.
1859 * Default false. Accepts "%s" for the author of the comment
1861 * @param string $linktoparent Optional. Boolean to control making the author's name a link
1862 * to their comment. Default true.
1864 function comment_form_title( $noreplytext = false, $replytext = false, $linktoparent = true ) {
1867 if ( false === $noreplytext ) $noreplytext = __( 'Leave a Reply' );
1868 if ( false === $replytext ) $replytext = __( 'Leave a Reply to %s' );
1870 $replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
1872 if ( 0 == $replytoid )
1875 // Sets the global so that template tags can be used in the comment form.
1876 $comment = get_comment($replytoid);
1877 $author = ( $linktoparent ) ? '<a href="#comment-' . get_comment_ID() . '">' . get_comment_author( $comment ) . '</a>' : get_comment_author( $comment );
1878 printf( $replytext, $author );
1885 * Used in the comments.php template to list comments for a particular post.
1889 * @see WP_Query->comments
1891 * @global WP_Query $wp_query
1892 * @global int $comment_alt
1893 * @global int $comment_depth
1894 * @global int $comment_thread_alt
1895 * @global bool $overridden_cpage
1896 * @global bool $in_comment_loop
1898 * @param string|array $args {
1899 * Optional. Formatting options.
1901 * @type object $walker Instance of a Walker class to list comments. Default null.
1902 * @type int $max_depth The maximum comments depth. Default empty.
1903 * @type string $style The style of list ordering. Default 'ul'. Accepts 'ul', 'ol'.
1904 * @type string $callback Callback function to use. Default null.
1905 * @type string $end-callback Callback function to use at the end. Default null.
1906 * @type string $type Type of comments to list.
1907 * Default 'all'. Accepts 'all', 'comment', 'pingback', 'trackback', 'pings'.
1908 * @type int $page Page ID to list comments for. Default empty.
1909 * @type int $per_page Number of comments to list per page. Default empty.
1910 * @type int $avatar_size Height and width dimensions of the avatar size. Default 32.
1911 * @type string $reverse_top_level Ordering of the listed comments. Default null. Accepts 'desc', 'asc'.
1912 * @type bool $reverse_children Whether to reverse child comments in the list. Default null.
1913 * @type string $format How to format the comments list.
1914 * Default 'html5' if the theme supports it. Accepts 'html5', 'xhtml'.
1915 * @type bool $short_ping Whether to output short pings. Default false.
1916 * @type bool $echo Whether to echo the output or return it. Default true.
1918 * @param array $comments Optional. Array of WP_Comment objects.
1920 function wp_list_comments( $args = array(), $comments = null ) {
1921 global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop;
1923 $in_comment_loop = true;
1925 $comment_alt = $comment_thread_alt = 0;
1933 'end-callback' => null,
1937 'avatar_size' => 32,
1938 'reverse_top_level' => null,
1939 'reverse_children' => '',
1940 'format' => current_theme_supports( 'html5', 'comment-list' ) ? 'html5' : 'xhtml',
1941 'short_ping' => false,
1945 $r = wp_parse_args( $args, $defaults );
1948 * Filters the arguments used in retrieving the comment list.
1952 * @see wp_list_comments()
1954 * @param array $r An array of arguments for displaying comments.
1956 $r = apply_filters( 'wp_list_comments_args', $r );
1958 // Figure out what comments we'll be looping through ($_comments)
1959 if ( null !== $comments ) {
1960 $comments = (array) $comments;
1961 if ( empty($comments) )
1963 if ( 'all' != $r['type'] ) {
1964 $comments_by_type = separate_comments($comments);
1965 if ( empty($comments_by_type[$r['type']]) )
1967 $_comments = $comments_by_type[$r['type']];
1969 $_comments = $comments;
1973 * If 'page' or 'per_page' has been passed, and does not match what's in $wp_query,
1974 * perform a separate comment query and allow Walker_Comment to paginate.
1976 if ( $r['page'] || $r['per_page'] ) {
1977 $current_cpage = get_query_var( 'cpage' );
1978 if ( ! $current_cpage ) {
1979 $current_cpage = 'newest' === get_option( 'default_comments_page' ) ? 1 : $wp_query->max_num_comment_pages;
1982 $current_per_page = get_query_var( 'comments_per_page' );
1983 if ( $r['page'] != $current_cpage || $r['per_page'] != $current_per_page ) {
1984 $comment_args = array(
1985 'post_id' => get_the_ID(),
1986 'orderby' => 'comment_date_gmt',
1988 'status' => 'approve',
1991 if ( is_user_logged_in() ) {
1992 $comment_args['include_unapproved'] = get_current_user_id();
1994 $commenter = wp_get_current_commenter();
1995 if ( $commenter['comment_author_email'] ) {
1996 $comment_args['include_unapproved'] = $commenter['comment_author_email'];
2000 $comments = get_comments( $comment_args );
2002 if ( 'all' != $r['type'] ) {
2003 $comments_by_type = separate_comments( $comments );
2004 if ( empty( $comments_by_type[ $r['type'] ] ) ) {
2008 $_comments = $comments_by_type[ $r['type'] ];
2010 $_comments = $comments;
2014 // Otherwise, fall back on the comments from `$wp_query->comments`.
2016 if ( empty($wp_query->comments) )
2018 if ( 'all' != $r['type'] ) {
2019 if ( empty($wp_query->comments_by_type) )
2020 $wp_query->comments_by_type = separate_comments($wp_query->comments);
2021 if ( empty($wp_query->comments_by_type[$r['type']]) )
2023 $_comments = $wp_query->comments_by_type[$r['type']];
2025 $_comments = $wp_query->comments;
2028 if ( $wp_query->max_num_comment_pages ) {
2029 $default_comments_page = get_option( 'default_comments_page' );
2030 $cpage = get_query_var( 'cpage' );
2031 if ( 'newest' === $default_comments_page ) {
2032 $r['cpage'] = $cpage;
2035 * When first page shows oldest comments, post permalink is the same as
2036 * the comment permalink.
2038 } elseif ( $cpage == 1 ) {
2041 $r['cpage'] = $cpage;
2050 if ( '' === $r['per_page'] && get_option( 'page_comments' ) ) {
2051 $r['per_page'] = get_query_var('comments_per_page');
2054 if ( empty($r['per_page']) ) {
2059 if ( '' === $r['max_depth'] ) {
2060 if ( get_option('thread_comments') )
2061 $r['max_depth'] = get_option('thread_comments_depth');
2063 $r['max_depth'] = -1;
2066 if ( '' === $r['page'] ) {
2067 if ( empty($overridden_cpage) ) {
2068 $r['page'] = get_query_var('cpage');
2070 $threaded = ( -1 != $r['max_depth'] );
2071 $r['page'] = ( 'newest' == get_option('default_comments_page') ) ? get_comment_pages_count($_comments, $r['per_page'], $threaded) : 1;
2072 set_query_var( 'cpage', $r['page'] );
2076 $r['page'] = intval($r['page']);
2077 if ( 0 == $r['page'] && 0 != $r['per_page'] )
2080 if ( null === $r['reverse_top_level'] )
2081 $r['reverse_top_level'] = ( 'desc' == get_option('comment_order') );
2083 wp_queue_comments_for_comment_meta_lazyload( $_comments );
2085 if ( empty( $r['walker'] ) ) {
2086 $walker = new Walker_Comment;
2088 $walker = $r['walker'];
2091 $output = $walker->paged_walk( $_comments, $r['max_depth'], $r['page'], $r['per_page'], $r );
2093 $in_comment_loop = false;
2103 * Outputs a complete commenting form for use within a template.
2105 * Most strings and form fields may be controlled through the $args array passed
2106 * into the function, while you may also choose to use the {@see 'comment_form_default_fields'}
2107 * filter to modify the array of default fields if you'd just like to add a new
2108 * one or remove a single field. All fields are also individually passed through
2109 * a filter of the {@see 'comment_form_field_$name'} where $name is the key used
2110 * in the array of fields.
2113 * @since 4.1.0 Introduced the 'class_submit' argument.
2114 * @since 4.2.0 Introduced the 'submit_button' and 'submit_fields' arguments.
2115 * @since 4.4.0 Introduced the 'class_form', 'title_reply_before', 'title_reply_after',
2116 * 'cancel_reply_before', and 'cancel_reply_after' arguments.
2117 * @since 4.5.0 The 'author', 'email', and 'url' form fields are limited to 245, 100,
2118 * and 200 characters, respectively.
2119 * @since 4.6.0 Introduced the 'action' argument.
2121 * @param array $args {
2122 * Optional. Default arguments and form fields to override.
2124 * @type array $fields {
2125 * Default comment fields, filterable by default via the {@see 'comment_form_default_fields'} hook.
2127 * @type string $author Comment author field HTML.
2128 * @type string $email Comment author email field HTML.
2129 * @type string $url Comment author URL field HTML.
2131 * @type string $comment_field The comment textarea field HTML.
2132 * @type string $must_log_in HTML element for a 'must be logged in to comment' message.
2133 * @type string $logged_in_as HTML element for a 'logged in as [user]' message.
2134 * @type string $comment_notes_before HTML element for a message displayed before the comment fields
2135 * if the user is not logged in.
2136 * Default 'Your email address will not be published.'.
2137 * @type string $comment_notes_after HTML element for a message displayed after the textarea field.
2138 * @type string $action The comment form element action attribute. Default '/wp-comments-post.php'.
2139 * @type string $id_form The comment form element id attribute. Default 'commentform'.
2140 * @type string $id_submit The comment submit element id attribute. Default 'submit'.
2141 * @type string $class_form The comment form element class attribute. Default 'comment-form'.
2142 * @type string $class_submit The comment submit element class attribute. Default 'submit'.
2143 * @type string $name_submit The comment submit element name attribute. Default 'submit'.
2144 * @type string $title_reply The translatable 'reply' button label. Default 'Leave a Reply'.
2145 * @type string $title_reply_to The translatable 'reply-to' button label. Default 'Leave a Reply to %s',
2146 * where %s is the author of the comment being replied to.
2147 * @type string $title_reply_before HTML displayed before the comment form title.
2148 * Default: '<h3 id="reply-title" class="comment-reply-title">'.
2149 * @type string $title_reply_after HTML displayed after the comment form title.
2151 * @type string $cancel_reply_before HTML displayed before the cancel reply link.
2152 * @type string $cancel_reply_after HTML displayed after the cancel reply link.
2153 * @type string $cancel_reply_link The translatable 'cancel reply' button label. Default 'Cancel reply'.
2154 * @type string $label_submit The translatable 'submit' button label. Default 'Post a comment'.
2155 * @type string $submit_button HTML format for the Submit button.
2156 * Default: '<input name="%1$s" type="submit" id="%2$s" class="%3$s" value="%4$s" />'.
2157 * @type string $submit_field HTML format for the markup surrounding the Submit button and comment hidden
2158 * fields. Default: '<p class="form-submit">%1$s %2$s</a>', where %1$s is the
2159 * submit button markup and %2$s is the comment hidden fields.
2160 * @type string $format The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'.
2162 * @param int|WP_Post $post_id Post ID or WP_Post object to generate the form for. Default current post.
2164 function comment_form( $args = array(), $post_id = null ) {
2165 if ( null === $post_id )
2166 $post_id = get_the_ID();
2168 $commenter = wp_get_current_commenter();
2169 $user = wp_get_current_user();
2170 $user_identity = $user->exists() ? $user->display_name : '';
2172 $args = wp_parse_args( $args );
2173 if ( ! isset( $args['format'] ) )
2174 $args['format'] = current_theme_supports( 'html5', 'comment-form' ) ? 'html5' : 'xhtml';
2176 $req = get_option( 'require_name_email' );
2177 $aria_req = ( $req ? " aria-required='true'" : '' );
2178 $html_req = ( $req ? " required='required'" : '' );
2179 $html5 = 'html5' === $args['format'];
2181 'author' => '<p class="comment-form-author">' . '<label for="author">' . __( 'Name' ) . ( $req ? ' <span class="required">*</span>' : '' ) . '</label> ' .
2182 '<input id="author" name="author" type="text" value="' . esc_attr( $commenter['comment_author'] ) . '" size="30" maxlength="245"' . $aria_req . $html_req . ' /></p>',
2183 'email' => '<p class="comment-form-email"><label for="email">' . __( 'Email' ) . ( $req ? ' <span class="required">*</span>' : '' ) . '</label> ' .
2184 '<input id="email" name="email" ' . ( $html5 ? 'type="email"' : 'type="text"' ) . ' value="' . esc_attr( $commenter['comment_author_email'] ) . '" size="30" maxlength="100" aria-describedby="email-notes"' . $aria_req . $html_req . ' /></p>',
2185 'url' => '<p class="comment-form-url"><label for="url">' . __( 'Website' ) . '</label> ' .
2186 '<input id="url" name="url" ' . ( $html5 ? 'type="url"' : 'type="text"' ) . ' value="' . esc_attr( $commenter['comment_author_url'] ) . '" size="30" maxlength="200" /></p>',
2189 $required_text = sprintf( ' ' . __('Required fields are marked %s'), '<span class="required">*</span>' );
2192 * Filters the default comment form fields.
2196 * @param array $fields The default comment fields.
2198 $fields = apply_filters( 'comment_form_default_fields', $fields );
2200 'fields' => $fields,
2201 'comment_field' => '<p class="comment-form-comment"><label for="comment">' . _x( 'Comment', 'noun' ) . '</label> <textarea id="comment" name="comment" cols="45" rows="8" maxlength="65525" aria-required="true" required="required"></textarea></p>',
2202 /** This filter is documented in wp-includes/link-template.php */
2203 'must_log_in' => '<p class="must-log-in">' . sprintf(
2204 /* translators: %s: login URL */
2205 __( 'You must be <a href="%s">logged in</a> to post a comment.' ),
2206 wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) )
2208 /** This filter is documented in wp-includes/link-template.php */
2209 'logged_in_as' => '<p class="logged-in-as">' . sprintf(
2210 /* translators: 1: edit user link, 2: accessibility text, 3: user name, 4: logout URL */
2211 __( '<a href="%1$s" aria-label="%2$s">Logged in as %3$s</a>. <a href="%4$s">Log out?</a>' ),
2212 get_edit_user_link(),
2213 /* translators: %s: user name */
2214 esc_attr( sprintf( __( 'Logged in as %s. Edit your profile.' ), $user_identity ) ),
2216 wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) )
2218 'comment_notes_before' => '<p class="comment-notes"><span id="email-notes">' . __( 'Your email address will not be published.' ) . '</span>'. ( $req ? $required_text : '' ) . '</p>',
2219 'comment_notes_after' => '',
2220 'action' => site_url( '/wp-comments-post.php' ),
2221 'id_form' => 'commentform',
2222 'id_submit' => 'submit',
2223 'class_form' => 'comment-form',
2224 'class_submit' => 'submit',
2225 'name_submit' => 'submit',
2226 'title_reply' => __( 'Leave a Reply' ),
2227 'title_reply_to' => __( 'Leave a Reply to %s' ),
2228 'title_reply_before' => '<h3 id="reply-title" class="comment-reply-title">',
2229 'title_reply_after' => '</h3>',
2230 'cancel_reply_before' => ' <small>',
2231 'cancel_reply_after' => '</small>',
2232 'cancel_reply_link' => __( 'Cancel reply' ),
2233 'label_submit' => __( 'Post Comment' ),
2234 'submit_button' => '<input name="%1$s" type="submit" id="%2$s" class="%3$s" value="%4$s" />',
2235 'submit_field' => '<p class="form-submit">%1$s %2$s</p>',
2236 'format' => 'xhtml',
2240 * Filters the comment form default arguments.
2242 * Use {@see 'comment_form_default_fields'} to filter the comment fields.
2246 * @param array $defaults The default comment form arguments.
2248 $args = wp_parse_args( $args, apply_filters( 'comment_form_defaults', $defaults ) );
2250 // Ensure that the filtered args contain all required default values.
2251 $args = array_merge( $defaults, $args );
2253 if ( comments_open( $post_id ) ) : ?>
2256 * Fires before the comment form.
2260 do_action( 'comment_form_before' );
2262 <div id="respond" class="comment-respond">
2264 echo $args['title_reply_before'];
2266 comment_form_title( $args['title_reply'], $args['title_reply_to'] );
2268 echo $args['cancel_reply_before'];
2270 cancel_comment_reply_link( $args['cancel_reply_link'] );
2272 echo $args['cancel_reply_after'];
2274 echo $args['title_reply_after'];
2276 if ( get_option( 'comment_registration' ) && !is_user_logged_in() ) :
2277 echo $args['must_log_in'];
2279 * Fires after the HTML-formatted 'must log in after' message in the comment form.
2283 do_action( 'comment_form_must_log_in_after' );
2285 <form action="<?php echo esc_url( $args['action'] ); ?>" method="post" id="<?php echo esc_attr( $args['id_form'] ); ?>" class="<?php echo esc_attr( $args['class_form'] ); ?>"<?php echo $html5 ? ' novalidate' : ''; ?>>
2288 * Fires at the top of the comment form, inside the form tag.
2292 do_action( 'comment_form_top' );
2294 if ( is_user_logged_in() ) :
2296 * Filters the 'logged in' message for the comment form for display.
2300 * @param string $args_logged_in The logged-in-as HTML-formatted message.
2301 * @param array $commenter An array containing the comment author's
2302 * username, email, and URL.
2303 * @param string $user_identity If the commenter is a registered user,
2304 * the display name, blank otherwise.
2306 echo apply_filters( 'comment_form_logged_in', $args['logged_in_as'], $commenter, $user_identity );
2309 * Fires after the is_user_logged_in() check in the comment form.
2313 * @param array $commenter An array containing the comment author's
2314 * username, email, and URL.
2315 * @param string $user_identity If the commenter is a registered user,
2316 * the display name, blank otherwise.
2318 do_action( 'comment_form_logged_in_after', $commenter, $user_identity );
2322 echo $args['comment_notes_before'];
2326 // Prepare an array of all fields, including the textarea
2327 $comment_fields = array( 'comment' => $args['comment_field'] ) + (array) $args['fields'];
2330 * Filters the comment form fields, including the textarea.
2334 * @param array $comment_fields The comment fields.
2336 $comment_fields = apply_filters( 'comment_form_fields', $comment_fields );
2338 // Get an array of field names, excluding the textarea
2339 $comment_field_keys = array_diff( array_keys( $comment_fields ), array( 'comment' ) );
2341 // Get the first and the last field name, excluding the textarea
2342 $first_field = reset( $comment_field_keys );
2343 $last_field = end( $comment_field_keys );
2345 foreach ( $comment_fields as $name => $field ) {
2347 if ( 'comment' === $name ) {
2350 * Filters the content of the comment textarea field for display.
2354 * @param string $args_comment_field The content of the comment textarea field.
2356 echo apply_filters( 'comment_form_field_comment', $field );
2358 echo $args['comment_notes_after'];
2360 } elseif ( ! is_user_logged_in() ) {
2362 if ( $first_field === $name ) {
2364 * Fires before the comment fields in the comment form, excluding the textarea.
2368 do_action( 'comment_form_before_fields' );
2372 * Filters a comment form field for display.
2374 * The dynamic portion of the filter hook, `$name`, refers to the name
2375 * of the comment form field. Such as 'author', 'email', or 'url'.
2379 * @param string $field The HTML-formatted output of the comment form field.
2381 echo apply_filters( "comment_form_field_{$name}", $field ) . "\n";
2383 if ( $last_field === $name ) {
2385 * Fires after the comment fields in the comment form, excluding the textarea.
2389 do_action( 'comment_form_after_fields' );
2394 $submit_button = sprintf(
2395 $args['submit_button'],
2396 esc_attr( $args['name_submit'] ),
2397 esc_attr( $args['id_submit'] ),
2398 esc_attr( $args['class_submit'] ),
2399 esc_attr( $args['label_submit'] )
2403 * Filters the submit button for the comment form to display.
2407 * @param string $submit_button HTML markup for the submit button.
2408 * @param array $args Arguments passed to `comment_form()`.
2410 $submit_button = apply_filters( 'comment_form_submit_button', $submit_button, $args );
2412 $submit_field = sprintf(
2413 $args['submit_field'],
2415 get_comment_id_fields( $post_id )
2419 * Filters the submit field for the comment form to display.
2421 * The submit field includes the submit button, hidden fields for the
2422 * comment form, and any wrapper markup.
2426 * @param string $submit_field HTML markup for the submit field.
2427 * @param array $args Arguments passed to comment_form().
2429 echo apply_filters( 'comment_form_submit_field', $submit_field, $args );
2432 * Fires at the bottom of the comment form, inside the closing </form> tag.
2436 * @param int $post_id The post ID.
2438 do_action( 'comment_form', $post_id );
2442 </div><!-- #respond -->
2445 * Fires after the comment form.
2449 do_action( 'comment_form_after' );
2452 * Fires after the comment form if comments are closed.
2456 do_action( 'comment_form_comments_closed' );