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 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 formated 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 '...' at the end.
 397  * If the word count is less than 20, then no truncating is done and no '...'
 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) ? '...' : '';
 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 get_permalink($post_id) . '#comments';
 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 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         global $id;
 549         $post_id = (int) $post_id;
 550
 551         if ( !$post_id )
 552                 $post_id = (int) $id;
 553
 554         $post = get_post($post_id);
 555         if ( ! isset($post->comment_count) )
 556                 $count = 0;
 557         else
 558                 $count = $post->comment_count;
 559
 560         return apply_filters('get_comments_number', $count, $post_id);
 561 }
 562
 563 /**
 564  * Display the language string for the number of comments the current post has.
 565  *
 566  * @since 0.71
 567  * @uses $id
 568  * @uses apply_filters() Calls the 'comments_number' hook on the output and number of comments respectively.
 569  *
 570  * @param string $zero Text for no comments
 571  * @param string $one Text for one comment
 572  * @param string $more Text for more than one comment
 573  * @param string $deprecated Not used.
 574  */
 575 function comments_number( $zero = false, $one = false, $more = false, $deprecated = '' ) {
 576         global $id;
 577
 578         if ( !empty( $deprecated ) )
 579                 _deprecated_argument( __FUNCTION__, '1.3' );
 580
 581         $number = get_comments_number($id);
 582
 583         if ( $number > 1 )
 584                 $output = str_replace('%', number_format_i18n($number), ( false === $more ) ? __('% Comments') : $more);
 585         elseif ( $number == 0 )
 586                 $output = ( false === $zero ) ? __('No Comments') : $zero;
 587         else // must be one
 588                 $output = ( false === $one ) ? __('1 Comment') : $one;
 589
 590         echo apply_filters('comments_number', $output, $number);
 591 }
 592
 593 /**
 594  * Retrieve the text of the current comment.
 595  *
 596  * @since 1.5.0
 597  * @uses $comment
 598  *
 599  * @param int $comment_ID The ID of the comment for which to get the text. Optional.
 600  * @return string The comment content
 601  */
 602 function get_comment_text( $comment_ID = 0 ) {
 603         $comment = get_comment( $comment_ID );
 604         return apply_filters('get_comment_text', $comment->comment_content);
 605 }
 606
 607 /**
 608  * Displays the text of the current comment.
 609  *
 610  * @since 0.71
 611  * @uses apply_filters() Passes the comment content through the 'comment_text' hook before display
 612  * @uses get_comment_text() Gets the comment content
 613  *
 614  * @param int $comment_ID The ID of the comment for which to print the text. Optional.
 615  */
 616 function comment_text( $comment_ID = 0 ) {
 617         echo apply_filters('comment_text', get_comment_text() );
 618 }
 619
 620 /**
 621  * Retrieve the comment time of the current comment.
 622  *
 623  * @since 1.5.0
 624  * @uses $comment
 625  * @uses apply_filter() Calls 'get_comment_time' hook with the formatted time, the $d parameter, and $gmt parameter passed.
 626  *
 627  * @param string $d Optional. The format of the time (defaults to user's config)
 628  * @param bool $gmt Whether to use the GMT date
 629  * @param bool $translate Whether to translate the time (for use in feeds)
 630  * @return string The formatted time
 631  */
 632 function get_comment_time( $d = '', $gmt = false, $translate = true ) {
 633         global $comment;
 634         $comment_date = $gmt ? $comment->comment_date_gmt : $comment->comment_date;
 635         if ( '' == $d )
 636                 $date = mysql2date(get_option('time_format'), $comment_date, $translate);
 637         else
 638                 $date = mysql2date($d, $comment_date, $translate);
 639         return apply_filters('get_comment_time', $date, $d, $gmt, $translate);
 640 }
 641
 642 /**
 643  * Display the comment time of the current comment.
 644  *
 645  * @since 0.71
 646  *
 647  * @param string $d Optional. The format of the time (defaults to user's config)
 648  */
 649 function comment_time( $d = '' ) {
 650         echo get_comment_time($d);
 651 }
 652
 653 /**
 654  * Retrieve the comment type of the current comment.
 655  *
 656  * @since 1.5.0
 657  * @uses $comment
 658  * @uses apply_filters() Calls the 'get_comment_type' hook on the comment type
 659  *
 660  * @param int $comment_ID The ID of the comment for which to get the type. Optional.
 661  * @return string The comment type
 662  */
 663 function get_comment_type( $comment_ID = 0 ) {
 664         $comment = get_comment( $comment_ID );
 665         if ( '' == $comment->comment_type )
 666                 $comment->comment_type = 'comment';
 667
 668         return apply_filters('get_comment_type', $comment->comment_type);
 669 }
 670
 671 /**
 672  * Display the comment type of the current comment.
 673  *
 674  * @since 0.71
 675  *
 676  * @param string $commenttxt The string to display for comment type
 677  * @param string $trackbacktxt The string to display for trackback type
 678  * @param string $pingbacktxt The string to display for pingback type
 679  */
 680 function comment_type($commenttxt = false, $trackbacktxt = false, $pingbacktxt = false) {
 681     if ( false === $commenttxt ) $commenttxt = _x( 'Comment', 'noun' );
 682     if ( false === $trackbacktxt ) $trackbacktxt = __( 'Trackback' );
 683     if ( false === $pingbacktxt ) $pingbacktxt = __( 'Pingback' );
 684         $type = get_comment_type();
 685         switch( $type ) {
 686                 case 'trackback' :
 687                         echo $trackbacktxt;
 688                         break;
 689                 case 'pingback' :
 690                         echo $pingbacktxt;
 691                         break;
 692                 default :
 693                         echo $commenttxt;
 694         }
 695 }
 696
 697 /**
 698  * Retrieve The current post's trackback URL.
 699  *
 700  * There is a check to see if permalink's have been enabled and if so, will
 701  * retrieve the pretty path. If permalinks weren't enabled, the ID of the
 702  * current post is used and appended to the correct page to go to.
 703  *
 704  * @since 1.5.0
 705  * @uses apply_filters() Calls 'trackback_url' on the resulting trackback URL
 706  * @uses $id
 707  *
 708  * @return string The trackback URL after being filtered
 709  */
 710 function get_trackback_url() {
 711         global $id;
 712         if ( '' != get_option('permalink_structure') ) {
 713                 $tb_url = trailingslashit(get_permalink()) . user_trailingslashit('trackback', 'single_trackback');
 714         } else {
 715                 $tb_url = get_option('siteurl') . '/wp-trackback.php?p=' . $id;
 716         }
 717         return apply_filters('trackback_url', $tb_url);
 718 }
 719
 720 /**
 721  * Displays the current post's trackback URL.
 722  *
 723  * @since 0.71
 724  * @uses get_trackback_url() Gets the trackback url for the current post
 725  *
 726  * @param bool $deprecated_echo Remove backwards compat in 2.5
 727  * @return void|string Should only be used to echo the trackback URL, use get_trackback_url() for the result instead.
 728  */
 729 function trackback_url( $deprecated_echo = true ) {
 730         if ( $deprecated_echo !== true )
 731                 _deprecated_argument( __FUNCTION__, '2.5', __('Use <code>get_trackback_url()</code> instead if you do not want the value echoed.') );
 732         if ( $deprecated_echo )
 733                 echo get_trackback_url();
 734         else
 735                 return get_trackback_url();
 736 }
 737
 738 /**
 739  * Generates and displays the RDF for the trackback information of current post.
 740  *
 741  * Deprecated in 3.0.0, and restored in 3.0.1.
 742  *
 743  * @since 0.71
 744  *
 745  * @param int $deprecated Not used (Was $timezone = 0)
 746  */
 747 function trackback_rdf( $deprecated = '' ) {
 748         if ( !empty( $deprecated ) )
 749                 _deprecated_argument( __FUNCTION__, '2.5' );
 750
 751         echo '<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
 752                         xmlns:dc="http://purl.org/dc/elements/1.1/"
 753                         xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/">
 754                 <rdf:Description rdf:about="';
 755         the_permalink();
 756         echo '"'."\n";
 757         echo '    dc:identifier="';
 758         the_permalink();
 759         echo '"'."\n";
 760         echo '    dc:title="'.str_replace('--', '&#x2d;&#x2d;', wptexturize(strip_tags(get_the_title()))).'"'."\n";
 761         echo '    trackback:ping="'.get_trackback_url().'"'." />\n";
 762         echo '</rdf:RDF>';
 763 }
 764
 765 /**
 766  * Whether the current post is open for comments.
 767  *
 768  * @since 1.5.0
 769  * @uses $post
 770  *
 771  * @param int $post_id An optional post ID to check instead of the current post.
 772  * @return bool True if the comments are open
 773  */
 774 function comments_open( $post_id=NULL ) {
 775
 776         $_post = get_post($post_id);
 777
 778         $open = ( 'open' == $_post->comment_status );
 779         return apply_filters( 'comments_open', $open, $post_id );
 780 }
 781
 782 /**
 783  * Whether the current post is open for pings.
 784  *
 785  * @since 1.5.0
 786  * @uses $post
 787  *
 788  * @param int $post_id An optional post ID to check instead of the current post.
 789  * @return bool True if pings are accepted
 790  */
 791 function pings_open( $post_id = NULL ) {
 792
 793         $_post = get_post($post_id);
 794
 795         $open = ( 'open' == $_post->ping_status );
 796         return apply_filters( 'pings_open', $open, $post_id );
 797 }
 798
 799 /**
 800  * Displays form token for unfiltered comments.
 801  *
 802  * Will only display nonce token if the current user has permissions for
 803  * unfiltered html. Won't display the token for other users.
 804  *
 805  * The function was backported to 2.0.10 and was added to versions 2.1.3 and
 806  * above. Does not exist in versions prior to 2.0.10 in the 2.0 branch and in
 807  * the 2.1 branch, prior to 2.1.3. Technically added in 2.2.0.
 808  *
 809  * Backported to 2.0.10.
 810  *
 811  * @since 2.1.3
 812  * @uses $post Gets the ID of the current post for the token
 813  */
 814 function wp_comment_form_unfiltered_html_nonce() {
 815         global $post;
 816
 817         $post_id = 0;
 818         if ( !empty($post) )
 819                 $post_id = $post->ID;
 820
 821         if ( current_user_can('unfiltered_html') )
 822                 wp_nonce_field('unfiltered-html-comment_' . $post_id, '_wp_unfiltered_html_comment', false);
 823 }
 824
 825 /**
 826  * Loads the comment template specified in $file.
 827  *
 828  * Will not display the comments template if not on single post or page, or if
 829  * the post does not have comments.
 830  *
 831  * Uses the WordPress database object to query for the comments. The comments
 832  * are passed through the 'comments_array' filter hook with the list of comments
 833  * and the post ID respectively.
 834  *
 835  * The $file path is passed through a filter hook called, 'comments_template'
 836  * which includes the TEMPLATEPATH and $file combined. Tries the $filtered path
 837  * first and if it fails it will require the default comment themplate from the
 838  * default theme. If either does not exist, then the WordPress process will be
 839  * halted. It is advised for that reason, that the default theme is not deleted.
 840  *
 841  * @since 1.5.0
 842  * @global array $comment List of comment objects for the current post
 843  * @uses $wpdb
 844  * @uses $id
 845  * @uses $post
 846  * @uses $withcomments Will not try to get the comments if the post has none.
 847  *
 848  * @param string $file Optional, default '/comments.php'. The file to load
 849  * @param bool $separate_comments Optional, whether to separate the comments by comment type. Default is false.
 850  * @return null Returns null if no comments appear
 851  */
 852 function comments_template( $file = '/comments.php', $separate_comments = false ) {
 853         global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_ID, $user_identity, $overridden_cpage;
 854
 855         if ( !(is_single() || is_page() || $withcomments) || empty($post) )
 856                 return;
 857
 858         if ( empty($file) )
 859                 $file = '/comments.php';
 860
 861         $req = get_option('require_name_email');
 862
 863         /**
 864          * Comment author information fetched from the comment cookies.
 865          *
 866          * @uses wp_get_current_commenter()
 867          */
 868         $commenter = wp_get_current_commenter();
 869
 870         /**
 871          * The name of the current comment author escaped for use in attributes.
 872          */
 873         $comment_author = $commenter['comment_author']; // Escaped by sanitize_comment_cookies()
 874
 875         /**
 876          * The email address of the current comment author escaped for use in attributes.
 877          */
 878         $comment_author_email = $commenter['comment_author_email'];  // Escaped by sanitize_comment_cookies()
 879
 880         /**
 881          * The url of the current comment author escaped for use in attributes.
 882          */
 883         $comment_author_url = esc_url($commenter['comment_author_url']);
 884
 885         /** @todo Use API instead of SELECTs. */
 886         if ( $user_ID) {
 887                 $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));
 888         } else if ( empty($comment_author) ) {
 889                 $comments = get_comments( array('post_id' => $post->ID, 'status' => 'approve', 'order' => 'ASC') );
 890         } else {
 891                 $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));
 892         }
 893
 894         // keep $comments for legacy's sake
 895         $wp_query->comments = apply_filters( 'comments_array', $comments, $post->ID );
 896         $comments = &$wp_query->comments;
 897         $wp_query->comment_count = count($wp_query->comments);
 898         update_comment_cache($wp_query->comments);
 899
 900         if ( $separate_comments ) {
 901                 $wp_query->comments_by_type = &separate_comments($comments);
 902                 $comments_by_type = &$wp_query->comments_by_type;
 903         }
 904
 905         $overridden_cpage = FALSE;
 906         if ( '' == get_query_var('cpage') && get_option('page_comments') ) {
 907                 set_query_var( 'cpage', 'newest' == get_option('default_comments_page') ? get_comment_pages_count() : 1 );
 908                 $overridden_cpage = TRUE;
 909         }
 910
 911         if ( !defined('COMMENTS_TEMPLATE') || !COMMENTS_TEMPLATE)
 912                 define('COMMENTS_TEMPLATE', true);
 913
 914         $include = apply_filters('comments_template', STYLESHEETPATH . $file );
 915         if ( file_exists( $include ) )
 916                 require( $include );
 917         elseif ( file_exists( TEMPLATEPATH . $file ) )
 918                 require( TEMPLATEPATH .  $file );
 919         else // Backward compat code will be removed in a future release
 920                 require( ABSPATH . WPINC . '/theme-compat/comments.php');
 921 }
 922
 923 /**
 924  * Displays the JS popup script to show a comment.
 925  *
 926  * If the $file parameter is empty, then the home page is assumed. The defaults
 927  * for the window are 400px by 400px.
 928  *
 929  * For the comment link popup to work, this function has to be called or the
 930  * normal comment link will be assumed.
 931  *
 932  * @since 0.71
 933  * @global string $wpcommentspopupfile The URL to use for the popup window
 934  * @global int $wpcommentsjavascript Whether to use JavaScript. Set when function is called
 935  *
 936  * @param int $width Optional. The width of the popup window
 937  * @param int $height Optional. The height of the popup window
 938  * @param string $file Optional. Sets the location of the popup window
 939  */
 940 function comments_popup_script($width=400, $height=400, $file='') {
 941         global $wpcommentspopupfile, $wpcommentsjavascript;
 942
 943         if (empty ($file)) {
 944                 $wpcommentspopupfile = '';  // Use the index.
 945         } else {
 946                 $wpcommentspopupfile = $file;
 947         }
 948
 949         $wpcommentsjavascript = 1;
 950         $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";
 951         echo $javascript;
 952 }
 953
 954 /**
 955  * Displays the link to the comments popup window for the current post ID.
 956  *
 957  * Is not meant to be displayed on single posts and pages. Should be used on the
 958  * lists of posts
 959  *
 960  * @since 0.71
 961  * @uses $id
 962  * @uses $wpcommentspopupfile
 963  * @uses $wpcommentsjavascript
 964  * @uses $post
 965  *
 966  * @param string $zero The string to display when no comments
 967  * @param string $one The string to display when only one comment is available
 968  * @param string $more The string to display when there are more than one comment
 969  * @param string $css_class The CSS class to use for comments
 970  * @param string $none The string to display when comments have been turned off
 971  * @return null Returns null on single posts and pages.
 972  */
 973 function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) {
 974         global $id, $wpcommentspopupfile, $wpcommentsjavascript;
 975
 976     if ( false === $zero ) $zero = __( 'No Comments' );
 977     if ( false === $one ) $one = __( '1 Comment' );
 978     if ( false === $more ) $more = __( '% Comments' );
 979     if ( false === $none ) $none = __( 'Comments Off' );
 980
 981         $number = get_comments_number( $id );
 982
 983         if ( 0 == $number && !comments_open() && !pings_open() ) {
 984                 echo '<span' . ((!empty($css_class)) ? ' class="' . esc_attr( $css_class ) . '"' : '') . '>' . $none . '</span>';
 985                 return;
 986         }
 987
 988         if ( post_password_required() ) {
 989                 echo __('Enter your password to view comments.');
 990                 return;
 991         }
 992
 993         echo '<a href="';
 994         if ( $wpcommentsjavascript ) {
 995                 if ( empty( $wpcommentspopupfile ) )
 996                         $home = home_url();
 997                 else
 998                         $home = get_option('siteurl');
 999                 echo $home . '/' . $wpcommentspopupfile . '?comments_popup=' . $id;
1000                 echo '" onclick="wpopen(this.href); return false"';
1001         } else { // if comments_popup_script() is not in the template, display simple comment link
1002                 if ( 0 == $number )
1003                         echo get_permalink() . '#respond';
1004                 else
1005                         comments_link();
1006                 echo '"';
1007         }
1008
1009         if ( !empty( $css_class ) ) {
1010                 echo ' class="'.$css_class.'" ';
1011         }
1012         $title = the_title_attribute( array('echo' => 0 ) );
1013
1014         echo apply_filters( 'comments_popup_link_attributes', '' );
1015
1016         echo ' title="' . esc_attr( sprintf( __('Comment on %s'), $title ) ) . '">';
1017         comments_number( $zero, $one, $more );
1018         echo '</a>';
1019 }
1020
1021 /**
1022  * Retrieve HTML content for reply to comment link.
1023  *
1024  * The default arguments that can be override are 'add_below', 'respond_id',
1025  * 'reply_text', 'login_text', and 'depth'. The 'login_text' argument will be
1026  * used, if the user must log in or register first before posting a comment. The
1027  * 'reply_text' will be used, if they can post a reply. The 'add_below' and
1028  * 'respond_id' arguments are for the JavaScript moveAddCommentForm() function
1029  * parameters.
1030  *
1031  * @since 2.7.0
1032  *
1033  * @param array $args Optional. Override default options.
1034  * @param int $comment Optional. Comment being replied to.
1035  * @param int $post Optional. Post that the comment is going to be displayed on.
1036  * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1037  */
1038 function get_comment_reply_link($args = array(), $comment = null, $post = null) {
1039         global $user_ID;
1040
1041         $defaults = array('add_below' => 'comment', 'respond_id' => 'respond', 'reply_text' => __('Reply'),
1042                 'login_text' => __('Log in to Reply'), 'depth' => 0, 'before' => '', 'after' => '');
1043
1044         $args = wp_parse_args($args, $defaults);
1045
1046         if ( 0 == $args['depth'] || $args['max_depth'] <= $args['depth'] )
1047                 return;
1048
1049         extract($args, EXTR_SKIP);
1050
1051         $comment = get_comment($comment);
1052         if ( empty($post) )
1053                 $post = $comment->comment_post_ID;
1054         $post = get_post($post);
1055
1056         if ( !comments_open($post->ID) )
1057                 return false;
1058
1059         $link = '';
1060
1061         if ( get_option('comment_registration') && !$user_ID )
1062                 $link = '<a rel="nofollow" class="comment-reply-login" href="' . esc_url( wp_login_url( get_permalink() ) ) . '">' . $login_text . '</a>';
1063         else
1064                 $link = "<a rel='nofollow' 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>";
1065         return apply_filters('comment_reply_link', $before . $link . $after, $args, $comment, $post);
1066 }
1067
1068 /**
1069  * Displays the HTML content for reply to comment link.
1070  *
1071  * @since 2.7.0
1072  * @see get_comment_reply_link() Echoes result
1073  *
1074  * @param array $args Optional. Override default options.
1075  * @param int $comment Optional. Comment being replied to.
1076  * @param int $post Optional. Post that the comment is going to be displayed on.
1077  * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1078  */
1079 function comment_reply_link($args = array(), $comment = null, $post = null) {
1080         echo get_comment_reply_link($args, $comment, $post);
1081 }
1082
1083 /**
1084  * Retrieve HTML content for reply to post link.
1085  *
1086  * The default arguments that can be override are 'add_below', 'respond_id',
1087  * 'reply_text', 'login_text', and 'depth'. The 'login_text' argument will be
1088  * used, if the user must log in or register first before posting a comment. The
1089  * 'reply_text' will be used, if they can post a reply. The 'add_below' and
1090  * 'respond_id' arguments are for the JavaScript moveAddCommentForm() function
1091  * parameters.
1092  *
1093  * @since 2.7.0
1094  *
1095  * @param array $args Optional. Override default options.
1096  * @param int|object $post Optional. Post that the comment is going to be displayed on.  Defaults to current post.
1097  * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1098  */
1099 function get_post_reply_link($args = array(), $post = null) {
1100         global $user_ID;
1101
1102         $defaults = array('add_below' => 'post', 'respond_id' => 'respond', 'reply_text' => __('Leave a Comment'),
1103                 'login_text' => __('Log in to leave a Comment'), 'before' => '', 'after' => '');
1104
1105         $args = wp_parse_args($args, $defaults);
1106         extract($args, EXTR_SKIP);
1107         $post = get_post($post);
1108
1109         if ( !comments_open($post->ID) )
1110                 return false;
1111
1112         if ( get_option('comment_registration') && !$user_ID ) {
1113                 $link = '<a rel="nofollow" href="' . wp_login_url( get_permalink() ) . '">' . $login_text . '</a>';
1114         } else {
1115                 $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>";
1116         }
1117         return apply_filters('post_comments_link', $before . $link . $after, $post);
1118 }
1119
1120 /**
1121  * Displays the HTML content for reply to post link.
1122  * @since 2.7.0
1123  * @see get_post_reply_link()
1124  *
1125  * @param array $args Optional. Override default options.
1126  * @param int|object $post Optional. Post that the comment is going to be displayed on.
1127  * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1128  */
1129 function post_reply_link($args = array(), $post = null) {
1130         echo get_post_reply_link($args, $post);
1131 }
1132
1133 /**
1134  * Retrieve HTML content for cancel comment reply link.
1135  *
1136  * @since 2.7.0
1137  *
1138  * @param string $text Optional. Text to display for cancel reply link.
1139  */
1140 function get_cancel_comment_reply_link($text = '') {
1141         if ( empty($text) )
1142                 $text = __('Click here to cancel reply.');
1143
1144         $style = isset($_GET['replytocom']) ? '' : ' style="display:none;"';
1145         $link = esc_html( remove_query_arg('replytocom') ) . '#respond';
1146         return apply_filters('cancel_comment_reply_link', '<a rel="nofollow" id="cancel-comment-reply-link" href="' . $link . '"' . $style . '>' . $text . '</a>', $link, $text);
1147 }
1148
1149 /**
1150  * Display HTML content for cancel comment reply link.
1151  *
1152  * @since 2.7.0
1153  *
1154  * @param string $text Optional. Text to display for cancel reply link.
1155  */
1156 function cancel_comment_reply_link($text = '') {
1157         echo get_cancel_comment_reply_link($text);
1158 }
1159
1160 /**
1161  * Retrieve hidden input HTML for replying to comments.
1162  *
1163  * @since 3.0.0
1164  *
1165  * @return string Hidden input HTML for replying to comments
1166  */
1167 function get_comment_id_fields() {
1168         global $id;
1169
1170         $replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
1171         $result  = "<input type='hidden' name='comment_post_ID' value='$id' id='comment_post_ID' />\n";
1172         $result .= "<input type='hidden' name='comment_parent' id='comment_parent' value='$replytoid' />\n";
1173         return apply_filters('comment_id_fields', $result, $id, $replytoid);
1174 }
1175
1176 /**
1177  * Output hidden input HTML for replying to comments.
1178  *
1179  * @since 2.7.0
1180  * @see get_comment_id_fields() Echoes result
1181  */
1182 function comment_id_fields() {
1183         echo get_comment_id_fields();
1184 }
1185
1186 /**
1187  * Display text based on comment reply status. Only affects users with Javascript disabled.
1188  *
1189  * @since 2.7.0
1190  *
1191  * @param string $noreplytext Optional. Text to display when not replying to a comment.
1192  * @param string $replytext Optional. Text to display when replying to a comment. Accepts "%s" for the author of the comment being replied to.
1193  * @param string $linktoparent Optional. Boolean to control making the author's name a link to their comment.
1194  */
1195 function comment_form_title( $noreplytext = false, $replytext = false, $linktoparent = TRUE ) {
1196         global $comment;
1197
1198         if ( false === $noreplytext ) $noreplytext = __( 'Leave a Reply' );
1199         if ( false === $replytext ) $replytext = __( 'Leave a Reply to %s' );
1200
1201         $replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
1202
1203         if ( 0 == $replytoid )
1204                 echo $noreplytext;
1205         else {
1206                 $comment = get_comment($replytoid);
1207                 $author = ( $linktoparent ) ? '<a href="#comment-' . get_comment_ID() . '">' . get_comment_author() . '</a>' : get_comment_author();
1208                 printf( $replytext, $author );
1209         }
1210 }
1211
1212 /**
1213  * HTML comment list class.
1214  *
1215  * @package WordPress
1216  * @uses Walker
1217  * @since unknown
1218  */
1219 class Walker_Comment extends Walker {
1220         /**
1221          * @see Walker::$tree_type
1222          * @since unknown
1223          * @var string
1224          */
1225         var $tree_type = 'comment';
1226
1227         /**
1228          * @see Walker::$db_fields
1229          * @since unknown
1230          * @var array
1231          */
1232         var $db_fields = array ('parent' => 'comment_parent', 'id' => 'comment_ID');
1233
1234         /**
1235          * @see Walker::start_lvl()
1236          * @since unknown
1237          *
1238          * @param string $output Passed by reference. Used to append additional content.
1239          * @param int $depth Depth of comment.
1240          * @param array $args Uses 'style' argument for type of HTML list.
1241          */
1242         function start_lvl(&$output, $depth, $args) {
1243                 $GLOBALS['comment_depth'] = $depth + 1;
1244
1245                 switch ( $args['style'] ) {
1246                         case 'div':
1247                                 break;
1248                         case 'ol':
1249                                 echo "<ol class='children'>\n";
1250                                 break;
1251                         default:
1252                         case 'ul':
1253                                 echo "<ul class='children'>\n";
1254                                 break;
1255                 }
1256         }
1257
1258         /**
1259          * @see Walker::end_lvl()
1260          * @since unknown
1261          *
1262          * @param string $output Passed by reference. Used to append additional content.
1263          * @param int $depth Depth of comment.
1264          * @param array $args Will only append content if style argument value is 'ol' or 'ul'.
1265          */
1266         function end_lvl(&$output, $depth, $args) {
1267                 $GLOBALS['comment_depth'] = $depth + 1;
1268
1269                 switch ( $args['style'] ) {
1270                         case 'div':
1271                                 break;
1272                         case 'ol':
1273                                 echo "</ol>\n";
1274                                 break;
1275                         default:
1276                         case 'ul':
1277                                 echo "</ul>\n";
1278                                 break;
1279                 }
1280         }
1281
1282         /**
1283          * This function is designed to enhance Walker::display_element() to
1284          * display children of higher nesting levels than selected inline on
1285          * the highest depth level displayed. This prevents them being orphaned
1286          * at the end of the comment list.
1287          *
1288          * Example: max_depth = 2, with 5 levels of nested content.
1289          * 1
1290          *  1.1
1291          *    1.1.1
1292          *    1.1.1.1
1293          *    1.1.1.1.1
1294          *    1.1.2
1295          *    1.1.2.1
1296          * 2
1297          *  2.2
1298          *
1299          */
1300         function display_element( $element, &$children_elements, $max_depth, $depth=0, $args, &$output ) {
1301
1302                 if ( !$element )
1303                         return;
1304
1305                 $id_field = $this->db_fields['id'];
1306                 $id = $element->$id_field;
1307
1308                 parent::display_element( $element, $children_elements, $max_depth, $depth, $args, $output );
1309
1310                 // If we're at the max depth, and the current element still has children, loop over those and display them at this level
1311                 // This is to prevent them being orphaned to the end of the list.
1312                 if ( $max_depth <= $depth + 1 && isset( $children_elements[$id]) ) {
1313                         foreach ( $children_elements[ $id ] as $child )
1314                                 $this->display_element( $child, $children_elements, $max_depth, $depth, $args, $output );
1315
1316                         unset( $children_elements[ $id ] );
1317                 }
1318
1319         }
1320
1321         /**
1322          * @see Walker::start_el()
1323          * @since unknown
1324          *
1325          * @param string $output Passed by reference. Used to append additional content.
1326          * @param object $comment Comment data object.
1327          * @param int $depth Depth of comment in reference to parents.
1328          * @param array $args
1329          */
1330         function start_el(&$output, $comment, $depth, $args) {
1331                 $depth++;
1332                 $GLOBALS['comment_depth'] = $depth;
1333
1334                 if ( !empty($args['callback']) ) {
1335                         call_user_func($args['callback'], $comment, $args, $depth);
1336                         return;
1337                 }
1338
1339                 $GLOBALS['comment'] = $comment;
1340                 extract($args, EXTR_SKIP);
1341
1342                 if ( 'div' == $args['style'] ) {
1343                         $tag = 'div';
1344                         $add_below = 'comment';
1345                 } else {
1346                         $tag = 'li';
1347                         $add_below = 'div-comment';
1348                 }
1349 ?>
1350                 <<?php echo $tag ?> <?php comment_class(empty( $args['has_children'] ) ? '' : 'parent') ?> id="comment-<?php comment_ID() ?>">
1351                 <?php if ( 'div' != $args['style'] ) : ?>
1352                 <div id="div-comment-<?php comment_ID() ?>" class="comment-body">
1353                 <?php endif; ?>
1354                 <div class="comment-author vcard">
1355                 <?php if ($args['avatar_size'] != 0) echo get_avatar( $comment, $args['avatar_size'] ); ?>
1356                 <?php printf(__('<cite class="fn">%s</cite> <span class="says">says:</span>'), get_comment_author_link()) ?>
1357                 </div>
1358 <?php if ($comment->comment_approved == '0') : ?>
1359                 <em><?php _e('Your comment is awaiting moderation.') ?></em>
1360                 <br />
1361 <?php endif; ?>
1362
1363                 <div class="comment-meta commentmetadata"><a href="<?php echo htmlspecialchars( get_comment_link( $comment->comment_ID ) ) ?>">
1364                         <?php
1365                                 /* translators: 1: date, 2: time */
1366                                 printf( __('%1$s at %2$s'), get_comment_date(),  get_comment_time()) ?></a><?php edit_comment_link(__('(Edit)'),'&nbsp;&nbsp;','' );
1367                         ?>
1368                 </div>
1369
1370                 <?php comment_text() ?>
1371
1372                 <div class="reply">
1373                 <?php comment_reply_link(array_merge( $args, array('add_below' => $add_below, 'depth' => $depth, 'max_depth' => $args['max_depth']))) ?>
1374                 </div>
1375                 <?php if ( 'div' != $args['style'] ) : ?>
1376                 </div>
1377                 <?php endif; ?>
1378 <?php
1379         }
1380
1381         /**
1382          * @see Walker::end_el()
1383          * @since unknown
1384          *
1385          * @param string $output Passed by reference. Used to append additional content.
1386          * @param object $comment
1387          * @param int $depth Depth of comment.
1388          * @param array $args
1389          */
1390         function end_el(&$output, $comment, $depth, $args) {
1391                 if ( !empty($args['end-callback']) ) {
1392                         call_user_func($args['end-callback'], $comment, $args, $depth);
1393                         return;
1394                 }
1395                 if ( 'div' == $args['style'] )
1396                         echo "</div>\n";
1397                 else
1398                         echo "</li>\n";
1399         }
1400
1401 }
1402
1403 /**
1404  * List comments
1405  *
1406  * Used in the comments.php template to list comments for a particular post
1407  *
1408  * @since 2.7.0
1409  * @uses Walker_Comment
1410  *
1411  * @param string|array $args Formatting options
1412  * @param array $comments Optional array of comment objects.  Defaults to $wp_query->comments
1413  */
1414 function wp_list_comments($args = array(), $comments = null ) {
1415         global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop;
1416
1417         $in_comment_loop = true;
1418
1419         $comment_alt = $comment_thread_alt = 0;
1420         $comment_depth = 1;
1421
1422         $defaults = array('walker' => null, 'max_depth' => '', 'style' => 'ul', 'callback' => null, 'end-callback' => null, 'type' => 'all',
1423                 'page' => '', 'per_page' => '', 'avatar_size' => 32, 'reverse_top_level' => null, 'reverse_children' => '');
1424
1425         $r = wp_parse_args( $args, $defaults );
1426
1427         // Figure out what comments we'll be looping through ($_comments)
1428         if ( null !== $comments ) {
1429                 $comments = (array) $comments;
1430                 if ( empty($comments) )
1431                         return;
1432                 if ( 'all' != $r['type'] ) {
1433                         $comments_by_type = &separate_comments($comments);
1434                         if ( empty($comments_by_type[$r['type']]) )
1435                                 return;
1436                         $_comments = $comments_by_type[$r['type']];
1437                 } else {
1438                         $_comments = $comments;
1439                 }
1440         } else {
1441                 if ( empty($wp_query->comments) )
1442                         return;
1443                 if ( 'all' != $r['type'] ) {
1444                         if ( empty($wp_query->comments_by_type) )
1445                                 $wp_query->comments_by_type = &separate_comments($wp_query->comments);
1446                         if ( empty($wp_query->comments_by_type[$r['type']]) )
1447                                 return;
1448                         $_comments = $wp_query->comments_by_type[$r['type']];
1449                 } else {
1450                         $_comments = $wp_query->comments;
1451                 }
1452         }
1453
1454         if ( '' === $r['per_page'] && get_option('page_comments') )
1455                 $r['per_page'] = get_query_var('comments_per_page');
1456
1457         if ( empty($r['per_page']) ) {
1458                 $r['per_page'] = 0;
1459                 $r['page'] = 0;
1460         }
1461
1462         if ( '' === $r['max_depth'] ) {
1463                 if ( get_option('thread_comments') )
1464                         $r['max_depth'] = get_option('thread_comments_depth');
1465                 else
1466                         $r['max_depth'] = -1;
1467         }
1468
1469         if ( '' === $r['page'] ) {
1470                 if ( empty($overridden_cpage) ) {
1471                         $r['page'] = get_query_var('cpage');
1472                 } else {
1473                         $threaded = ( -1 != $r['max_depth'] );
1474                         $r['page'] = ( 'newest' == get_option('default_comments_page') ) ? get_comment_pages_count($_comments, $r['per_page'], $threaded) : 1;
1475                         set_query_var( 'cpage', $r['page'] );
1476                 }
1477         }
1478         // Validation check
1479         $r['page'] = intval($r['page']);
1480         if ( 0 == $r['page'] && 0 != $r['per_page'] )
1481                 $r['page'] = 1;
1482
1483         if ( null === $r['reverse_top_level'] )
1484                 $r['reverse_top_level'] = ( 'desc' == get_option('comment_order') );
1485
1486         extract( $r, EXTR_SKIP );
1487
1488         if ( empty($walker) )
1489                 $walker = new Walker_Comment;
1490
1491         $walker->paged_walk($_comments, $max_depth, $page, $per_page, $r);
1492         $wp_query->max_num_comment_pages = $walker->max_pages;
1493
1494         $in_comment_loop = false;
1495 }
1496
1497 /**
1498  * Outputs a complete commenting form for use within a template.
1499  * Most strings and form fields may be controlled through the $args array passed
1500  * into the function, while you may also choose to use the comment_form_default_fields
1501  * filter to modify the array of default fields if you'd just like to add a new
1502  * one or remove a single field. All fields are also individually passed through
1503  * a filter of the form comment_form_field_$name where $name is the key used
1504  * in the array of fields.
1505  *
1506  * @since 3.0.0
1507  * @param array $args Options for strings, fields etc in the form
1508  * @param mixed $post_id Post ID to generate the form for, uses the current post if null
1509  * @return void
1510  */
1511 function comment_form( $args = array(), $post_id = null ) {
1512         global $user_identity, $id;
1513
1514         if ( null === $post_id )
1515                 $post_id = $id;
1516         else
1517                 $id = $post_id;
1518
1519         $commenter = wp_get_current_commenter();
1520
1521         $req = get_option( 'require_name_email' );
1522         $aria_req = ( $req ? " aria-required='true'" : '' );
1523         $fields =  array(
1524                 'author' => '<p class="comment-form-author">' . '<label for="author">' . __( 'Name' ) . '</label> ' . ( $req ? '<span class="required">*</span>' : '' ) .
1525                             '<input id="author" name="author" type="text" value="' . esc_attr( $commenter['comment_author'] ) . '" size="30"' . $aria_req . ' /></p>',
1526                 'email'  => '<p class="comment-form-email"><label for="email">' . __( 'Email' ) . '</label> ' . ( $req ? '<span class="required">*</span>' : '' ) .
1527                             '<input id="email" name="email" type="text" value="' . esc_attr(  $commenter['comment_author_email'] ) . '" size="30"' . $aria_req . ' /></p>',
1528                 'url'    => '<p class="comment-form-url"><label for="url">' . __( 'Website' ) . '</label>' .
1529                             '<input id="url" name="url" type="text" value="' . esc_attr( $commenter['comment_author_url'] ) . '" size="30" /></p>',
1530         );
1531
1532         $required_text = sprintf( ' ' . __('Required fields are marked %s'), '<span class="required">*</span>' );
1533         $defaults = array(
1534                 'fields'               => apply_filters( 'comment_form_default_fields', $fields ),
1535                 '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>',
1536                 '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>',
1537                 '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>' ), admin_url( 'profile.php' ), $user_identity, wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '</p>',
1538                 'comment_notes_before' => '<p class="comment-notes">' . __( 'Your email address will not be published.' ) . ( $req ? $required_text : '' ) . '</p>',
1539                 '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>',
1540                 'id_form'              => 'commentform',
1541                 'id_submit'            => 'submit',
1542                 'title_reply'          => __( 'Leave a Reply' ),
1543                 'title_reply_to'       => __( 'Leave a Reply to %s' ),
1544                 'cancel_reply_link'    => __( 'Cancel reply' ),
1545                 'label_submit'         => __( 'Post Comment' ),
1546         );
1547
1548         $args = wp_parse_args( $args, apply_filters( 'comment_form_defaults', $defaults ) );
1549
1550         ?>
1551                 <?php if ( comments_open() ) : ?>
1552                         <?php do_action( 'comment_form_before' ); ?>
1553                         <div id="respond">
1554                                 <h3 id="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>
1555                                 <?php if ( get_option( 'comment_registration' ) && !is_user_logged_in() ) : ?>
1556                                         <?php echo $args['must_log_in']; ?>
1557                                         <?php do_action( 'comment_form_must_log_in_after' ); ?>
1558                                 <?php else : ?>
1559                                         <form action="<?php echo site_url( '/wp-comments-post.php' ); ?>" method="post" id="<?php echo esc_attr( $args['id_form'] ); ?>">
1560                                                 <?php do_action( 'comment_form_top' ); ?>
1561                                                 <?php if ( is_user_logged_in() ) : ?>
1562                                                         <?php echo apply_filters( 'comment_form_logged_in', $args['logged_in_as'], $commenter, $user_identity ); ?>
1563                                                         <?php do_action( 'comment_form_logged_in_after', $commenter, $user_identity ); ?>
1564                                                 <?php else : ?>
1565                                                         <?php echo $args['comment_notes_before']; ?>
1566                                                         <?php
1567                                                         do_action( 'comment_form_before_fields' );
1568                                                         foreach ( (array) $args['fields'] as $name => $field ) {
1569                                                                 echo apply_filters( "comment_form_field_{$name}", $field ) . "\n";
1570                                                         }
1571                                                         do_action( 'comment_form_after_fields' );
1572                                                         ?>
1573                                                 <?php endif; ?>
1574                                                 <?php echo apply_filters( 'comment_form_field_comment', $args['comment_field'] ); ?>
1575                                                 <?php echo $args['comment_notes_after']; ?>
1576                                                 <p class="form-submit">
1577                                                         <input name="submit" type="submit" id="<?php echo esc_attr( $args['id_submit'] ); ?>" value="<?php echo esc_attr( $args['label_submit'] ); ?>" />
1578                                                         <?php comment_id_fields(); ?>
1579                                                 </p>
1580                                                 <?php do_action( 'comment_form', $post_id ); ?>
1581                                         </form>
1582                                 <?php endif; ?>
1583                         </div><!-- #respond -->
1584                         <?php do_action( 'comment_form_after' ); ?>
1585                 <?php else : ?>
1586                         <?php do_action( 'comment_form_comments_closed' ); ?>
1587                 <?php endif; ?>
1588         <?php
1589 }
1590
1591 ?>