[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

title

Body

[close]

/wp-includes/ -> comment-template.php (source)

   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 '...' 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      $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      global $post;
 814  
 815      $post_id = 0;
 816      if ( !empty($post) )
 817          $post_id = $post->ID;
 818  
 819      if ( current_user_can('unfiltered_html') )
 820          wp_nonce_field('unfiltered-html-comment_' . $post_id, '_wp_unfiltered_html_comment', false);
 821  }
 822  
 823  /**
 824   * Loads the comment template specified in $file.
 825   *
 826   * Will not display the comments template if not on single post or page, or if
 827   * the post does not have comments.
 828   *
 829   * Uses the WordPress database object to query for the comments. The comments
 830   * are passed through the 'comments_array' filter hook with the list of comments
 831   * and the post ID respectively.
 832   *
 833   * The $file path is passed through a filter hook called, 'comments_template'
 834   * which includes the TEMPLATEPATH and $file combined. Tries the $filtered path
 835   * first and if it fails it will require the default comment template from the
 836   * default theme. If either does not exist, then the WordPress process will be
 837   * halted. It is advised for that reason, that the default theme is not deleted.
 838   *
 839   * @since 1.5.0
 840   * @global array $comment List of comment objects for the current post
 841   * @uses $wpdb
 842   * @uses $post
 843   * @uses $withcomments Will not try to get the comments if the post has none.
 844   *
 845   * @param string $file Optional, default '/comments.php'. The file to load
 846   * @param bool $separate_comments Optional, whether to separate the comments by comment type. Default is false.
 847   * @return null Returns null if no comments appear
 848   */
 849  function comments_template( $file = '/comments.php', $separate_comments = false ) {
 850      global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_ID, $user_identity, $overridden_cpage;
 851  
 852      if ( !(is_single() || is_page() || $withcomments) || empty($post) )
 853          return;
 854  
 855      if ( empty($file) )
 856          $file = '/comments.php';
 857  
 858      $req = get_option('require_name_email');
 859  
 860      /**
 861       * Comment author information fetched from the comment cookies.
 862       *
 863       * @uses wp_get_current_commenter()
 864       */
 865      $commenter = wp_get_current_commenter();
 866  
 867      /**
 868       * The name of the current comment author escaped for use in attributes.
 869       */
 870      $comment_author = $commenter['comment_author']; // Escaped by sanitize_comment_cookies()
 871  
 872      /**
 873       * The email address of the current comment author escaped for use in attributes.
 874       */
 875      $comment_author_email = $commenter['comment_author_email'];  // Escaped by sanitize_comment_cookies()
 876  
 877      /**
 878       * The url of the current comment author escaped for use in attributes.
 879       */
 880      $comment_author_url = esc_url($commenter['comment_author_url']);
 881  
 882      /** @todo Use API instead of SELECTs. */
 883      if ( $user_ID) {
 884          $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));
 885      } else if ( empty($comment_author) ) {
 886          $comments = get_comments( array('post_id' => $post->ID, 'status' => 'approve', 'order' => 'ASC') );
 887      } else {
 888          $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));
 889      }
 890  
 891      // keep $comments for legacy's sake
 892      $wp_query->comments = apply_filters( 'comments_array', $comments, $post->ID );
 893      $comments = &$wp_query->comments;
 894      $wp_query->comment_count = count($wp_query->comments);
 895      update_comment_cache($wp_query->comments);
 896  
 897      if ( $separate_comments ) {
 898          $wp_query->comments_by_type = &separate_comments($comments);
 899          $comments_by_type = &$wp_query->comments_by_type;
 900      }
 901  
 902      $overridden_cpage = false;
 903      if ( '' == get_query_var('cpage') && get_option('page_comments') ) {
 904          set_query_var( 'cpage', 'newest' == get_option('default_comments_page') ? get_comment_pages_count() : 1 );
 905          $overridden_cpage = true;
 906      }
 907  
 908      if ( !defined('COMMENTS_TEMPLATE') || !COMMENTS_TEMPLATE)
 909          define('COMMENTS_TEMPLATE', true);
 910  
 911      $include = apply_filters('comments_template', STYLESHEETPATH . $file );
 912      if ( file_exists( $include ) )
 913          require( $include );
 914      elseif ( file_exists( TEMPLATEPATH . $file ) )
 915          require( TEMPLATEPATH . $file );
 916      else // Backward compat code will be removed in a future release
 917          require ( ABSPATH . WPINC . '/theme-compat/comments.php');
 918  }
 919  
 920  /**
 921   * Displays the JS popup script to show a comment.
 922   *
 923   * If the $file parameter is empty, then the home page is assumed. The defaults
 924   * for the window are 400px by 400px.
 925   *
 926   * For the comment link popup to work, this function has to be called or the
 927   * normal comment link will be assumed.
 928   *
 929   * @since 0.71
 930   * @global string $wpcommentspopupfile The URL to use for the popup window
 931   * @global int $wpcommentsjavascript Whether to use JavaScript. Set when function is called
 932   *
 933   * @param int $width Optional. The width of the popup window
 934   * @param int $height Optional. The height of the popup window
 935   * @param string $file Optional. Sets the location of the popup window
 936   */
 937  function comments_popup_script($width=400, $height=400, $file='') {
 938      global $wpcommentspopupfile, $wpcommentsjavascript;
 939  
 940      if (empty ($file)) {
 941          $wpcommentspopupfile = '';  // Use the index.
 942      } else {
 943          $wpcommentspopupfile = $file;
 944      }
 945  
 946      $wpcommentsjavascript = 1;
 947      $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";
 948      echo $javascript;
 949  }
 950  
 951  /**
 952   * Displays the link to the comments popup window for the current post ID.
 953   *
 954   * Is not meant to be displayed on single posts and pages. Should be used on the
 955   * lists of posts
 956   *
 957   * @since 0.71
 958   * @uses $wpcommentspopupfile
 959   * @uses $wpcommentsjavascript
 960   * @uses $post
 961   *
 962   * @param string $zero The string to display when no comments
 963   * @param string $one The string to display when only one comment is available
 964   * @param string $more The string to display when there are more than one comment
 965   * @param string $css_class The CSS class to use for comments
 966   * @param string $none The string to display when comments have been turned off
 967   * @return null Returns null on single posts and pages.
 968   */
 969  function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) {
 970      global $wpcommentspopupfile, $wpcommentsjavascript;
 971  
 972      $id = get_the_ID();
 973  
 974      if ( false === $zero ) $zero = __( 'No Comments' );
 975      if ( false === $one ) $one = __( '1 Comment' );
 976      if ( false === $more ) $more = __( '% Comments' );
 977      if ( false === $none ) $none = __( 'Comments Off' );
 978  
 979      $number = get_comments_number( $id );
 980  
 981      if ( 0 == $number && !comments_open() && !pings_open() ) {
 982          echo '<span' . ((!empty($css_class)) ? ' class="' . esc_attr( $css_class ) . '"' : '') . '>' . $none . '</span>';
 983          return;
 984      }
 985  
 986      if ( post_password_required() ) {
 987          echo __('Enter your password to view comments.');
 988          return;
 989      }
 990  
 991      echo '<a href="';
 992      if ( $wpcommentsjavascript ) {
 993          if ( empty( $wpcommentspopupfile ) )
 994              $home = home_url();
 995          else
 996              $home = get_option('siteurl');
 997          echo $home . '/' . $wpcommentspopupfile . '?comments_popup=' . $id;
 998          echo '" onclick="wpopen(this.href); return false"';
 999      } else { // if comments_popup_script() is not in the template, display simple comment link
1000          if ( 0 == $number )
1001              echo get_permalink() . '#respond';
1002          else
1003              comments_link();
1004          echo '"';
1005      }
1006  
1007      if ( !empty( $css_class ) ) {
1008          echo ' class="'.$css_class.'" ';
1009      }
1010      $title = the_title_attribute( array('echo' => 0 ) );
1011  
1012      echo apply_filters( 'comments_popup_link_attributes', '' );
1013  
1014      echo ' title="' . esc_attr( sprintf( __('Comment on %s'), $title ) ) . '">';
1015      comments_number( $zero, $one, $more );
1016      echo '</a>';
1017  }
1018  
1019  /**
1020   * Retrieve HTML content for reply to comment link.
1021   *
1022   * The default arguments that can be override are 'add_below', 'respond_id',
1023   * 'reply_text', 'login_text', and 'depth'. The 'login_text' argument will be
1024   * used, if the user must log in or register first before posting a comment. The
1025   * 'reply_text' will be used, if they can post a reply. The 'add_below' and
1026   * 'respond_id' arguments are for the JavaScript moveAddCommentForm() function
1027   * parameters.
1028   *
1029   * @since 2.7.0
1030   *
1031   * @param array $args Optional. Override default options.
1032   * @param int $comment Optional. Comment being replied to.
1033   * @param int $post Optional. Post that the comment is going to be displayed on.
1034   * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1035   */
1036  function get_comment_reply_link($args = array(), $comment = null, $post = null) {
1037      global $user_ID;
1038  
1039      $defaults = array('add_below' => 'comment', 'respond_id' => 'respond', 'reply_text' => __('Reply'),
1040          'login_text' => __('Log in to Reply'), 'depth' => 0, 'before' => '', 'after' => '');
1041  
1042      $args = wp_parse_args($args, $defaults);
1043  
1044      if ( 0 == $args['depth'] || $args['max_depth'] <= $args['depth'] )
1045          return;
1046  
1047      extract($args, EXTR_SKIP);
1048  
1049      $comment = get_comment($comment);
1050      if ( empty($post) )
1051          $post = $comment->comment_post_ID;
1052      $post = get_post($post);
1053  
1054      if ( !comments_open($post->ID) )
1055          return false;
1056  
1057      $link = '';
1058  
1059      if ( get_option('comment_registration') && !$user_ID )
1060          $link = '<a rel="nofollow" class="comment-reply-login" href="' . esc_url( wp_login_url( get_permalink() ) ) . '">' . $login_text . '</a>';
1061      else
1062          $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>";
1063      return apply_filters('comment_reply_link', $before . $link . $after, $args, $comment, $post);
1064  }
1065  
1066  /**
1067   * Displays the HTML content for reply to comment link.
1068   *
1069   * @since 2.7.0
1070   * @see get_comment_reply_link() Echoes result
1071   *
1072   * @param array $args Optional. Override default options.
1073   * @param int $comment Optional. Comment being replied to.
1074   * @param int $post Optional. Post that the comment is going to be displayed on.
1075   * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1076   */
1077  function comment_reply_link($args = array(), $comment = null, $post = null) {
1078      echo get_comment_reply_link($args, $comment, $post);
1079  }
1080  
1081  /**
1082   * Retrieve HTML content for reply to post link.
1083   *
1084   * The default arguments that can be override are 'add_below', 'respond_id',
1085   * 'reply_text', 'login_text', and 'depth'. The 'login_text' argument will be
1086   * used, if the user must log in or register first before posting a comment. The
1087   * 'reply_text' will be used, if they can post a reply. The 'add_below' and
1088   * 'respond_id' arguments are for the JavaScript moveAddCommentForm() function
1089   * parameters.
1090   *
1091   * @since 2.7.0
1092   *
1093   * @param array $args Optional. Override default options.
1094   * @param int|object $post Optional. Post that the comment is going to be displayed on. Defaults to current post.
1095   * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1096   */
1097  function get_post_reply_link($args = array(), $post = null) {
1098      global $user_ID;
1099  
1100      $defaults = array('add_below' => 'post', 'respond_id' => 'respond', 'reply_text' => __('Leave a Comment'),
1101          'login_text' => __('Log in to leave a Comment'), 'before' => '', 'after' => '');
1102  
1103      $args = wp_parse_args($args, $defaults);
1104      extract($args, EXTR_SKIP);
1105      $post = get_post($post);
1106  
1107      if ( !comments_open($post->ID) )
1108          return false;
1109  
1110      if ( get_option('comment_registration') && !$user_ID ) {
1111          $link = '<a rel="nofollow" href="' . wp_login_url( get_permalink() ) . '">' . $login_text . '</a>';
1112      } else {
1113          $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>";
1114      }
1115      return apply_filters('post_comments_link', $before . $link . $after, $post);
1116  }
1117  
1118  /**
1119   * Displays the HTML content for reply to post link.
1120   * @since 2.7.0
1121   * @see get_post_reply_link()
1122   *
1123   * @param array $args Optional. Override default options.
1124   * @param int|object $post Optional. Post that the comment is going to be displayed on.
1125   * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1126   */
1127  function post_reply_link($args = array(), $post = null) {
1128      echo get_post_reply_link($args, $post);
1129  }
1130  
1131  /**
1132   * Retrieve HTML content for cancel comment reply link.
1133   *
1134   * @since 2.7.0
1135   *
1136   * @param string $text Optional. Text to display for cancel reply link.
1137   */
1138  function get_cancel_comment_reply_link($text = '') {
1139      if ( empty($text) )
1140          $text = __('Click here to cancel reply.');
1141  
1142      $style = isset($_GET['replytocom']) ? '' : ' style="display:none;"';
1143      $link = esc_html( remove_query_arg('replytocom') ) . '#respond';
1144      return apply_filters('cancel_comment_reply_link', '<a rel="nofollow" id="cancel-comment-reply-link" href="' . $link . '"' . $style . '>' . $text . '</a>', $link, $text);
1145  }
1146  
1147  /**
1148   * Display HTML content for cancel comment reply link.
1149   *
1150   * @since 2.7.0
1151   *
1152   * @param string $text Optional. Text to display for cancel reply link.
1153   */
1154  function cancel_comment_reply_link($text = '') {
1155      echo get_cancel_comment_reply_link($text);
1156  }
1157  
1158  /**
1159   * Retrieve hidden input HTML for replying to comments.
1160   *
1161   * @since 3.0.0
1162   *
1163   * @return string Hidden input HTML for replying to comments
1164   */
1165  function get_comment_id_fields( $id = 0 ) {
1166      if ( empty( $id ) )
1167          $id = get_the_ID();
1168  
1169      $replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
1170      $result  = "<input type='hidden' name='comment_post_ID' value='$id' id='comment_post_ID' />\n";
1171      $result .= "<input type='hidden' name='comment_parent' id='comment_parent' value='$replytoid' />\n";
1172      return apply_filters('comment_id_fields', $result, $id, $replytoid);
1173  }
1174  
1175  /**
1176   * Output hidden input HTML for replying to comments.
1177   *
1178   * @since 2.7.0
1179   * @see get_comment_id_fields() Echoes result
1180   */
1181  function comment_id_fields( $id = 0 ) {
1182      echo get_comment_id_fields( $id );
1183  }
1184  
1185  /**
1186   * Display text based on comment reply status. Only affects users with Javascript disabled.
1187   *
1188   * @since 2.7.0
1189   *
1190   * @param string $noreplytext Optional. Text to display when not replying to a comment.
1191   * @param string $replytext Optional. Text to display when replying to a comment. Accepts "%s" for the author of the comment being replied to.
1192   * @param string $linktoparent Optional. Boolean to control making the author's name a link to their comment.
1193   */
1194  function comment_form_title( $noreplytext = false, $replytext = false, $linktoparent = true ) {
1195      global $comment;
1196  
1197      if ( false === $noreplytext ) $noreplytext = __( 'Leave a Reply' );
1198      if ( false === $replytext ) $replytext = __( 'Leave a Reply to %s' );
1199  
1200      $replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
1201  
1202      if ( 0 == $replytoid )
1203          echo $noreplytext;
1204      else {
1205          $comment = get_comment($replytoid);
1206          $author = ( $linktoparent ) ? '<a href="#comment-' . get_comment_ID() . '">' . get_comment_author() . '</a>' : get_comment_author();
1207          printf( $replytext, $author );
1208      }
1209  }
1210  
1211  /**
1212   * HTML comment list class.
1213   *
1214   * @package WordPress
1215   * @uses Walker
1216   * @since 2.7.0
1217   */
1218  class Walker_Comment extends Walker {
1219      /**
1220       * @see Walker::$tree_type
1221       * @since 2.7.0
1222       * @var string
1223       */
1224      var $tree_type = 'comment';
1225  
1226      /**
1227       * @see Walker::$db_fields
1228       * @since 2.7.0
1229       * @var array
1230       */
1231      var $db_fields = array ('parent' => 'comment_parent', 'id' => 'comment_ID');
1232  
1233      /**
1234       * @see Walker::start_lvl()
1235       * @since 2.7.0
1236       *
1237       * @param string $output Passed by reference. Used to append additional content.
1238       * @param int $depth Depth of comment.
1239       * @param array $args Uses 'style' argument for type of HTML list.
1240       */
1241  	function start_lvl( &$output, $depth = 0, $args = array() ) {
1242          $GLOBALS['comment_depth'] = $depth + 1;
1243  
1244          switch ( $args['style'] ) {
1245              case 'div':
1246                  break;
1247              case 'ol':
1248                  echo "<ol class='children'>\n";
1249                  break;
1250              default:
1251              case 'ul':
1252                  echo "<ul class='children'>\n";
1253                  break;
1254          }
1255      }
1256  
1257      /**
1258       * @see Walker::end_lvl()
1259       * @since 2.7.0
1260       *
1261       * @param string $output Passed by reference. Used to append additional content.
1262       * @param int $depth Depth of comment.
1263       * @param array $args Will only append content if style argument value is 'ol' or 'ul'.
1264       */
1265  	function end_lvl( &$output, $depth = 0, $args = array() ) {
1266          $GLOBALS['comment_depth'] = $depth + 1;
1267  
1268          switch ( $args['style'] ) {
1269              case 'div':
1270                  break;
1271              case 'ol':
1272                  echo "</ol>\n";
1273                  break;
1274              default:
1275              case 'ul':
1276                  echo "</ul>\n";
1277                  break;
1278          }
1279      }
1280  
1281      /**
1282       * This function is designed to enhance Walker::display_element() to
1283       * display children of higher nesting levels than selected inline on
1284       * the highest depth level displayed. This prevents them being orphaned
1285       * at the end of the comment list.
1286       *
1287       * Example: max_depth = 2, with 5 levels of nested content.
1288       * 1
1289       *  1.1
1290       *    1.1.1
1291       *    1.1.1.1
1292       *    1.1.1.1.1
1293       *    1.1.2
1294       *    1.1.2.1
1295       * 2
1296       *  2.2
1297       *
1298       */
1299  	function display_element( $element, &$children_elements, $max_depth, $depth=0, $args, &$output ) {
1300  
1301          if ( !$element )
1302              return;
1303  
1304          $id_field = $this->db_fields['id'];
1305          $id = $element->$id_field;
1306  
1307          parent::display_element( $element, $children_elements, $max_depth, $depth, $args, $output );
1308  
1309          // If we're at the max depth, and the current element still has children, loop over those and display them at this level
1310          // This is to prevent them being orphaned to the end of the list.
1311          if ( $max_depth <= $depth + 1 && isset( $children_elements[$id]) ) {
1312              foreach ( $children_elements[ $id ] as $child )
1313                  $this->display_element( $child, $children_elements, $max_depth, $depth, $args, $output );
1314  
1315              unset( $children_elements[ $id ] );
1316          }
1317  
1318      }
1319  
1320      /**
1321       * @see Walker::start_el()
1322       * @since 2.7.0
1323       *
1324       * @param string $output Passed by reference. Used to append additional content.
1325       * @param object $comment Comment data object.
1326       * @param int $depth Depth of comment in reference to parents.
1327       * @param array $args
1328       */
1329  	function start_el( &$output, $comment, $depth, $args, $id = 0 ) {
1330          $depth++;
1331          $GLOBALS['comment_depth'] = $depth;
1332  
1333          if ( !empty($args['callback']) ) {
1334              call_user_func($args['callback'], $comment, $args, $depth);
1335              return;
1336          }
1337  
1338          $GLOBALS['comment'] = $comment;
1339          extract($args, EXTR_SKIP);
1340  
1341          if ( 'div' == $args['style'] ) {
1342              $tag = 'div';
1343              $add_below = 'comment';
1344          } else {
1345              $tag = 'li';
1346              $add_below = 'div-comment';
1347          }
1348  ?>
1349          <<?php echo $tag ?> <?php comment_class(empty( $args['has_children'] ) ? '' : 'parent') ?> id="comment-<?php comment_ID() ?>">
1350          <?php if ( 'div' != $args['style'] ) : ?>
1351          <div id="div-comment-<?php comment_ID() ?>" class="comment-body">
1352          <?php endif; ?>
1353          <div class="comment-author vcard">
1354          <?php if ($args['avatar_size'] != 0) echo get_avatar( $comment, $args['avatar_size'] ); ?>
1355          <?php printf(__('<cite class="fn">%s</cite> <span class="says">says:</span>'), get_comment_author_link()) ?>
1356          </div>
1357  <?php if ($comment->comment_approved == '0') : ?>
1358          <em class="comment-awaiting-moderation"><?php _e('Your comment is awaiting moderation.') ?></em>
1359          <br />
1360  <?php endif; ?>
1361  
1362          <div class="comment-meta commentmetadata"><a href="<?php echo htmlspecialchars( get_comment_link( $comment->comment_ID ) ) ?>">
1363              <?php
1364                  /* translators: 1: date, 2: time */
1365                  printf( __('%1$s at %2$s'), get_comment_date(),  get_comment_time()) ?></a><?php edit_comment_link(__('(Edit)'),'&nbsp;&nbsp;','' );
1366              ?>
1367          </div>
1368  
1369          <?php comment_text() ?>
1370  
1371          <div class="reply">
1372          <?php comment_reply_link(array_merge( $args, array('add_below' => $add_below, 'depth' => $depth, 'max_depth' => $args['max_depth']))) ?>
1373          </div>
1374          <?php if ( 'div' != $args['style'] ) : ?>
1375          </div>
1376          <?php endif; ?>
1377  <?php
1378      }
1379  
1380      /**
1381       * @see Walker::end_el()
1382       * @since 2.7.0
1383       *
1384       * @param string $output Passed by reference. Used to append additional content.
1385       * @param object $comment
1386       * @param int $depth Depth of comment.
1387       * @param array $args
1388       */
1389  	function end_el(&$output, $comment, $depth = 0, $args = array() ) {
1390          if ( !empty($args['end-callback']) ) {
1391              call_user_func($args['end-callback'], $comment, $args, $depth);
1392              return;
1393          }
1394          if ( 'div' == $args['style'] )
1395              echo "</div>\n";
1396          else
1397              echo "</li>\n";
1398      }
1399  
1400  }
1401  
1402  /**
1403   * List comments
1404   *
1405   * Used in the comments.php template to list comments for a particular post
1406   *
1407   * @since 2.7.0
1408   * @uses Walker_Comment
1409   *
1410   * @param string|array $args Formatting options
1411   * @param array $comments Optional array of comment objects. Defaults to $wp_query->comments
1412   */
1413  function wp_list_comments($args = array(), $comments = null ) {
1414      global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop;
1415  
1416      $in_comment_loop = true;
1417  
1418      $comment_alt = $comment_thread_alt = 0;
1419      $comment_depth = 1;
1420  
1421      $defaults = array('walker' => null, 'max_depth' => '', 'style' => 'ul', 'callback' => null, 'end-callback' => null, 'type' => 'all',
1422          'page' => '', 'per_page' => '', 'avatar_size' => 32, 'reverse_top_level' => null, 'reverse_children' => '');
1423  
1424      $r = wp_parse_args( $args, $defaults );
1425  
1426      // Figure out what comments we'll be looping through ($_comments)
1427      if ( null !== $comments ) {
1428          $comments = (array) $comments;
1429          if ( empty($comments) )
1430              return;
1431          if ( 'all' != $r['type'] ) {
1432              $comments_by_type = &separate_comments($comments);
1433              if ( empty($comments_by_type[$r['type']]) )
1434                  return;
1435              $_comments = $comments_by_type[$r['type']];
1436          } else {
1437              $_comments = $comments;
1438          }
1439      } else {
1440          if ( empty($wp_query->comments) )
1441              return;
1442          if ( 'all' != $r['type'] ) {
1443              if ( empty($wp_query->comments_by_type) )
1444                  $wp_query->comments_by_type = &separate_comments($wp_query->comments);
1445              if ( empty($wp_query->comments_by_type[$r['type']]) )
1446                  return;
1447              $_comments = $wp_query->comments_by_type[$r['type']];
1448          } else {
1449              $_comments = $wp_query->comments;
1450          }
1451      }
1452  
1453      if ( '' === $r['per_page'] && get_option('page_comments') )
1454          $r['per_page'] = get_query_var('comments_per_page');
1455  
1456      if ( empty($r['per_page']) ) {
1457          $r['per_page'] = 0;
1458          $r['page'] = 0;
1459      }
1460  
1461      if ( '' === $r['max_depth'] ) {
1462          if ( get_option('thread_comments') )
1463              $r['max_depth'] = get_option('thread_comments_depth');
1464          else
1465              $r['max_depth'] = -1;
1466      }
1467  
1468      if ( '' === $r['page'] ) {
1469          if ( empty($overridden_cpage) ) {
1470              $r['page'] = get_query_var('cpage');
1471          } else {
1472              $threaded = ( -1 != $r['max_depth'] );
1473              $r['page'] = ( 'newest' == get_option('default_comments_page') ) ? get_comment_pages_count($_comments, $r['per_page'], $threaded) : 1;
1474              set_query_var( 'cpage', $r['page'] );
1475          }
1476      }
1477      // Validation check
1478      $r['page'] = intval($r['page']);
1479      if ( 0 == $r['page'] && 0 != $r['per_page'] )
1480          $r['page'] = 1;
1481  
1482      if ( null === $r['reverse_top_level'] )
1483          $r['reverse_top_level'] = ( 'desc' == get_option('comment_order') );
1484  
1485      extract( $r, EXTR_SKIP );
1486  
1487      if ( empty($walker) )
1488          $walker = new Walker_Comment;
1489  
1490      $walker->paged_walk($_comments, $max_depth, $page, $per_page, $r);
1491      $wp_query->max_num_comment_pages = $walker->max_pages;
1492  
1493      $in_comment_loop = false;
1494  }
1495  
1496  /**
1497   * Outputs a complete commenting form for use within a template.
1498   * Most strings and form fields may be controlled through the $args array passed
1499   * into the function, while you may also choose to use the comment_form_default_fields
1500   * filter to modify the array of default fields if you'd just like to add a new
1501   * one or remove a single field. All fields are also individually passed through
1502   * a filter of the form comment_form_field_$name where $name is the key used
1503   * in the array of fields.
1504   *
1505   * @since 3.0.0
1506   * @param array $args Options for strings, fields etc in the form
1507   * @param mixed $post_id Post ID to generate the form for, uses the current post if null
1508   * @return void
1509   */
1510  function comment_form( $args = array(), $post_id = null ) {
1511      global $id;
1512  
1513      if ( null === $post_id )
1514          $post_id = $id;
1515      else
1516          $id = $post_id;
1517  
1518      $commenter = wp_get_current_commenter();
1519      $user = wp_get_current_user();
1520      $user_identity = $user->exists() ? $user->display_name : '';
1521  
1522      $req = get_option( 'require_name_email' );
1523      $aria_req = ( $req ? " aria-required='true'" : '' );
1524      $fields =  array(
1525          'author' => '<p class="comment-form-author">' . '<label for="author">' . __( 'Name' ) . '</label> ' . ( $req ? '<span class="required">*</span>' : '' ) .
1526                      '<input id="author" name="author" type="text" value="' . esc_attr( $commenter['comment_author'] ) . '" size="30"' . $aria_req . ' /></p>',
1527          'email'  => '<p class="comment-form-email"><label for="email">' . __( 'Email' ) . '</label> ' . ( $req ? '<span class="required">*</span>' : '' ) .
1528                      '<input id="email" name="email" type="text" value="' . esc_attr(  $commenter['comment_author_email'] ) . '" size="30"' . $aria_req . ' /></p>',
1529          'url'    => '<p class="comment-form-url"><label for="url">' . __( 'Website' ) . '</label>' .
1530                      '<input id="url" name="url" type="text" value="' . esc_attr( $commenter['comment_author_url'] ) . '" size="30" /></p>',
1531      );
1532  
1533      $required_text = sprintf( ' ' . __('Required fields are marked %s'), '<span class="required">*</span>' );
1534      $defaults = array(
1535          'fields'               => apply_filters( 'comment_form_default_fields', $fields ),
1536          '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>',
1537          '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>',
1538          '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>',
1539          'comment_notes_before' => '<p class="comment-notes">' . __( 'Your email address will not be published.' ) . ( $req ? $required_text : '' ) . '</p>',
1540          '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>',
1541          'id_form'              => 'commentform',
1542          'id_submit'            => 'submit',
1543          'title_reply'          => __( 'Leave a Reply' ),
1544          'title_reply_to'       => __( 'Leave a Reply to %s' ),
1545          'cancel_reply_link'    => __( 'Cancel reply' ),
1546          'label_submit'         => __( 'Post Comment' ),
1547      );
1548  
1549      $args = wp_parse_args( $args, apply_filters( 'comment_form_defaults', $defaults ) );
1550  
1551      ?>
1552          <?php if ( comments_open( $post_id ) ) : ?>
1553              <?php do_action( 'comment_form_before' ); ?>
1554              <div id="respond">
1555                  <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>
1556                  <?php if ( get_option( 'comment_registration' ) && !is_user_logged_in() ) : ?>
1557                      <?php echo $args['must_log_in']; ?>
1558                      <?php do_action( 'comment_form_must_log_in_after' ); ?>
1559                  <?php else : ?>
1560                      <form action="<?php echo site_url( '/wp-comments-post.php' ); ?>" method="post" id="<?php echo esc_attr( $args['id_form'] ); ?>">
1561                          <?php do_action( 'comment_form_top' ); ?>
1562                          <?php if ( is_user_logged_in() ) : ?>
1563                              <?php echo apply_filters( 'comment_form_logged_in', $args['logged_in_as'], $commenter, $user_identity ); ?>
1564                              <?php do_action( 'comment_form_logged_in_after', $commenter, $user_identity ); ?>
1565                          <?php else : ?>
1566                              <?php echo $args['comment_notes_before']; ?>
1567                              <?php
1568                              do_action( 'comment_form_before_fields' );
1569                              foreach ( (array) $args['fields'] as $name => $field ) {
1570                                  echo apply_filters( "comment_form_field_{$name}", $field ) . "\n";
1571                              }
1572                              do_action( 'comment_form_after_fields' );
1573                              ?>
1574                          <?php endif; ?>
1575                          <?php echo apply_filters( 'comment_form_field_comment', $args['comment_field'] ); ?>
1576                          <?php echo $args['comment_notes_after']; ?>
1577                          <p class="form-submit">
1578                              <input name="submit" type="submit" id="<?php echo esc_attr( $args['id_submit'] ); ?>" value="<?php echo esc_attr( $args['label_submit'] ); ?>" />
1579                              <?php comment_id_fields( $post_id ); ?>
1580                          </p>
1581                          <?php do_action( 'comment_form', $post_id ); ?>
1582                      </form>
1583                  <?php endif; ?>
1584              </div><!-- #respond -->
1585              <?php do_action( 'comment_form_after' ); ?>
1586          <?php else : ?>
1587              <?php do_action( 'comment_form_comments_closed' ); ?>
1588          <?php endif; ?>
1589      <?php
1590  }


Generated: Sat May 26 08:20:01 2012 Cross-referenced by PHPXref 0.7