wp-includes/comment-template.php

   1 <?php
   2 /**
   3  * Comment template functions
   4  *
   5  * These functions are meant to live inside of the WordPress loop.
   6  *
   7  * @package WordPress
   8  * @subpackage Template
   9  */
  10
  11 /**
  12  * Retrieve the author of the current comment.
  13  *
  14  * If the comment has an empty comment_author field, then 'Anonymous' person is
  15  * assumed.
  16  *
  17  * @since 1.5.0
  18  * @uses apply_filters() Calls 'get_comment_author' hook on the comment author
  19  *
  20  * @param int $comment_ID The ID of the comment for which to retrieve the author. Optional.
  21  * @return string The comment author
  22  */
  23 function get_comment_author( $comment_ID = 0 ) {
  24         $comment = get_comment( $comment_ID );
  25         if ( empty($comment->comment_author) ) {
  26                 if (!empty($comment->user_id)){
  27                         $user=get_userdata($comment->user_id);
  28                         $author=$user->user_login;
  29                 } else {
  30                         $author = __('Anonymous');
  31                 }
  32         } else {
  33                 $author = $comment->comment_author;
  34         }
  35         return apply_filters('get_comment_author', $author);
  36 }
  37
  38 /**
  39  * Displays the author of the current comment.
  40  *
  41  * @since 0.71
  42  * @uses apply_filters() Calls 'comment_author' on comment author before displaying
  43  *
  44  * @param int $comment_ID The ID of the comment for which to print the author. Optional.
  45  */
  46 function comment_author( $comment_ID = 0 ) {
  47         $author = apply_filters('comment_author', get_comment_author( $comment_ID ) );
  48         echo $author;
  49 }
  50
  51 /**
  52  * Retrieve the email of the author of the current comment.
  53  *
  54  * @since 1.5.0
  55  * @uses apply_filters() Calls the 'get_comment_author_email' hook on the comment author email
  56  * @uses $comment
  57  *
  58  * @param int $comment_ID The ID of the comment for which to get the author's email. Optional.
  59  * @return string The current comment author's email
  60  */
  61 function get_comment_author_email( $comment_ID = 0 ) {
  62         $comment = get_comment( $comment_ID );
  63         return apply_filters('get_comment_author_email', $comment->comment_author_email);
  64 }
  65
  66 /**
  67  * Display the email of the author of the current global $comment.
  68  *
  69  * Care should be taken to protect the email address and assure that email
  70  * harvesters do not capture your commentors' email address. Most assume that
  71  * their email address will not appear in raw form on the blog. Doing so will
  72  * enable anyone, including those that people don't want to get the email
  73  * address and use it for their own means good and bad.
  74  *
  75  * @since 0.71
  76  * @uses apply_filters() Calls 'author_email' hook on the author email
  77  *
  78  * @param int $comment_ID The ID of the comment for which to print the author's email. Optional.
  79  */
  80 function comment_author_email( $comment_ID = 0 ) {
  81         echo apply_filters('author_email', get_comment_author_email( $comment_ID ) );
  82 }
  83
  84 /**
  85  * Display the html email link to the author of the current comment.
  86  *
  87  * Care should be taken to protect the email address and assure that email
  88  * harvesters do not capture your commentors' email address. Most assume that
  89  * their email address will not appear in raw form on the blog. Doing so will
  90  * enable anyone, including those that people don't want to get the email
  91  * address and use it for their own means good and bad.
  92  *
  93  * @since 0.71
  94  * @uses apply_filters() Calls 'comment_email' hook for the display of the comment author's email
  95  * @uses get_comment_author_email_link() For generating the link
  96  * @global object $comment The current Comment row object
  97  *
  98  * @param string $linktext The text to display instead of the comment author's email address
  99  * @param string $before The text or HTML to display before the email link.
 100  * @param string $after The text or HTML to display after the email link.
 101  */
 102 function comment_author_email_link($linktext='', $before='', $after='') {
 103         if ( $link = get_comment_author_email_link( $linktext, $before, $after ) )
 104                 echo $link;
 105 }
 106
 107 /**
 108  * Return the html email link to the author of the current comment.
 109  *
 110  * Care should be taken to protect the email address and assure that email
 111  * harvesters do not capture your commentors' email address. Most assume that
 112  * their email address will not appear in raw form on the blog. Doing so will
 113  * enable anyone, including those that people don't want to get the email
 114  * address and use it for their own means good and bad.
 115  *
 116  * @since 2.7
 117  * @uses apply_filters() Calls 'comment_email' hook for the display of the comment author's email
 118  * @global object $comment The current Comment row object
 119  *
 120  * @param string $linktext The text to display instead of the comment author's email address
 121  * @param string $before The text or HTML to display before the email link.
 122  * @param string $after The text or HTML to display after the email link.
 123  */
 124 function get_comment_author_email_link($linktext='', $before='', $after='') {
 125         global $comment;
 126         $email = apply_filters('comment_email', $comment->comment_author_email);
 127         if ((!empty($email)) && ($email != '@')) {
 128         $display = ($linktext != '') ? $linktext : $email;
 129                 $return  = $before;
 130                 $return .= "<a href='mailto:$email'>$display</a>";
 131                 $return .= $after;
 132                 return $return;
 133         } else {
 134                 return '';
 135         }
 136 }
 137
 138 /**
 139  * Retrieve the html link to the url of the author of the current comment.
 140  *
 141  * @since 1.5.0
 142  * @uses apply_filters() Calls 'get_comment_author_link' hook on the complete link HTML or author
 143  *
 144  * @param int $comment_ID The ID of the comment for which to get the author's link. Optional.
 145  * @return string Comment Author name or HTML link for author's URL
 146  */
 147 function get_comment_author_link( $comment_ID = 0 ) {
 148         /** @todo Only call these functions when they are needed. Include in if... else blocks */
 149         $url    = get_comment_author_url( $comment_ID );
 150         $author = get_comment_author( $comment_ID );
 151
 152         if ( empty( $url ) || 'http://' == $url )
 153                 $return = $author;
 154         else
 155                 $return = "<a href='$url' rel='external nofollow' class='url'>$author</a>";
 156         return apply_filters('get_comment_author_link', $return);
 157 }
 158
 159 /**
 160  * Display the html link to the url of the author of the current comment.
 161  *
 162  * @since 0.71
 163  * @see get_comment_author_link() Echoes result
 164  *
 165  * @param int $comment_ID The ID of the comment for which to print the author's link. Optional.
 166  */
 167 function comment_author_link( $comment_ID = 0 ) {
 168         echo get_comment_author_link( $comment_ID );
 169 }
 170
 171 /**
 172  * Retrieve the IP address of the author of the current comment.
 173  *
 174  * @since 1.5.0
 175  * @uses $comment
 176  * @uses apply_filters()
 177  *
 178  * @param int $comment_ID The ID of the comment for which to get the author's IP address. Optional.
 179  * @return string The comment author's IP address.
 180  */
 181 function get_comment_author_IP( $comment_ID = 0 ) {
 182         $comment = get_comment( $comment_ID );
 183         return apply_filters('get_comment_author_IP', $comment->comment_author_IP);
 184 }
 185
 186 /**
 187  * Display the IP address of the author of the current comment.
 188  *
 189  * @since 0.71
 190  * @see get_comment_author_IP() Echoes Result
 191  *
 192  * @param int $comment_ID The ID of the comment for which to print the author's IP address. Optional.
 193  */
 194 function comment_author_IP( $comment_ID = 0 ) {
 195         echo get_comment_author_IP( $comment_ID );
 196 }
 197
 198 /**
 199  * Retrieve the url of the author of the current comment.
 200  *
 201  * @since 1.5.0
 202  * @uses apply_filters() Calls 'get_comment_author_url' hook on the comment author's URL
 203  *
 204  * @param int $comment_ID The ID of the comment for which to get the author's URL. Optional.
 205  * @return string
 206  */
 207 function get_comment_author_url( $comment_ID = 0 ) {
 208         $comment = get_comment( $comment_ID );
 209         $url = ('http://' == $comment->comment_author_url) ? '' : $comment->comment_author_url;
 210         $url = esc_url( $url, array('http', 'https') );
 211         return apply_filters('get_comment_author_url', $url);
 212 }
 213
 214 /**
 215  * Display the url of the author of the current comment.
 216  *
 217  * @since 0.71
 218  * @uses apply_filters()
 219  * @uses get_comment_author_url() Retrieves the comment author's URL
 220  *
 221  * @param int $comment_ID The ID of the comment for which to print the author's URL. Optional.
 222  */
 223 function comment_author_url( $comment_ID = 0 ) {
 224         echo apply_filters('comment_url', get_comment_author_url( $comment_ID ));
 225 }
 226
 227 /**
 228  * Retrieves the HTML link of the url of the author of the current comment.
 229  *
 230  * $linktext parameter is only used if the URL does not exist for the comment
 231  * author. If the URL does exist then the URL will be used and the $linktext
 232  * will be ignored.
 233  *
 234  * Encapsulate the HTML link between the $before and $after. So it will appear
 235  * in the order of $before, link, and finally $after.
 236  *
 237  * @since 1.5.0
 238  * @uses apply_filters() Calls the 'get_comment_author_url_link' on the complete HTML before returning.
 239  *
 240  * @param string $linktext The text to display instead of the comment author's email address
 241  * @param string $before The text or HTML to display before the email link.
 242  * @param string $after The text or HTML to display after the email link.
 243  * @return string The HTML link between the $before and $after parameters
 244  */
 245 function get_comment_author_url_link( $linktext = '', $before = '', $after = '' ) {
 246         $url = get_comment_author_url();
 247         $display = ($linktext != '') ? $linktext : $url;
 248         $display = str_replace( 'http://www.', '', $display );
 249         $display = str_replace( 'http://', '', $display );
 250         if ( '/' == substr($display, -1) )
 251                 $display = substr($display, 0, -1);
 252         $return = "$before<a href='$url' rel='external'>$display</a>$after";
 253         return apply_filters('get_comment_author_url_link', $return);
 254 }
 255
 256 /**
 257  * Displays the HTML link of the url of the author of the current comment.
 258  *
 259  * @since 0.71
 260  * @see get_comment_author_url_link() Echoes result
 261  *
 262  * @param string $linktext The text to display instead of the comment author's email address
 263  * @param string $before The text or HTML to display before the email link.
 264  * @param string $after The text or HTML to display after the email link.
 265  */
 266 function comment_author_url_link( $linktext = '', $before = '', $after = '' ) {
 267         echo get_comment_author_url_link( $linktext, $before, $after );
 268 }
 269
 270 /**
 271  * Generates semantic classes for each comment element
 272  *
 273  * @since 2.7.0
 274  *
 275  * @param string|array $class One or more classes to add to the class list
 276  * @param int $comment_id An optional comment ID
 277  * @param int $post_id An optional post ID
 278  * @param bool $echo Whether comment_class should echo or return
 279  */
 280 function comment_class( $class = '', $comment_id = null, $post_id = null, $echo = true ) {
 281         // Separates classes with a single space, collates classes for comment DIV
 282         $class = 'class="' . join( ' ', get_comment_class( $class, $comment_id, $post_id ) ) . '"';
 283         if ( $echo)
 284                 echo $class;
 285         else
 286                 return $class;
 287 }
 288
 289 /**
 290  * Returns the classes for the comment div as an array
 291  *
 292  * @since 2.7.0
 293  *
 294  * @param string|array $class One or more classes to add to the class list
 295  * @param int $comment_id An optional comment ID
 296  * @param int $post_id An optional post ID
 297  * @return array Array of classes
 298  */
 299 function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {
 300         global $comment_alt, $comment_depth, $comment_thread_alt;
 301
 302         $comment = get_comment($comment_id);
 303
 304         $classes = array();
 305
 306         // Get the comment type (comment, trackback),
 307         $classes[] = ( empty( $comment->comment_type ) ) ? 'comment' : $comment->comment_type;
 308
 309         // If the comment author has an id (registered), then print the log in name
 310         if ( $comment->user_id > 0 && $user = get_userdata($comment->user_id) ) {
 311                 // For all registered users, 'byuser'
 312                 $classes[] = 'byuser';
 313                 $classes[] = 'comment-author-' . sanitize_html_class($user->user_nicename, $comment->user_id);
 314                 // For comment authors who are the author of the post
 315                 if ( $post = get_post($post_id) ) {
 316                         if ( $comment->user_id === $post->post_author )
 317                                 $classes[] = 'bypostauthor';
 318                 }
 319         }
 320
 321         if ( empty($comment_alt) )
 322                 $comment_alt = 0;
 323         if ( empty($comment_depth) )
 324                 $comment_depth = 1;
 325         if ( empty($comment_thread_alt) )
 326                 $comment_thread_alt = 0;
 327
 328         if ( $comment_alt % 2 ) {
 329                 $classes[] = 'odd';
 330                 $classes[] = 'alt';
 331         } else {
 332                 $classes[] = 'even';
 333         }
 334
 335         $comment_alt++;
 336
 337         // Alt for top-level comments
 338         if ( 1 == $comment_depth ) {
 339                 if ( $comment_thread_alt % 2 ) {
 340                         $classes[] = 'thread-odd';
 341                         $classes[] = 'thread-alt';
 342                 } else {
 343                         $classes[] = 'thread-even';
 344                 }
 345                 $comment_thread_alt++;
 346         }
 347
 348         $classes[] = "depth-$comment_depth";
 349
 350         if ( !empty($class) ) {
 351                 if ( !is_array( $class ) )
 352                         $class = preg_split('#\s+#', $class);
 353                 $classes = array_merge($classes, $class);
 354         }
 355
 356         $classes = array_map('esc_attr', $classes);
 357
 358         return apply_filters('comment_class', $classes, $class, $comment_id, $post_id);
 359 }
 360
 361 /**
 362  * Retrieve the comment date of the current comment.
 363  *
 364  * @since 1.5.0
 365  * @uses apply_filters() Calls 'get_comment_date' hook with the formatted date and the $d parameter respectively
 366  * @uses $comment
 367  *
 368  * @param string $d The format of the date (defaults to user's config)
 369  * @param int $comment_ID The ID of the comment for which to get the date. Optional.
 370  * @return string The comment's date
 371  */
 372 function get_comment_date( $d = '', $comment_ID = 0 ) {
 373         $comment = get_comment( $comment_ID );
 374         if ( '' == $d )
 375                 $date = mysql2date(get_option('date_format'), $comment->comment_date);
 376         else
 377                 $date = mysql2date($d, $comment->comment_date);
 378         return apply_filters('get_comment_date', $date, $d);
 379 }
 380
 381 /**
 382  * Display the comment date of the current comment.
 383  *
 384  * @since 0.71
 385  *
 386  * @param string $d The format of the date (defaults to user's config)
 387  * @param int $comment_ID The ID of the comment for which to print the date. Optional.
 388  */
 389 function comment_date( $d = '', $comment_ID = 0 ) {
 390         echo get_comment_date( $d, $comment_ID );
 391 }
 392
 393 /**
 394  * Retrieve the excerpt of the current comment.
 395  *
 396  * Will cut each word and only output the first 20 words with '&hellip;' at the end.
 397  * If the word count is less than 20, then no truncating is done and no '&hellip;'
 398  * will appear.
 399  *
 400  * @since 1.5.0
 401  * @uses $comment
 402  * @uses apply_filters() Calls 'get_comment_excerpt' on truncated comment
 403  *
 404  * @param int $comment_ID The ID of the comment for which to get the excerpt. Optional.
 405  * @return string The maybe truncated comment with 20 words or less
 406  */
 407 function get_comment_excerpt( $comment_ID = 0 ) {
 408         $comment = get_comment( $comment_ID );
 409         $comment_text = strip_tags($comment->comment_content);
 410         $blah = explode(' ', $comment_text);
 411         if (count($blah) > 20) {
 412                 $k = 20;
 413                 $use_dotdotdot = 1;
 414         } else {
 415                 $k = count($blah);
 416                 $use_dotdotdot = 0;
 417         }
 418         $excerpt = '';
 419         for ($i=0; $i<$k; $i++) {
 420                 $excerpt .= $blah[$i] . ' ';
 421         }
 422         $excerpt .= ($use_dotdotdot) ? '&hellip;' : '';
 423         return apply_filters('get_comment_excerpt', $excerpt);
 424 }
 425
 426 /**
 427  * Display the excerpt of the current comment.
 428  *
 429  * @since 1.2.0
 430  * @uses apply_filters() Calls 'comment_excerpt' hook before displaying excerpt
 431  *
 432  * @param int $comment_ID The ID of the comment for which to print the excerpt. Optional.
 433  */
 434 function comment_excerpt( $comment_ID = 0 ) {
 435         echo apply_filters('comment_excerpt', get_comment_excerpt($comment_ID) );
 436 }
 437
 438 /**
 439  * Retrieve the comment id of the current comment.
 440  *
 441  * @since 1.5.0
 442  * @uses $comment
 443  * @uses apply_filters() Calls the 'get_comment_ID' hook for the comment ID
 444  *
 445  * @return int The comment ID
 446  */
 447 function get_comment_ID() {
 448         global $comment;
 449         return apply_filters('get_comment_ID', $comment->comment_ID);
 450 }
 451
 452 /**
 453  * Displays the comment id of the current comment.
 454  *
 455  * @since 0.71
 456  * @see get_comment_ID() Echoes Result
 457  */
 458 function comment_ID() {
 459         echo get_comment_ID();
 460 }
 461
 462 /**
 463  * Retrieve the link to a given comment.
 464  *
 465  * @since 1.5.0
 466  * @uses $comment
 467  *
 468  * @param object|string|int $comment Comment to retrieve.
 469  * @param array $args Optional args.
 470  * @return string The permalink to the given comment.
 471  */
 472 function get_comment_link( $comment = null, $args = array() ) {
 473         global $wp_rewrite, $in_comment_loop;
 474
 475         $comment = get_comment($comment);
 476
 477         // Backwards compat
 478         if ( !is_array($args) ) {
 479                 $page = $args;
 480                 $args = array();
 481                 $args['page'] = $page;
 482         }
 483
 484         $defaults = array( 'type' => 'all', 'page' => '', 'per_page' => '', 'max_depth' => '' );
 485         $args = wp_parse_args( $args, $defaults );
 486
 487         if ( '' === $args['per_page'] && get_option('page_comments') )
 488                 $args['per_page'] = get_option('comments_per_page');
 489
 490         if ( empty($args['per_page']) ) {
 491                 $args['per_page'] = 0;
 492                 $args['page'] = 0;
 493         }
 494
 495         if ( $args['per_page'] ) {
 496                 if ( '' == $args['page'] )
 497                         $args['page'] = ( !empty($in_comment_loop) ) ? get_query_var('cpage') : get_page_of_comment( $comment->comment_ID, $args );
 498
 499                 if ( $wp_rewrite->using_permalinks() )
 500                         $link = user_trailingslashit( trailingslashit( get_permalink( $comment->comment_post_ID ) ) . 'comment-page-' . $args['page'], 'comment' );
 501                 else
 502                         $link = add_query_arg( 'cpage', $args['page'], get_permalink( $comment->comment_post_ID ) );
 503         } else {
 504                 $link = get_permalink( $comment->comment_post_ID );
 505         }
 506
 507         return apply_filters( 'get_comment_link', $link . '#comment-' . $comment->comment_ID, $comment, $args );
 508 }
 509
 510 /**
 511  * Retrieves the link to the current post comments.
 512  *
 513  * @since 1.5.0
 514  *
 515  * @param int $post_id Optional post id
 516  * @return string The link to the comments
 517  */
 518 function get_comments_link($post_id = 0) {
 519         return apply_filters( 'get_comments_link', get_permalink( $post_id ) . '#comments', $post_id );
 520 }
 521
 522 /**
 523  * Displays the link to the current post comments.
 524  *
 525  * @since 0.71
 526  *
 527  * @param string $deprecated Not Used
 528  * @param bool $deprecated_2 Not Used
 529  */
 530 function comments_link( $deprecated = '', $deprecated_2 = '' ) {
 531         if ( !empty( $deprecated ) )
 532                 _deprecated_argument( __FUNCTION__, '0.72' );
 533         if ( !empty( $deprecated_2 ) )
 534                 _deprecated_argument( __FUNCTION__, '1.3' );
 535         echo esc_url( get_comments_link() );
 536 }
 537
 538 /**
 539  * Retrieve the amount of comments a post has.
 540  *
 541  * @since 1.5.0
 542  * @uses apply_filters() Calls the 'get_comments_number' hook on the number of comments
 543  *
 544  * @param int $post_id The Post ID
 545  * @return int The number of comments a post has
 546  */
 547 function get_comments_number( $post_id = 0 ) {
 548         $post_id = absint( $post_id );
 549
 550         if ( !$post_id )
 551                 $post_id = get_the_ID();
 552
 553         $post = get_post($post_id);
 554         if ( ! isset($post->comment_count) )
 555                 $count = 0;
 556         else
 557                 $count = $post->comment_count;
 558
 559         return apply_filters('get_comments_number', $count, $post_id);
 560 }
 561
 562 /**
 563  * Display the language string for the number of comments the current post has.
 564  *
 565  * @since 0.71
 566  * @uses apply_filters() Calls the 'comments_number' hook on the output and number of comments respectively.
 567  *
 568  * @param string $zero Text for no comments
 569  * @param string $one Text for one comment
 570  * @param string $more Text for more than one comment
 571  * @param string $deprecated Not used.
 572  */
 573 function comments_number( $zero = false, $one = false, $more = false, $deprecated = '' ) {
 574         if ( !empty( $deprecated ) )
 575                 _deprecated_argument( __FUNCTION__, '1.3' );
 576
 577         $number = get_comments_number();
 578
 579         if ( $number > 1 )
 580                 $output = str_replace('%', number_format_i18n($number), ( false === $more ) ? __('% Comments') : $more);
 581         elseif ( $number == 0 )
 582                 $output = ( false === $zero ) ? __('No Comments') : $zero;
 583         else // must be one
 584                 $output = ( false === $one ) ? __('1 Comment') : $one;
 585
 586         echo apply_filters('comments_number', $output, $number);
 587 }
 588
 589 /**
 590  * Retrieve the text of the current comment.
 591  *
 592  * @since 1.5.0
 593  * @uses $comment
 594  *
 595  * @param int $comment_ID The ID of the comment for which to get the text. Optional.
 596  * @return string The comment content
 597  */
 598 function get_comment_text( $comment_ID = 0 ) {
 599         $comment = get_comment( $comment_ID );
 600         return apply_filters( 'get_comment_text', $comment->comment_content, $comment );
 601 }
 602
 603 /**
 604  * Displays the text of the current comment.
 605  *
 606  * @since 0.71
 607  * @uses apply_filters() Passes the comment content through the 'comment_text' hook before display
 608  * @uses get_comment_text() Gets the comment content
 609  *
 610  * @param int $comment_ID The ID of the comment for which to print the text. Optional.
 611  */
 612 function comment_text( $comment_ID = 0 ) {
 613         $comment = get_comment( $comment_ID );
 614         echo apply_filters( 'comment_text', get_comment_text( $comment_ID ), $comment );
 615 }
 616
 617 /**
 618  * Retrieve the comment time of the current comment.
 619  *
 620  * @since 1.5.0
 621  * @uses $comment
 622  * @uses apply_filter() Calls 'get_comment_time' hook with the formatted time, the $d parameter, and $gmt parameter passed.
 623  *
 624  * @param string $d Optional. The format of the time (defaults to user's config)
 625  * @param bool $gmt Whether to use the GMT date
 626  * @param bool $translate Whether to translate the time (for use in feeds)
 627  * @return string The formatted time
 628  */
 629 function get_comment_time( $d = '', $gmt = false, $translate = true ) {
 630         global $comment;
 631         $comment_date = $gmt ? $comment->comment_date_gmt : $comment->comment_date;
 632         if ( '' == $d )
 633                 $date = mysql2date(get_option('time_format'), $comment_date, $translate);
 634         else
 635                 $date = mysql2date($d, $comment_date, $translate);
 636         return apply_filters('get_comment_time', $date, $d, $gmt, $translate);
 637 }
 638
 639 /**
 640  * Display the comment time of the current comment.
 641  *
 642  * @since 0.71
 643  *
 644  * @param string $d Optional. The format of the time (defaults to user's config)
 645  */
 646 function comment_time( $d = '' ) {
 647         echo get_comment_time($d);
 648 }
 649
 650 /**
 651  * Retrieve the comment type of the current comment.
 652  *
 653  * @since 1.5.0
 654  * @uses $comment
 655  * @uses apply_filters() Calls the 'get_comment_type' hook on the comment type
 656  *
 657  * @param int $comment_ID The ID of the comment for which to get the type. Optional.
 658  * @return string The comment type
 659  */
 660 function get_comment_type( $comment_ID = 0 ) {
 661         $comment = get_comment( $comment_ID );
 662         if ( '' == $comment->comment_type )
 663                 $comment->comment_type = 'comment';
 664
 665         return apply_filters('get_comment_type', $comment->comment_type);
 666 }
 667
 668 /**
 669  * Display the comment type of the current comment.
 670  *
 671  * @since 0.71
 672  *
 673  * @param string $commenttxt The string to display for comment type
 674  * @param string $trackbacktxt The string to display for trackback type
 675  * @param string $pingbacktxt The string to display for pingback type
 676  */
 677 function comment_type($commenttxt = false, $trackbacktxt = false, $pingbacktxt = false) {
 678         if ( false === $commenttxt ) $commenttxt = _x( 'Comment', 'noun' );
 679         if ( false === $trackbacktxt ) $trackbacktxt = __( 'Trackback' );
 680         if ( false === $pingbacktxt ) $pingbacktxt = __( 'Pingback' );
 681         $type = get_comment_type();
 682         switch( $type ) {
 683                 case 'trackback' :
 684                         echo $trackbacktxt;
 685                         break;
 686                 case 'pingback' :
 687                         echo $pingbacktxt;
 688                         break;
 689                 default :
 690                         echo $commenttxt;
 691         }
 692 }
 693
 694 /**
 695  * Retrieve The current post's trackback URL.
 696  *
 697  * There is a check to see if permalink's have been enabled and if so, will
 698  * retrieve the pretty path. If permalinks weren't enabled, the ID of the
 699  * current post is used and appended to the correct page to go to.
 700  *
 701  * @since 1.5.0
 702  * @uses apply_filters() Calls 'trackback_url' on the resulting trackback URL
 703  *
 704  * @return string The trackback URL after being filtered
 705  */
 706 function get_trackback_url() {
 707         if ( '' != get_option('permalink_structure') ) {
 708                 $tb_url = trailingslashit(get_permalink()) . user_trailingslashit('trackback', 'single_trackback');
 709         } else {
 710                 $tb_url = get_option('siteurl') . '/wp-trackback.php?p=' . get_the_ID();
 711         }
 712         return apply_filters('trackback_url', $tb_url);
 713 }
 714
 715 /**
 716  * Displays the current post's trackback URL.
 717  *
 718  * @since 0.71
 719  * @uses get_trackback_url() Gets the trackback url for the current post
 720  *
 721  * @param bool $deprecated_echo Remove backwards compat in 2.5
 722  * @return void|string Should only be used to echo the trackback URL, use get_trackback_url() for the result instead.
 723  */
 724 function trackback_url( $deprecated_echo = true ) {
 725         if ( $deprecated_echo !== true )
 726                 _deprecated_argument( __FUNCTION__, '2.5', __('Use <code>get_trackback_url()</code> instead if you do not want the value echoed.') );
 727         if ( $deprecated_echo )
 728                 echo get_trackback_url();
 729         else
 730                 return get_trackback_url();
 731 }
 732
 733 /**
 734  * Generates and displays the RDF for the trackback information of current post.
 735  *
 736  * Deprecated in 3.0.0, and restored in 3.0.1.
 737  *
 738  * @since 0.71
 739  *
 740  * @param int $deprecated Not used (Was $timezone = 0)
 741  */
 742 function trackback_rdf( $deprecated = '' ) {
 743         if ( !empty( $deprecated ) )
 744                 _deprecated_argument( __FUNCTION__, '2.5' );
 745
 746         if ( false !== stripos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') )
 747                 return;
 748
 749         echo '<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
 750                         xmlns:dc="http://purl.org/dc/elements/1.1/"
 751                         xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/">
 752                 <rdf:Description rdf:about="';
 753         the_permalink();
 754         echo '"'."\n";
 755         echo '    dc:identifier="';
 756         the_permalink();
 757         echo '"'."\n";
 758         echo '    dc:title="'.str_replace('--', '&#x2d;&#x2d;', wptexturize(strip_tags(get_the_title()))).'"'."\n";
 759         echo '    trackback:ping="'.get_trackback_url().'"'." />\n";
 760         echo '</rdf:RDF>';
 761 }
 762
 763 /**
 764  * Whether the current post is open for comments.
 765  *
 766  * @since 1.5.0
 767  * @uses $post
 768  *
 769  * @param int $post_id An optional post ID to check instead of the current post.
 770  * @return bool True if the comments are open
 771  */
 772 function comments_open( $post_id = null ) {
 773
 774         $_post = get_post($post_id);
 775
 776         $open = ( 'open' == $_post->comment_status );
 777         return apply_filters( 'comments_open', $open, $post_id );
 778 }
 779
 780 /**
 781  * Whether the current post is open for pings.
 782  *
 783  * @since 1.5.0
 784  * @uses $post
 785  *
 786  * @param int $post_id An optional post ID to check instead of the current post.
 787  * @return bool True if pings are accepted
 788  */
 789 function pings_open( $post_id = null ) {
 790
 791         $_post = get_post($post_id);
 792
 793         $open = ( 'open' == $_post->ping_status );
 794         return apply_filters( 'pings_open', $open, $post_id );
 795 }
 796
 797 /**
 798  * Displays form token for unfiltered comments.
 799  *
 800  * Will only display nonce token if the current user has permissions for
 801  * unfiltered html. Won't display the token for other users.
 802  *
 803  * The function was backported to 2.0.10 and was added to versions 2.1.3 and
 804  * above. Does not exist in versions prior to 2.0.10 in the 2.0 branch and in
 805  * the 2.1 branch, prior to 2.1.3. Technically added in 2.2.0.
 806  *
 807  * Backported to 2.0.10.
 808  *
 809  * @since 2.1.3
 810  * @uses $post Gets the ID of the current post for the token
 811  */
 812 function wp_comment_form_unfiltered_html_nonce() {
 813         $post = get_post();
 814         $post_id = $post ? $post->ID : 0;
 815
 816         if ( current_user_can( 'unfiltered_html' ) ) {
 817                 wp_nonce_field( 'unfiltered-html-comment_' . $post_id, '_wp_unfiltered_html_comment_disabled', false );
 818                 echo "<script>(function(){if(window===window.parent){document.getElementById('_wp_unfiltered_html_comment_disabled').name='_wp_unfiltered_html_comment';}})();</script>\n";
 819         }
 820 }
 821
 822 /**
 823  * Loads the comment template specified in $file.
 824  *
 825  * Will not display the comments template if not on single post or page, or if
 826  * the post does not have comments.
 827  *
 828  * Uses the WordPress database object to query for the comments. The comments
 829  * are passed through the 'comments_array' filter hook with the list of comments
 830  * and the post ID respectively.
 831  *
 832  * The $file path is passed through a filter hook called, 'comments_template'
 833  * which includes the TEMPLATEPATH and $file combined. Tries the $filtered path
 834  * first and if it fails it will require the default comment template from the
 835  * default theme. If either does not exist, then the WordPress process will be
 836  * halted. It is advised for that reason, that the default theme is not deleted.
 837  *
 838  * @since 1.5.0
 839  * @global array $comment List of comment objects for the current post
 840  * @uses $wpdb
 841  * @uses $post
 842  * @uses $withcomments Will not try to get the comments if the post has none.
 843  *
 844  * @param string $file Optional, default '/comments.php'. The file to load
 845  * @param bool $separate_comments Optional, whether to separate the comments by comment type. Default is false.
 846  * @return null Returns null if no comments appear
 847  */
 848 function comments_template( $file = '/comments.php', $separate_comments = false ) {
 849         global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_ID, $user_identity, $overridden_cpage;
 850
 851         if ( !(is_single() || is_page() || $withcomments) || empty($post) )
 852                 return;
 853
 854         if ( empty($file) )
 855                 $file = '/comments.php';
 856
 857         $req = get_option('require_name_email');
 858
 859         /**
 860          * Comment author information fetched from the comment cookies.
 861          *
 862          * @uses wp_get_current_commenter()
 863          */
 864         $commenter = wp_get_current_commenter();
 865
 866         /**
 867          * The name of the current comment author escaped for use in attributes.
 868          */
 869         $comment_author = $commenter['comment_author']; // Escaped by sanitize_comment_cookies()
 870
 871         /**
 872          * The email address of the current comment author escaped for use in attributes.
 873          */
 874         $comment_author_email = $commenter['comment_author_email'];  // Escaped by sanitize_comment_cookies()
 875
 876         /**
 877          * The url of the current comment author escaped for use in attributes.
 878          */
 879         $comment_author_url = esc_url($commenter['comment_author_url']);
 880
 881         /** @todo Use API instead of SELECTs. */
 882         if ( $user_ID) {
 883                 $comments = $wpdb->get_results($wpdb->prepare("SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND (comment_approved = '1' OR ( user_id = %d AND comment_approved = '0' ) )  ORDER BY comment_date_gmt", $post->ID, $user_ID));
 884         } else if ( empty($comment_author) ) {
 885                 $comments = get_comments( array('post_id' => $post->ID, 'status' => 'approve', 'order' => 'ASC') );
 886         } else {
 887                 $comments = $wpdb->get_results($wpdb->prepare("SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND ( comment_approved = '1' OR ( comment_author = %s AND comment_author_email = %s AND comment_approved = '0' ) ) ORDER BY comment_date_gmt", $post->ID, wp_specialchars_decode($comment_author,ENT_QUOTES), $comment_author_email));
 888         }
 889
 890         // keep $comments for legacy's sake
 891         $wp_query->comments = apply_filters( 'comments_array', $comments, $post->ID );
 892         $comments = &$wp_query->comments;
 893         $wp_query->comment_count = count($wp_query->comments);
 894         update_comment_cache($wp_query->comments);
 895
 896         if ( $separate_comments ) {
 897                 $wp_query->comments_by_type = separate_comments($comments);
 898                 $comments_by_type = &$wp_query->comments_by_type;
 899         }
 900
 901         $overridden_cpage = false;
 902         if ( '' == get_query_var('cpage') && get_option('page_comments') ) {
 903                 set_query_var( 'cpage', 'newest' == get_option('default_comments_page') ? get_comment_pages_count() : 1 );
 904                 $overridden_cpage = true;
 905         }
 906
 907         if ( !defined('COMMENTS_TEMPLATE') )
 908                 define('COMMENTS_TEMPLATE', true);
 909
 910         $include = apply_filters('comments_template', STYLESHEETPATH . $file );
 911         if ( file_exists( $include ) )
 912                 require( $include );
 913         elseif ( file_exists( TEMPLATEPATH . $file ) )
 914                 require( TEMPLATEPATH . $file );
 915         else // Backward compat code will be removed in a future release
 916                 require( ABSPATH . WPINC . '/theme-compat/comments.php');
 917 }
 918
 919 /**
 920  * Displays the JS popup script to show a comment.
 921  *
 922  * If the $file parameter is empty, then the home page is assumed. The defaults
 923  * for the window are 400px by 400px.
 924  *
 925  * For the comment link popup to work, this function has to be called or the
 926  * normal comment link will be assumed.
 927  *
 928  * @since 0.71
 929  * @global string $wpcommentspopupfile The URL to use for the popup window
 930  * @global int $wpcommentsjavascript Whether to use JavaScript. Set when function is called
 931  *
 932  * @param int $width Optional. The width of the popup window
 933  * @param int $height Optional. The height of the popup window
 934  * @param string $file Optional. Sets the location of the popup window
 935  */
 936 function comments_popup_script($width=400, $height=400, $file='') {
 937         global $wpcommentspopupfile, $wpcommentsjavascript;
 938
 939         if (empty ($file)) {
 940                 $wpcommentspopupfile = '';  // Use the index.
 941         } else {
 942                 $wpcommentspopupfile = $file;
 943         }
 944
 945         $wpcommentsjavascript = 1;
 946         $javascript = "<script type='text/javascript'>\nfunction wpopen (macagna) {\n    window.open(macagna, '_blank', 'width=$width,height=$height,scrollbars=yes,status=yes');\n}\n</script>\n";
 947         echo $javascript;
 948 }
 949
 950 /**
 951  * Displays the link to the comments popup window for the current post ID.
 952  *
 953  * Is not meant to be displayed on single posts and pages. Should be used on the
 954  * lists of posts
 955  *
 956  * @since 0.71
 957  * @uses $wpcommentspopupfile
 958  * @uses $wpcommentsjavascript
 959  * @uses $post
 960  *
 961  * @param string $zero The string to display when no comments
 962  * @param string $one The string to display when only one comment is available
 963  * @param string $more The string to display when there are more than one comment
 964  * @param string $css_class The CSS class to use for comments
 965  * @param string $none The string to display when comments have been turned off
 966  * @return null Returns null on single posts and pages.
 967  */
 968 function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) {
 969         global $wpcommentspopupfile, $wpcommentsjavascript;
 970
 971         $id = get_the_ID();
 972
 973         if ( false === $zero ) $zero = __( 'No Comments' );
 974         if ( false === $one ) $one = __( '1 Comment' );
 975         if ( false === $more ) $more = __( '% Comments' );
 976         if ( false === $none ) $none = __( 'Comments Off' );
 977
 978         $number = get_comments_number( $id );
 979
 980         if ( 0 == $number && !comments_open() && !pings_open() ) {
 981                 echo '<span' . ((!empty($css_class)) ? ' class="' . esc_attr( $css_class ) . '"' : '') . '>' . $none . '</span>';
 982                 return;
 983         }
 984
 985         if ( post_password_required() ) {
 986                 echo __('Enter your password to view comments.');
 987                 return;
 988         }
 989
 990         echo '<a href="';
 991         if ( $wpcommentsjavascript ) {
 992                 if ( empty( $wpcommentspopupfile ) )
 993                         $home = home_url();
 994                 else
 995                         $home = get_option('siteurl');
 996                 echo $home . '/' . $wpcommentspopupfile . '?comments_popup=' . $id;
 997                 echo '" onclick="wpopen(this.href); return false"';
 998         } else { // if comments_popup_script() is not in the template, display simple comment link
 999                 if ( 0 == $number )
1000                         echo get_permalink() . '#respond';
1001                 else
1002                         comments_link();
1003                 echo '"';
1004         }
1005
1006         if ( !empty( $css_class ) ) {
1007                 echo ' class="'.$css_class.'" ';
1008         }
1009         $title = the_title_attribute( array('echo' => 0 ) );
1010
1011         echo apply_filters( 'comments_popup_link_attributes', '' );
1012
1013         echo ' title="' . esc_attr( sprintf( __('Comment on %s'), $title ) ) . '">';
1014         comments_number( $zero, $one, $more );
1015         echo '</a>';
1016 }
1017
1018 /**
1019  * Retrieve HTML content for reply to comment link.
1020  *
1021  * The default arguments that can be override are 'add_below', 'respond_id',
1022  * 'reply_text', 'login_text', and 'depth'. The 'login_text' argument will be
1023  * used, if the user must log in or register first before posting a comment. The
1024  * 'reply_text' will be used, if they can post a reply. The 'add_below' and
1025  * 'respond_id' arguments are for the JavaScript moveAddCommentForm() function
1026  * parameters.
1027  *
1028  * @since 2.7.0
1029  *
1030  * @param array $args Optional. Override default options.
1031  * @param int $comment Optional. Comment being replied to.
1032  * @param int $post Optional. Post that the comment is going to be displayed on.
1033  * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1034  */
1035 function get_comment_reply_link($args = array(), $comment = null, $post = null) {
1036         global $user_ID;
1037
1038         $defaults = array('add_below' => 'comment', 'respond_id' => 'respond', 'reply_text' => __('Reply'),
1039                 'login_text' => __('Log in to Reply'), 'depth' => 0, 'before' => '', 'after' => '');
1040
1041         $args = wp_parse_args($args, $defaults);
1042
1043         if ( 0 == $args['depth'] || $args['max_depth'] <= $args['depth'] )
1044                 return;
1045
1046         extract($args, EXTR_SKIP);
1047
1048         $comment = get_comment($comment);
1049         if ( empty($post) )
1050                 $post = $comment->comment_post_ID;
1051         $post = get_post($post);
1052
1053         if ( !comments_open($post->ID) )
1054                 return false;
1055
1056         $link = '';
1057
1058         if ( get_option('comment_registration') && !$user_ID )
1059                 $link = '<a rel="nofollow" class="comment-reply-login" href="' . esc_url( wp_login_url( get_permalink() ) ) . '">' . $login_text . '</a>';
1060         else
1061                 $link = "<a class='comment-reply-link' href='" . esc_url( add_query_arg( 'replytocom', $comment->comment_ID ) ) . "#" . $respond_id . "' onclick='return addComment.moveForm(\"$add_below-$comment->comment_ID\", \"$comment->comment_ID\", \"$respond_id\", \"$post->ID\")'>$reply_text</a>";
1062         return apply_filters('comment_reply_link', $before . $link . $after, $args, $comment, $post);
1063 }
1064
1065 /**
1066  * Displays the HTML content for reply to comment link.
1067  *
1068  * @since 2.7.0
1069  * @see get_comment_reply_link() Echoes result
1070  *
1071  * @param array $args Optional. Override default options.
1072  * @param int $comment Optional. Comment being replied to.
1073  * @param int $post Optional. Post that the comment is going to be displayed on.
1074  * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1075  */
1076 function comment_reply_link($args = array(), $comment = null, $post = null) {
1077         echo get_comment_reply_link($args, $comment, $post);
1078 }
1079
1080 /**
1081  * Retrieve HTML content for reply to post link.
1082  *
1083  * The default arguments that can be override are 'add_below', 'respond_id',
1084  * 'reply_text', 'login_text', and 'depth'. The 'login_text' argument will be
1085  * used, if the user must log in or register first before posting a comment. The
1086  * 'reply_text' will be used, if they can post a reply. The 'add_below' and
1087  * 'respond_id' arguments are for the JavaScript moveAddCommentForm() function
1088  * parameters.
1089  *
1090  * @since 2.7.0
1091  *
1092  * @param array $args Optional. Override default options.
1093  * @param int|object $post Optional. Post that the comment is going to be displayed on. Defaults to current post.
1094  * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1095  */
1096 function get_post_reply_link($args = array(), $post = null) {
1097         global $user_ID;
1098
1099         $defaults = array('add_below' => 'post', 'respond_id' => 'respond', 'reply_text' => __('Leave a Comment'),
1100                 'login_text' => __('Log in to leave a Comment'), 'before' => '', 'after' => '');
1101
1102         $args = wp_parse_args($args, $defaults);
1103         extract($args, EXTR_SKIP);
1104         $post = get_post($post);
1105
1106         if ( !comments_open($post->ID) )
1107                 return false;
1108
1109         if ( get_option('comment_registration') && !$user_ID ) {
1110                 $link = '<a rel="nofollow" href="' . wp_login_url( get_permalink() ) . '">' . $login_text . '</a>';
1111         } else {
1112                 $link = "<a rel='nofollow' class='comment-reply-link' href='" . get_permalink($post->ID) . "#$respond_id' onclick='return addComment.moveForm(\"$add_below-$post->ID\", \"0\", \"$respond_id\", \"$post->ID\")'>$reply_text</a>";
1113         }
1114         return apply_filters('post_comments_link', $before . $link . $after, $post);
1115 }
1116
1117 /**
1118  * Displays the HTML content for reply to post link.
1119  * @since 2.7.0
1120  * @see get_post_reply_link()
1121  *
1122  * @param array $args Optional. Override default options.
1123  * @param int|object $post Optional. Post that the comment is going to be displayed on.
1124  * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1125  */
1126 function post_reply_link($args = array(), $post = null) {
1127         echo get_post_reply_link($args, $post);
1128 }
1129
1130 /**
1131  * Retrieve HTML content for cancel comment reply link.
1132  *
1133  * @since 2.7.0
1134  *
1135  * @param string $text Optional. Text to display for cancel reply link.
1136  */
1137 function get_cancel_comment_reply_link($text = '') {
1138         if ( empty($text) )
1139                 $text = __('Click here to cancel reply.');
1140
1141         $style = isset($_GET['replytocom']) ? '' : ' style="display:none;"';
1142         $link = esc_html( remove_query_arg('replytocom') ) . '#respond';
1143         return apply_filters('cancel_comment_reply_link', '<a rel="nofollow" id="cancel-comment-reply-link" href="' . $link . '"' . $style . '>' . $text . '</a>', $link, $text);
1144 }
1145
1146 /**
1147  * Display HTML content for cancel comment reply link.
1148  *
1149  * @since 2.7.0
1150  *
1151  * @param string $text Optional. Text to display for cancel reply link.
1152  */
1153 function cancel_comment_reply_link($text = '') {
1154         echo get_cancel_comment_reply_link($text);
1155 }
1156
1157 /**
1158  * Retrieve hidden input HTML for replying to comments.
1159  *
1160  * @since 3.0.0
1161  *
1162  * @return string Hidden input HTML for replying to comments
1163  */
1164 function get_comment_id_fields( $id = 0 ) {
1165         if ( empty( $id ) )
1166                 $id = get_the_ID();
1167
1168         $replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
1169         $result  = "<input type='hidden' name='comment_post_ID' value='$id' id='comment_post_ID' />\n";
1170         $result .= "<input type='hidden' name='comment_parent' id='comment_parent' value='$replytoid' />\n";
1171         return apply_filters('comment_id_fields', $result, $id, $replytoid);
1172 }
1173
1174 /**
1175  * Output hidden input HTML for replying to comments.
1176  *
1177  * @since 2.7.0
1178  * @see get_comment_id_fields() Echoes result
1179  */
1180 function comment_id_fields( $id = 0 ) {
1181         echo get_comment_id_fields( $id );
1182 }
1183
1184 /**
1185  * Display text based on comment reply status. Only affects users with Javascript disabled.
1186  *
1187  * @since 2.7.0
1188  *
1189  * @param string $noreplytext Optional. Text to display when not replying to a comment.
1190  * @param string $replytext Optional. Text to display when replying to a comment. Accepts "%s" for the author of the comment being replied to.
1191  * @param string $linktoparent Optional. Boolean to control making the author's name a link to their comment.
1192  */
1193 function comment_form_title( $noreplytext = false, $replytext = false, $linktoparent = true ) {
1194         global $comment;
1195
1196         if ( false === $noreplytext ) $noreplytext = __( 'Leave a Reply' );
1197         if ( false === $replytext ) $replytext = __( 'Leave a Reply to %s' );
1198
1199         $replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
1200
1201         if ( 0 == $replytoid )
1202                 echo $noreplytext;
1203         else {
1204                 $comment = get_comment($replytoid);
1205                 $author = ( $linktoparent ) ? '<a href="#comment-' . get_comment_ID() . '">' . get_comment_author() . '</a>' : get_comment_author();
1206                 printf( $replytext, $author );
1207         }
1208 }
1209
1210 /**
1211  * HTML comment list class.
1212  *
1213  * @package WordPress
1214  * @uses Walker
1215  * @since 2.7.0
1216  */
1217 class Walker_Comment extends Walker {
1218         /**
1219          * @see Walker::$tree_type
1220          * @since 2.7.0
1221          * @var string
1222          */
1223         var $tree_type = 'comment';
1224
1225         /**
1226          * @see Walker::$db_fields
1227          * @since 2.7.0
1228          * @var array
1229          */
1230         var $db_fields = array ('parent' => 'comment_parent', 'id' => 'comment_ID');
1231
1232         /**
1233          * @see Walker::start_lvl()
1234          * @since 2.7.0
1235          *
1236          * @param string $output Passed by reference. Used to append additional content.
1237          * @param int $depth Depth of comment.
1238          * @param array $args Uses 'style' argument for type of HTML list.
1239          */
1240         function start_lvl( &$output, $depth = 0, $args = array() ) {
1241                 $GLOBALS['comment_depth'] = $depth + 1;
1242
1243                 switch ( $args['style'] ) {
1244                         case 'div':
1245                                 break;
1246                         case 'ol':
1247                                 echo '<ol class="children">' . "\n";
1248                                 break;
1249                         default:
1250                         case 'ul':
1251                                 echo '<ul class="children">' . "\n";
1252                                 break;
1253                 }
1254         }
1255
1256         /**
1257          * @see Walker::end_lvl()
1258          * @since 2.7.0
1259          *
1260          * @param string $output Passed by reference. Used to append additional content.
1261          * @param int $depth Depth of comment.
1262          * @param array $args Will only append content if style argument value is 'ol' or 'ul'.
1263          */
1264         function end_lvl( &$output, $depth = 0, $args = array() ) {
1265                 $GLOBALS['comment_depth'] = $depth + 1;
1266
1267                 switch ( $args['style'] ) {
1268                         case 'div':
1269                                 break;
1270                         case 'ol':
1271                                 echo "</ol><!-- .children -->\n";
1272                                 break;
1273                         default:
1274                         case 'ul':
1275                                 echo "</ul><!-- .children -->\n";
1276                                 break;
1277                 }
1278         }
1279
1280         /**
1281          * This function is designed to enhance Walker::display_element() to
1282          * display children of higher nesting levels than selected inline on
1283          * the highest depth level displayed. This prevents them being orphaned
1284          * at the end of the comment list.
1285          *
1286          * Example: max_depth = 2, with 5 levels of nested content.
1287          * 1
1288          *  1.1
1289          *    1.1.1
1290          *    1.1.1.1
1291          *    1.1.1.1.1
1292          *    1.1.2
1293          *    1.1.2.1
1294          * 2
1295          *  2.2
1296          *
1297          */
1298         function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) {
1299
1300                 if ( !$element )
1301                         return;
1302
1303                 $id_field = $this->db_fields['id'];
1304                 $id = $element->$id_field;
1305
1306                 parent::display_element( $element, $children_elements, $max_depth, $depth, $args, $output );
1307
1308                 // If we're at the max depth, and the current element still has children, loop over those and display them at this level
1309                 // This is to prevent them being orphaned to the end of the list.
1310                 if ( $max_depth <= $depth + 1 && isset( $children_elements[$id]) ) {
1311                         foreach ( $children_elements[ $id ] as $child )
1312                                 $this->display_element( $child, $children_elements, $max_depth, $depth, $args, $output );
1313
1314                         unset( $children_elements[ $id ] );
1315                 }
1316
1317         }
1318
1319         /**
1320          * @see Walker::start_el()
1321          * @since 2.7.0
1322          *
1323          * @param string $output Passed by reference. Used to append additional content.
1324          * @param object $comment Comment data object.
1325          * @param int $depth Depth of comment in reference to parents.
1326          * @param array $args
1327          */
1328         function start_el( &$output, $comment, $depth = 0, $args = array(), $id = 0 ) {
1329                 $depth++;
1330                 $GLOBALS['comment_depth'] = $depth;
1331                 $GLOBALS['comment'] = $comment;
1332
1333                 if ( !empty( $args['callback'] ) ) {
1334                         call_user_func( $args['callback'], $comment, $args, $depth );
1335                         return;
1336                 }
1337
1338                 if ( ( 'pingback' == $comment->comment_type || 'trackback' == $comment->comment_type ) && $args['short_ping'] ) {
1339                         $this->ping( $comment, $depth, $args );
1340                 } elseif ( 'html5' === $args['format'] ) {
1341                         $this->html5_comment( $comment, $depth, $args );
1342                 } else {
1343                         $this->comment( $comment, $depth, $args );
1344                 }
1345         }
1346
1347         /**
1348          * @see Walker::end_el()
1349          * @since 2.7.0
1350          *
1351          * @param string $output Passed by reference. Used to append additional content.
1352          * @param object $comment
1353          * @param int $depth Depth of comment.
1354          * @param array $args
1355          */
1356         function end_el( &$output, $comment, $depth = 0, $args = array() ) {
1357                 if ( !empty( $args['end-callback'] ) ) {
1358                         call_user_func( $args['end-callback'], $comment, $args, $depth );
1359                         return;
1360                 }
1361                 if ( 'div' == $args['style'] )
1362                         echo "</div><!-- #comment-## -->\n";
1363                 else
1364                         echo "</li><!-- #comment-## -->\n";
1365         }
1366
1367         /**
1368          * @since 3.6
1369          * @access protected
1370          *
1371          * @param object $comment
1372          * @param int $depth Depth of comment.
1373          * @param array $args
1374          */
1375         protected function ping( $comment, $depth, $args ) {
1376                 $tag = ( 'div' == $args['style'] ) ? 'div' : 'li';
1377 ?>
1378                 <<?php echo $tag; ?> id="comment-<?php comment_ID(); ?>" <?php comment_class(); ?>>
1379                         <div class="comment-body">
1380                                 <?php _e( 'Pingback:' ); ?> <?php comment_author_link(); ?> <?php edit_comment_link( __( 'Edit' ), '<span class="edit-link">', '</span>' ); ?>
1381                         </div>
1382 <?php
1383         }
1384
1385         /**
1386          * @since 3.6
1387          * @access protected
1388          *
1389          * @param object $comment Comment to display.
1390          * @param int $depth Depth of comment.
1391          * @param array $args Optional args.
1392          */
1393         protected function comment( $comment, $depth, $args ) {
1394                 if ( 'div' == $args['style'] ) {
1395                         $tag = 'div';
1396                         $add_below = 'comment';
1397                 } else {
1398                         $tag = 'li';
1399                         $add_below = 'div-comment';
1400                 }
1401 ?>
1402                 <<?php echo $tag; ?> <?php comment_class( empty( $args['has_children'] ) ? '' : 'parent' ); ?> id="comment-<?php comment_ID(); ?>">
1403                 <?php if ( 'div' != $args['style'] ) : ?>
1404                 <div id="div-comment-<?php comment_ID(); ?>" class="comment-body">
1405                 <?php endif; ?>
1406                 <div class="comment-author vcard">
1407                         <?php if ( 0 != $args['avatar_size'] ) echo get_avatar( $comment, $args['avatar_size'] ); ?>
1408                         <?php printf( __( '<cite class="fn">%s</cite> <span class="says">says:</span>' ), get_comment_author_link() ); ?>
1409                 </div>
1410                 <?php if ( '0' == $comment->comment_approved ) : ?>
1411                 <em class="comment-awaiting-moderation"><?php _e( 'Your comment is awaiting moderation.' ) ?></em>
1412                 <br />
1413                 <?php endif; ?>
1414
1415                 <div class="comment-meta commentmetadata"><a href="<?php echo esc_url( get_comment_link( $comment->comment_ID ) ); ?>">
1416                         <?php
1417                                 /* translators: 1: date, 2: time */
1418                                 printf( __( '%1$s at %2$s' ), get_comment_date(),  get_comment_time() ); ?></a><?php edit_comment_link( __( '(Edit)' ), '&nbsp;&nbsp;', '' );
1419                         ?>
1420                 </div>
1421
1422                 <?php comment_text() ?>
1423
1424                 <div class="reply">
1425                         <?php comment_reply_link( array_merge( $args, array( 'add_below' => $add_below, 'depth' => $depth, 'max_depth' => $args['max_depth'] ) ) ); ?>
1426                 </div>
1427                 <?php if ( 'div' != $args['style'] ) : ?>
1428                 </div>
1429                 <?php endif; ?>
1430 <?php
1431         }
1432
1433         /**
1434          * @since 3.6
1435          * @access protected
1436          *
1437          * @param object $comment Comment to display.
1438          * @param int $depth Depth of comment.
1439          * @param array $args Optional args.
1440          */
1441         protected function html5_comment( $comment, $depth, $args ) {
1442                 $tag = ( 'div' === $args['style'] ) ? 'div' : 'li';
1443 ?>
1444                 <<?php echo $tag; ?> id="comment-<?php comment_ID(); ?>" <?php comment_class( empty( $args['has_children'] ) ? '' : 'parent' ); ?>>
1445                         <article id="div-comment-<?php comment_ID(); ?>" class="comment-body">
1446                                 <footer class="comment-meta">
1447                                         <div class="comment-author vcard">
1448                                                 <?php if ( 0 != $args['avatar_size'] ) echo get_avatar( $comment, $args['avatar_size'] ); ?>
1449                                                 <?php printf( __( '%s <span class="says">says:</span>' ), sprintf( '<b class="fn">%s</b>', get_comment_author_link() ) ); ?>
1450                                         </div><!-- .comment-author -->
1451
1452                                         <div class="comment-metadata">
1453                                                 <a href="<?php echo esc_url( get_comment_link( $comment->comment_ID ) ); ?>">
1454                                                         <time datetime="<?php comment_time( 'c' ); ?>">
1455                                                                 <?php printf( _x( '%1$s at %2$s', '1: date, 2: time' ), get_comment_date(), get_comment_time() ); ?>
1456                                                         </time>
1457                                                 </a>
1458                                                 <?php edit_comment_link( __( 'Edit' ), '<span class="edit-link">', '</span>' ); ?>
1459                                         </div><!-- .comment-metadata -->
1460
1461                                         <?php if ( '0' == $comment->comment_approved ) : ?>
1462                                         <p class="comment-awaiting-moderation"><?php _e( 'Your comment is awaiting moderation.' ); ?></p>
1463                                         <?php endif; ?>
1464                                 </footer><!-- .comment-meta -->
1465
1466                                 <div class="comment-content">
1467                                         <?php comment_text(); ?>
1468                                 </div><!-- .comment-content -->
1469
1470                                 <div class="reply">
1471                                         <?php comment_reply_link( array_merge( $args, array( 'add_below' => 'div-comment', 'depth' => $depth, 'max_depth' => $args['max_depth'] ) ) ); ?>
1472                                 </div><!-- .reply -->
1473                         </article><!-- .comment-body -->
1474 <?php
1475         }
1476 }
1477
1478 /**
1479  * List comments
1480  *
1481  * Used in the comments.php template to list comments for a particular post
1482  *
1483  * @since 2.7.0
1484  * @uses Walker_Comment
1485  *
1486  * @param string|array $args Formatting options
1487  * @param array $comments Optional array of comment objects. Defaults to $wp_query->comments
1488  */
1489 function wp_list_comments($args = array(), $comments = null ) {
1490         global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop;
1491
1492         $in_comment_loop = true;
1493
1494         $comment_alt = $comment_thread_alt = 0;
1495         $comment_depth = 1;
1496
1497         $defaults = array(
1498                 'walker'            => null,
1499                 'max_depth'         => '',
1500                 'style'             => 'ul',
1501                 'callback'          => null,
1502                 'end-callback'      => null,
1503                 'type'              => 'all',
1504                 'page'              => '',
1505                 'per_page'          => '',
1506                 'avatar_size'       => 32,
1507                 'reverse_top_level' => null,
1508                 'reverse_children'  => '',
1509                 'format'            => current_theme_supports( 'html5', 'comment-list' ) ? 'html5' : 'xhtml',
1510                 'short_ping'        => false,
1511         );
1512
1513         $r = wp_parse_args( $args, $defaults );
1514
1515         // Figure out what comments we'll be looping through ($_comments)
1516         if ( null !== $comments ) {
1517                 $comments = (array) $comments;
1518                 if ( empty($comments) )
1519                         return;
1520                 if ( 'all' != $r['type'] ) {
1521                         $comments_by_type = separate_comments($comments);
1522                         if ( empty($comments_by_type[$r['type']]) )
1523                                 return;
1524                         $_comments = $comments_by_type[$r['type']];
1525                 } else {
1526                         $_comments = $comments;
1527                 }
1528         } else {
1529                 if ( empty($wp_query->comments) )
1530                         return;
1531                 if ( 'all' != $r['type'] ) {
1532                         if ( empty($wp_query->comments_by_type) )
1533                                 $wp_query->comments_by_type = separate_comments($wp_query->comments);
1534                         if ( empty($wp_query->comments_by_type[$r['type']]) )
1535                                 return;
1536                         $_comments = $wp_query->comments_by_type[$r['type']];
1537                 } else {
1538                         $_comments = $wp_query->comments;
1539                 }
1540         }
1541
1542         if ( '' === $r['per_page'] && get_option('page_comments') )
1543                 $r['per_page'] = get_query_var('comments_per_page');
1544
1545         if ( empty($r['per_page']) ) {
1546                 $r['per_page'] = 0;
1547                 $r['page'] = 0;
1548         }
1549
1550         if ( '' === $r['max_depth'] ) {
1551                 if ( get_option('thread_comments') )
1552                         $r['max_depth'] = get_option('thread_comments_depth');
1553                 else
1554                         $r['max_depth'] = -1;
1555         }
1556
1557         if ( '' === $r['page'] ) {
1558                 if ( empty($overridden_cpage) ) {
1559                         $r['page'] = get_query_var('cpage');
1560                 } else {
1561                         $threaded = ( -1 != $r['max_depth'] );
1562                         $r['page'] = ( 'newest' == get_option('default_comments_page') ) ? get_comment_pages_count($_comments, $r['per_page'], $threaded) : 1;
1563                         set_query_var( 'cpage', $r['page'] );
1564                 }
1565         }
1566         // Validation check
1567         $r['page'] = intval($r['page']);
1568         if ( 0 == $r['page'] && 0 != $r['per_page'] )
1569                 $r['page'] = 1;
1570
1571         if ( null === $r['reverse_top_level'] )
1572                 $r['reverse_top_level'] = ( 'desc' == get_option('comment_order') );
1573
1574         extract( $r, EXTR_SKIP );
1575
1576         if ( empty($walker) )
1577                 $walker = new Walker_Comment;
1578
1579         $walker->paged_walk($_comments, $max_depth, $page, $per_page, $r);
1580         $wp_query->max_num_comment_pages = $walker->max_pages;
1581
1582         $in_comment_loop = false;
1583 }
1584
1585 /**
1586  * Outputs a complete commenting form for use within a template.
1587  * Most strings and form fields may be controlled through the $args array passed
1588  * into the function, while you may also choose to use the comment_form_default_fields
1589  * filter to modify the array of default fields if you'd just like to add a new
1590  * one or remove a single field. All fields are also individually passed through
1591  * a filter of the form comment_form_field_$name where $name is the key used
1592  * in the array of fields.
1593  *
1594  * @since 3.0.0
1595  * @param array $args Options for strings, fields etc in the form
1596  * @param mixed $post_id Post ID to generate the form for, uses the current post if null
1597  * @return void
1598  */
1599 function comment_form( $args = array(), $post_id = null ) {
1600         if ( null === $post_id )
1601                 $post_id = get_the_ID();
1602         else
1603                 $id = $post_id;
1604
1605         $commenter = wp_get_current_commenter();
1606         $user = wp_get_current_user();
1607         $user_identity = $user->exists() ? $user->display_name : '';
1608
1609         $args = wp_parse_args( $args );
1610         if ( ! isset( $args['format'] ) )
1611                 $args['format'] = current_theme_supports( 'html5', 'comment-form' ) ? 'html5' : 'xhtml';
1612
1613         $req      = get_option( 'require_name_email' );
1614         $aria_req = ( $req ? " aria-required='true'" : '' );
1615         $html5    = 'html5' === $args['format'];
1616         $fields   =  array(
1617                 'author' => '<p class="comment-form-author">' . '<label for="author">' . __( 'Name' ) . ( $req ? ' <span class="required">*</span>' : '' ) . '</label> ' .
1618                             '<input id="author" name="author" type="text" value="' . esc_attr( $commenter['comment_author'] ) . '" size="30"' . $aria_req . ' /></p>',
1619                 'email'  => '<p class="comment-form-email"><label for="email">' . __( 'Email' ) . ( $req ? ' <span class="required">*</span>' : '' ) . '</label> ' .
1620                             '<input id="email" name="email" ' . ( $html5 ? 'type="email"' : 'type="text"' ) . ' value="' . esc_attr(  $commenter['comment_author_email'] ) . '" size="30"' . $aria_req . ' /></p>',
1621                 'url'    => '<p class="comment-form-url"><label for="url">' . __( 'Website' ) . '</label> ' .
1622                             '<input id="url" name="url" ' . ( $html5 ? 'type="url"' : 'type="text"' ) . ' value="' . esc_attr( $commenter['comment_author_url'] ) . '" size="30" /></p>',
1623         );
1624
1625         $required_text = sprintf( ' ' . __('Required fields are marked %s'), '<span class="required">*</span>' );
1626         $defaults = array(
1627                 'fields'               => apply_filters( 'comment_form_default_fields', $fields ),
1628                 'comment_field'        => '<p class="comment-form-comment"><label for="comment">' . _x( 'Comment', 'noun' ) . '</label> <textarea id="comment" name="comment" cols="45" rows="8" aria-required="true"></textarea></p>',
1629                 'must_log_in'          => '<p class="must-log-in">' . sprintf( __( 'You must be <a href="%s">logged in</a> to post a comment.' ), wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '</p>',
1630                 'logged_in_as'         => '<p class="logged-in-as">' . sprintf( __( 'Logged in as <a href="%1$s">%2$s</a>. <a href="%3$s" title="Log out of this account">Log out?</a>' ), get_edit_user_link(), $user_identity, wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '</p>',
1631                 'comment_notes_before' => '<p class="comment-notes">' . __( 'Your email address will not be published.' ) . ( $req ? $required_text : '' ) . '</p>',
1632                 'comment_notes_after'  => '<p class="form-allowed-tags">' . sprintf( __( 'You may use these <abbr title="HyperText Markup Language">HTML</abbr> tags and attributes: %s' ), ' <code>' . allowed_tags() . '</code>' ) . '</p>',
1633                 'id_form'              => 'commentform',
1634                 'id_submit'            => 'submit',
1635                 'title_reply'          => __( 'Leave a Reply' ),
1636                 'title_reply_to'       => __( 'Leave a Reply to %s' ),
1637                 'cancel_reply_link'    => __( 'Cancel reply' ),
1638                 'label_submit'         => __( 'Post Comment' ),
1639                 'format'               => 'xhtml',
1640         );
1641
1642         $args = wp_parse_args( $args, apply_filters( 'comment_form_defaults', $defaults ) );
1643
1644         ?>
1645                 <?php if ( comments_open( $post_id ) ) : ?>
1646                         <?php do_action( 'comment_form_before' ); ?>
1647                         <div id="respond" class="comment-respond">
1648                                 <h3 id="reply-title" class="comment-reply-title"><?php comment_form_title( $args['title_reply'], $args['title_reply_to'] ); ?> <small><?php cancel_comment_reply_link( $args['cancel_reply_link'] ); ?></small></h3>
1649                                 <?php if ( get_option( 'comment_registration' ) && !is_user_logged_in() ) : ?>
1650                                         <?php echo $args['must_log_in']; ?>
1651                                         <?php do_action( 'comment_form_must_log_in_after' ); ?>
1652                                 <?php else : ?>
1653                                         <form action="<?php echo site_url( '/wp-comments-post.php' ); ?>" method="post" id="<?php echo esc_attr( $args['id_form'] ); ?>" class="comment-form"<?php echo $html5 ? ' novalidate' : ''; ?>>
1654                                                 <?php do_action( 'comment_form_top' ); ?>
1655                                                 <?php if ( is_user_logged_in() ) : ?>
1656                                                         <?php echo apply_filters( 'comment_form_logged_in', $args['logged_in_as'], $commenter, $user_identity ); ?>
1657                                                         <?php do_action( 'comment_form_logged_in_after', $commenter, $user_identity ); ?>
1658                                                 <?php else : ?>
1659                                                         <?php echo $args['comment_notes_before']; ?>
1660                                                         <?php
1661                                                         do_action( 'comment_form_before_fields' );
1662                                                         foreach ( (array) $args['fields'] as $name => $field ) {
1663                                                                 echo apply_filters( "comment_form_field_{$name}", $field ) . "\n";
1664                                                         }
1665                                                         do_action( 'comment_form_after_fields' );
1666                                                         ?>
1667                                                 <?php endif; ?>
1668                                                 <?php echo apply_filters( 'comment_form_field_comment', $args['comment_field'] ); ?>
1669                                                 <?php echo $args['comment_notes_after']; ?>
1670                                                 <p class="form-submit">
1671                                                         <input name="submit" type="submit" id="<?php echo esc_attr( $args['id_submit'] ); ?>" value="<?php echo esc_attr( $args['label_submit'] ); ?>" />
1672                                                         <?php comment_id_fields( $post_id ); ?>
1673                                                 </p>
1674                                                 <?php do_action( 'comment_form', $post_id ); ?>
1675                                         </form>
1676                                 <?php endif; ?>
1677                         </div><!-- #respond -->
1678                         <?php do_action( 'comment_form_after' ); ?>
1679                 <?php else : ?>
1680                         <?php do_action( 'comment_form_comments_closed' ); ?>
1681                 <?php endif; ?>
1682         <?php
1683 }