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  *

    19  * @param int $comment_ID Optional. The ID of the comment for which to retrieve the author. Default current comment.

    20  * @return string The comment author

    21  */

    22 function get_comment_author( $comment_ID = 0 ) {

    23 	$comment = get_comment( $comment_ID );

    24 

    25 	if ( empty( $comment->comment_author ) ) {

    26 		if ( $comment->user_id && $user = get_userdata( $comment->user_id ) )

    27 			$author = $user->display_name;

    28 		else

    29 			$author = __('Anonymous');

    30 	} else {

    31 		$author = $comment->comment_author;

    32 	}

    33 

    34 	/**

    35 	 * Filter the returned comment author name.

    36 	 *

    37 	 * @since 1.5.2

    38 	 *

    39 	 * @param string $author The comment author's username.

    40 	 */

    41 	return apply_filters( 'get_comment_author', $author );

    42 }

    43 

    44 /**

    45  * Displays the author of the current comment.

    46  *

    47  * @since 0.71

    48  *

    49  * @param int $comment_ID Optional. The ID of the comment for which to print the author. Default current comment.

    50  */

    51 function comment_author( $comment_ID = 0 ) {

    52 	$author = get_comment_author( $comment_ID );

    53 	/**

    54 	 * Filter the comment author's name for display.

    55 	 *

    56 	 * @since 1.2.1

    57 	 *

    58 	 * @param string $author The comment author's username.

    59 	 */

    60 	$author = apply_filters( 'comment_author', $author );

    61 	echo $author;

    62 }

    63 

    64 /**

    65  * Retrieve the email of the author of the current comment.

    66  *

    67  * @since 1.5.0

    68  *

    69  * @param int $comment_ID Optional. The ID of the comment for which to get the author's email. Default current comment.

    70  * @return string The current comment author's email

    71  */

    72 function get_comment_author_email( $comment_ID = 0 ) {

    73 	$comment = get_comment( $comment_ID );

    74 	/**

    75 	 * Filter the comment author's returned email address.

    76 	 *

    77 	 * @since 1.5.2

    78 	 *

    79 	 * @param string $comment->comment_author_email The comment author's email address.

    80 	 */

    81 	return apply_filters( 'get_comment_author_email', $comment->comment_author_email );

    82 }

    83 

    84 /**

    85  * Display the email of the author of the current global $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  *

    95  * @param int $comment_ID Optional. The ID of the comment for which to print the author's email. Default current comment.

    96  */

    97 function comment_author_email( $comment_ID = 0 ) {

    98 	$author_email = get_comment_author_email( $comment_ID );

    99 	/**

   100 	 * Filter the comment author's email for display.

   101 	 *

   102 	 * @since 1.2.1

   103 	 *

   104 	 * @param string $author_email The comment author's email address.

   105 	 */

   106 	echo apply_filters( 'author_email', $author_email );

   107 }

   108 

   109 /**

   110  * Display the html email link to the author of the current comment.

   111  *

   112  * Care should be taken to protect the email address and assure that email

   113  * harvesters do not capture your commentors' email address. Most assume that

   114  * their email address will not appear in raw form on the blog. Doing so will

   115  * enable anyone, including those that people don't want to get the email

   116  * address and use it for their own means good and bad.

   117  *

   118  * @global object $comment The current Comment row object

   119 

   120  * @since 0.71

   121  *

   122  * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty.

   123  * @param string $before   Optional. The text or HTML to display before the email link.Default empty.

   124  * @param string $after    Optional. The text or HTML to display after the email link. Default empty.

   125  */

   126 function comment_author_email_link( $linktext = '', $before = '', $after = '' ) {

   127 	if ( $link = get_comment_author_email_link( $linktext, $before, $after ) )

   128 		echo $link;

   129 }

   130 

   131 /**

   132  * Return the html email link to the author of the current comment.

   133  *

   134  * Care should be taken to protect the email address and assure that email

   135  * harvesters do not capture your commentors' email address. Most assume that

   136  * their email address will not appear in raw form on the blog. Doing so will

   137  * enable anyone, including those that people don't want to get the email

   138  * address and use it for their own means good and bad.

   139  *

   140  * @global object $comment The current Comment row object.

   141  *

   142  * @since 2.7

   143  *

   144  * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty.

   145  * @param string $before   Optional. The text or HTML to display before the email link. Default empty.

   146  * @param string $after    Optional. The text or HTML to display after the email link. Default empty.

   147  */

   148 function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) {

   149 	global $comment;

   150 	/**

   151 	 * Filter the comment author's email for display.

   152 	 *

   153 	 * Care should be taken to protect the email address and assure that email

   154 	 * harvesters do not capture your commentors' email address.

   155 	 *

   156 	 * @since 1.2.1

   157 	 *

   158 	 * @param string $comment->comment_author_email The comment author's email address.

   159 	 */

   160 	$email = apply_filters( 'comment_email', $comment->comment_author_email );

   161 	if ((!empty($email)) && ($email != '@')) {

   162 	$display = ($linktext != '') ? $linktext : $email;

   163 		$return  = $before;

   164 		$return .= "<a href='mailto:$email'>$display</a>";

   165 	 	$return .= $after;

   166 		return $return;

   167 	} else {

   168 		return '';

   169 	}

   170 }

   171 

   172 /**

   173  * Retrieve the HTML link to the URL of the author of the current comment.

   174  *

   175  * Both get_comment_author_url() and get_comment_author() rely on get_comment(),

   176  * which falls back to the global comment variable if the $comment_ID argument is empty.

   177  *

   178  * @since 1.5.0

   179  *

   180  * @param int $comment_ID Optional. The ID of the comment for which to get the author's link. Default current comment.

   181  * @return string The comment author name or HTML link for author's URL.

   182  */

   183 function get_comment_author_link( $comment_ID = 0 ) {

   184 	$url    = get_comment_author_url( $comment_ID );

   185 	$author = get_comment_author( $comment_ID );

   186 

   187 	if ( empty( $url ) || 'http://' == $url )

   188 		$return = $author;

   189 	else

   190 		$return = "<a href='$url' rel='external nofollow' class='url'>$author</a>";

   191 

   192 	/**

   193 	 * Filter the comment author's link for display.

   194 	 *

   195 	 * @since 1.5.2

   196 	 *

   197 	 * @param string $return The HTML-formatted comment author link. Empty for an invalid URL.

   198 	 */

   199 	return apply_filters( 'get_comment_author_link', $return );

   200 }

   201 

   202 /**

   203  * Display the html link to the url of the author of the current comment.

   204  *

   205  * @since 0.71

   206  * @see get_comment_author_link() Echoes result

   207  *

   208  * @param int $comment_ID Optional. The ID of the comment for which to print the author's link. Default current comment.

   209  */

   210 function comment_author_link( $comment_ID = 0 ) {

   211 	echo get_comment_author_link( $comment_ID );

   212 }

   213 

   214 /**

   215  * Retrieve the IP address of the author of the current comment.

   216  *

   217  * @since 1.5.0

   218  *

   219  * @param int $comment_ID Optional. The ID of the comment for which to get the author's IP address. Default current comment.

   220  * @return string The comment author's IP address.

   221  */

   222 function get_comment_author_IP( $comment_ID = 0 ) {

   223 	$comment = get_comment( $comment_ID );

   224 

   225 	/**

   226 	 * Filter the comment author's returned IP address.

   227 	 *

   228 	 * @since 1.5.2

   229 	 *

   230 	 * @param string $comment->comment_author_IP The comment author's IP address.

   231 	 */

   232 	return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP );

   233 }

   234 

   235 /**

   236  * Display the IP address of the author of the current comment.

   237  *

   238  * @since 0.71

   239  *

   240  * @param int $comment_ID Optional. The ID of the comment for which to print the author's IP address. Default current comment.

   241  */

   242 function comment_author_IP( $comment_ID = 0 ) {

   243 	echo get_comment_author_IP( $comment_ID );

   244 }

   245 

   246 /**

   247  * Retrieve the url of the author of the current comment.

   248  *

   249  * @since 1.5.0

   250  *

   251  * @param int $comment_ID Optional. The ID of the comment for which to get the author's URL. Default current comment.

   252  * @return string

   253  */

   254 function get_comment_author_url( $comment_ID = 0 ) {

   255 	$comment = get_comment( $comment_ID );

   256 	$url = ('http://' == $comment->comment_author_url) ? '' : $comment->comment_author_url;

   257 	$url = esc_url( $url, array('http', 'https') );

   258 	return apply_filters('get_comment_author_url', $url);

   259 }

   260 

   261 /**

   262  * Display the url of the author of the current comment.

   263  *

   264  * @since 0.71

   265  *

   266  * @param int $comment_ID Optional. The ID of the comment for which to print the author's URL. Default current comment.

   267  */

   268 function comment_author_url( $comment_ID = 0 ) {

   269 	$author_url = get_comment_author_url( $comment_ID );

   270 	/**

   271 	 * Filter the comment author's URL for display.

   272 	 *

   273 	 * @since 1.2.1

   274 	 *

   275 	 * @param string $author_url The comment author's URL.

   276 	 */

   277 	echo apply_filters( 'comment_url', $author_url );

   278 }

   279 

   280 /**

   281  * Retrieves the HTML link of the url of the author of the current comment.

   282  *

   283  * $linktext parameter is only used if the URL does not exist for the comment

   284  * author. If the URL does exist then the URL will be used and the $linktext

   285  * will be ignored.

   286  *

   287  * Encapsulate the HTML link between the $before and $after. So it will appear

   288  * in the order of $before, link, and finally $after.

   289  *

   290  * @since 1.5.0

   291  *

   292  * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty.

   293  * @param string $before   Optional. The text or HTML to display before the email link. Default empty.

   294  * @param string $after    Optional. The text or HTML to display after the email link. Default empty.

   295  * @return string The HTML link between the $before and $after parameters.

   296  */

   297 function get_comment_author_url_link( $linktext = '', $before = '', $after = '' ) {

   298 	$url = get_comment_author_url();

   299 	$display = ($linktext != '') ? $linktext : $url;

   300 	$display = str_replace( 'http://www.', '', $display );

   301 	$display = str_replace( 'http://', '', $display );

   302 	if ( '/' == substr($display, -1) )

   303 		$display = substr($display, 0, -1);

   304 	$return = "$before<a href='$url' rel='external'>$display</a>$after";

   305 

   306 	/**

   307 	 * Filter the comment author's returned URL link.

   308 	 *

   309 	 * @since 1.5.2

   310 	 *

   311 	 * @param string $return The HTML-formatted comment author URL link.

   312 	 */

   313 	return apply_filters( 'get_comment_author_url_link', $return );

   314 }

   315 

   316 /**

   317  * Displays the HTML link of the url of the author of the current comment.

   318  *

   319  * @since 0.71

   320  *

   321  * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty.

   322  * @param string $before   Optional. The text or HTML to display before the email link. Default empty.

   323  * @param string $after    Optional. The text or HTML to display after the email link. Default empty.

   324  */

   325 function comment_author_url_link( $linktext = '', $before = '', $after = '' ) {

   326 	echo get_comment_author_url_link( $linktext, $before, $after );

   327 }

   328 

   329 /**

   330  * Generates semantic classes for each comment element

   331  *

   332  * @since 2.7.0

   333  *

   334  * @param string|array $class      Optional. One or more classes to add to the class list. Default empty.

   335  * @param int          $comment_id Optional. Comment ID. Default current comment.

   336  * @param int|WP_Post  $post_id    Optional. Post ID or WP_Post object. Default current post.

   337  * @param bool         $echo       Optional. Whether comment_class should echo or return. Default true.

   338  */

   339 function comment_class( $class = '', $comment_id = null, $post_id = null, $echo = true ) {

   340 	// Separates classes with a single space, collates classes for comment DIV

   341 	$class = 'class="' . join( ' ', get_comment_class( $class, $comment_id, $post_id ) ) . '"';

   342 	if ( $echo)

   343 		echo $class;

   344 	else

   345 		return $class;

   346 }

   347 

   348 /**

   349  * Returns the classes for the comment div as an array

   350  *

   351  * @since 2.7.0

   352  *

   353  * @param string|array $class      Optional. One or more classes to add to the class list. Default empty.

   354  * @param int          $comment_id Optional. Comment ID. Default current comment.

   355  * @param int|WP_Post  $post_id    Optional. Post ID or WP_Post object. Default current post.

   356  * @return array An array of classes.

   357  */

   358 function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {

   359 	global $comment_alt, $comment_depth, $comment_thread_alt;

   360 

   361 	$comment = get_comment($comment_id);

   362 

   363 	$classes = array();

   364 

   365 	// Get the comment type (comment, trackback),

   366 	$classes[] = ( empty( $comment->comment_type ) ) ? 'comment' : $comment->comment_type;

   367 

   368 	// If the comment author has an id (registered), then print the log in name

   369 	if ( $comment->user_id > 0 && $user = get_userdata($comment->user_id) ) {

   370 		// For all registered users, 'byuser'

   371 		$classes[] = 'byuser';

   372 		$classes[] = 'comment-author-' . sanitize_html_class($user->user_nicename, $comment->user_id);

   373 		// For comment authors who are the author of the post

   374 		if ( $post = get_post($post_id) ) {

   375 			if ( $comment->user_id === $post->post_author )

   376 				$classes[] = 'bypostauthor';

   377 		}

   378 	}

   379 

   380 	if ( empty($comment_alt) )

   381 		$comment_alt = 0;

   382 	if ( empty($comment_depth) )

   383 		$comment_depth = 1;

   384 	if ( empty($comment_thread_alt) )

   385 		$comment_thread_alt = 0;

   386 

   387 	if ( $comment_alt % 2 ) {

   388 		$classes[] = 'odd';

   389 		$classes[] = 'alt';

   390 	} else {

   391 		$classes[] = 'even';

   392 	}

   393 

   394 	$comment_alt++;

   395 

   396 	// Alt for top-level comments

   397 	if ( 1 == $comment_depth ) {

   398 		if ( $comment_thread_alt % 2 ) {

   399 			$classes[] = 'thread-odd';

   400 			$classes[] = 'thread-alt';

   401 		} else {

   402 			$classes[] = 'thread-even';

   403 		}

   404 		$comment_thread_alt++;

   405 	}

   406 

   407 	$classes[] = "depth-$comment_depth";

   408 

   409 	if ( !empty($class) ) {

   410 		if ( !is_array( $class ) )

   411 			$class = preg_split('#\s+#', $class);

   412 		$classes = array_merge($classes, $class);

   413 	}

   414 

   415 	$classes = array_map('esc_attr', $classes);

   416 

   417 	/**

   418 	 * Filter the returned CSS classes for the current comment.

   419 	 *

   420 	 * @since 2.7.0

   421 	 *

   422 	 * @param array       $classes    An array of comment classes.

   423 	 * @param string      $class      A comma-separated list of additional classes added to the list.

   424 	 * @param int         $comment_id The comment id.

   425 	 * @param int|WP_Post $post_id    The post ID or WP_Post object.

   426 	 */

   427 	return apply_filters( 'comment_class', $classes, $class, $comment_id, $post_id );

   428 }

   429 

   430 /**

   431  * Retrieve the comment date of the current comment.

   432  *

   433  * @since 1.5.0

   434  *

   435  * @param string $d          Optional. The format of the date. Default user's setting.

   436  * @param int    $comment_ID Optional. The ID of the comment for which to get the date. Default current comment.

   437  * @return string The comment's date.

   438  */

   439 function get_comment_date( $d = '', $comment_ID = 0 ) {

   440 	$comment = get_comment( $comment_ID );

   441 	if ( '' == $d )

   442 		$date = mysql2date(get_option('date_format'), $comment->comment_date);

   443 	else

   444 		$date = mysql2date($d, $comment->comment_date);

   445 	/**

   446 	 * Filter the returned comment date.

   447 	 *

   448 	 * @since 1.5.2

   449 	 *

   450 	 * @param string|int $date Formatted date string or Unix timestamp.

   451 	 * @param string     $d    The format of the date.

   452 	 */

   453 	return apply_filters( 'get_comment_date', $date, $d );

   454 }

   455 

   456 /**

   457  * Display the comment date of the current comment.

   458  *

   459  * @since 0.71

   460  *

   461  * @param string $d          Optional. The format of the date. Default user's settings.

   462  * @param int    $comment_ID Optional. The ID of the comment for which to print the date. Default current comment.

   463  */

   464 function comment_date( $d = '', $comment_ID = 0 ) {

   465 	echo get_comment_date( $d, $comment_ID );

   466 }

   467 

   468 /**

   469  * Retrieve the excerpt of the current comment.

   470  *

   471  * Will cut each word and only output the first 20 words with '…' at the end.

   472  * If the word count is less than 20, then no truncating is done and no '…'

   473  * will appear.

   474  *

   475  * @since 1.5.0

   476  *

   477  * @param int $comment_ID Optional. The ID of the comment for which to get the excerpt. Default current comment.

   478  * @return string The maybe truncated comment with 20 words or less.

   479  */

   480 function get_comment_excerpt( $comment_ID = 0 ) {

   481 	$comment = get_comment( $comment_ID );

   482 	$comment_text = strip_tags($comment->comment_content);

   483 	$blah = explode(' ', $comment_text);

   484 	if (count($blah) > 20) {

   485 		$k = 20;

   486 		$use_dotdotdot = 1;

   487 	} else {

   488 		$k = count($blah);

   489 		$use_dotdotdot = 0;

   490 	}

   491 	$excerpt = '';

   492 	for ($i=0; $i<$k; $i++) {

   493 		$excerpt .= $blah[$i] . ' ';

   494 	}

   495 	$excerpt .= ($use_dotdotdot) ? '…' : '';

   496 	return apply_filters('get_comment_excerpt', $excerpt);

   497 }

   498 

   499 /**

   500  * Display the excerpt of the current comment.

   501  *

   502  * @since 1.2.0

   503  *

   504  * @param int $comment_ID Optional. The ID of the comment for which to print the excerpt. Default current comment.

   505  */

   506 function comment_excerpt( $comment_ID = 0 ) {

   507 	$comment_excerpt = get_comment_excerpt($comment_ID);

   508 	/**

   509 	 * Filter the comment excerpt for display.

   510 	 *

   511 	 * @since 1.2.1

   512 	 *

   513 	 * @param string $comment_excerpt The comment excerpt text.

   514 	 */

   515 	echo apply_filters( 'comment_excerpt', $comment_excerpt );

   516 }

   517 

   518 /**

   519  * Retrieve the comment id of the current comment.

   520  *

   521  * @since 1.5.0

   522  *

   523  * @return int The comment ID.

   524  */

   525 function get_comment_ID() {

   526 	global $comment;

   527 	/**

   528 	 * Filter the returned comment ID.

   529 	 *

   530 	 * @since 1.5.2

   531 	 *

   532 	 * @param int $comment->comment_ID The current comment ID.

   533 	 */

   534 	return apply_filters( 'get_comment_ID', $comment->comment_ID );

   535 }

   536 

   537 /**

   538  * Display the comment id of the current comment.

   539  *

   540  * @since 0.71

   541  */

   542 function comment_ID() {

   543 	echo get_comment_ID();

   544 }

   545 

   546 /**

   547  * Retrieve the link to a given comment.

   548  *

   549  * @since 1.5.0

   550  *

   551  * @param mixed $comment Optional. Comment to retrieve. Default current comment.

   552  * @param array $args    Optional. An array of arguments to override the defaults. @see get_page_of_comment()

   553  * @return string The permalink to the given comment.

   554  */

   555 function get_comment_link( $comment = null, $args = array() ) {

   556 	global $wp_rewrite, $in_comment_loop;

   557 

   558 	$comment = get_comment($comment);

   559 

   560 	// Backwards compat

   561 	if ( !is_array($args) ) {

   562 		$page = $args;

   563 		$args = array();

   564 		$args['page'] = $page;

   565 	}

   566 

   567 	$defaults = array( 'type' => 'all', 'page' => '', 'per_page' => '', 'max_depth' => '' );

   568 	$args = wp_parse_args( $args, $defaults );

   569 

   570 	if ( '' === $args['per_page'] && get_option('page_comments') )

   571 		$args['per_page'] = get_option('comments_per_page');

   572 

   573 	if ( empty($args['per_page']) ) {

   574 		$args['per_page'] = 0;

   575 		$args['page'] = 0;

   576 	}

   577 

   578 	if ( $args['per_page'] ) {

   579 		if ( '' == $args['page'] )

   580 			$args['page'] = ( !empty($in_comment_loop) ) ? get_query_var('cpage') : get_page_of_comment( $comment->comment_ID, $args );

   581 

   582 		if ( $wp_rewrite->using_permalinks() )

   583 			$link = user_trailingslashit( trailingslashit( get_permalink( $comment->comment_post_ID ) ) . 'comment-page-' . $args['page'], 'comment' );

   584 		else

   585 			$link = add_query_arg( 'cpage', $args['page'], get_permalink( $comment->comment_post_ID ) );

   586 	} else {

   587 		$link = get_permalink( $comment->comment_post_ID );

   588 	}

   589 

   590 	$link = $link . '#comment-' . $comment->comment_ID;

   591 	/**

   592 	 * Filter the returned single comment permalink.

   593 	 *

   594 	 * @since 2.8.0

   595 	 *

   596 	 * @param string $link    The comment permalink with '#comment-$id' appended.

   597 	 * @param object $comment The current comment object.

   598 	 * @param array  $args    An array of arguments to override the defaults. @see get_page_of_comment()

   599 	 */

   600 	return apply_filters( 'get_comment_link', $link, $comment, $args );

   601 }

   602 

   603 /**

   604  * Retrieve the link to the current post comments.

   605  *

   606  * @since 1.5.0

   607  *

   608  * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.

   609  * @return string The link to the comments.

   610  */

   611 function get_comments_link( $post_id = 0 ) {

   612 	$comments_link = get_permalink( $post_id ) . '#comments';

   613 	/**

   614 	 * Filter the returned post comments permalink.

   615 	 *

   616 	 * @since

   617 	 *

   618 	 * @param string      $comments_link The post comments permalink with '#comments' appended.

   619 	 * @param int|WP_Post $post_id       The post ID or WP_Post object.

   620 	 */

   621 	return apply_filters( 'get_comments_link', $comments_link, $post_id );

   622 }

   623 

   624 /**

   625  * Display the link to the current post comments.

   626  *

   627  * @since 0.71

   628  *

   629  * @param string $deprecated   Not Used.

   630  * @param bool   $deprecated_2 Not Used.

   631  */

   632 function comments_link( $deprecated = '', $deprecated_2 = '' ) {

   633 	if ( !empty( $deprecated ) )

   634 		_deprecated_argument( __FUNCTION__, '0.72' );

   635 	if ( !empty( $deprecated_2 ) )

   636 		_deprecated_argument( __FUNCTION__, '1.3' );

   637 	echo esc_url( get_comments_link() );

   638 }

   639 

   640 /**

   641  * Retrieve the amount of comments a post has.

   642  *

   643  * @since 1.5.0

   644  *

   645  * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.

   646  * @return int The number of comments a post has.

   647  */

   648 function get_comments_number( $post_id = 0 ) {

   649 	$post_id = absint( $post_id );

   650 

   651 	if ( !$post_id )

   652 		$post_id = get_the_ID();

   653 

   654 	$post = get_post($post_id);

   655 	if ( ! isset($post->comment_count) )

   656 		$count = 0;

   657 	else

   658 		$count = $post->comment_count;

   659 

   660 	/**

   661 	 * Filter the returned comment count for a post.

   662 	 *

   663 	 * @since 1.5.2

   664 	 *

   665 	 * @param int         $count   The number of comments a post has.

   666 	 * @param int|WP_Post $post_id The post ID or WP_Post object.

   667 	 */

   668 	return apply_filters( 'get_comments_number', $count, $post_id );

   669 }

   670 

   671 /**

   672  * Display the language string for the number of comments the current post has.

   673  *

   674  * @since 0.71

   675  *

   676  * @param string $zero       Optional. Text for no comments. Default false.

   677  * @param string $one        Optional. Text for one comment. Default false.

   678  * @param string $more       Optional. Text for more than one comment. Default false.

   679  * @param string $deprecated Not used.

   680  */

   681 function comments_number( $zero = false, $one = false, $more = false, $deprecated = '' ) {

   682 	if ( !empty( $deprecated ) )

   683 		_deprecated_argument( __FUNCTION__, '1.3' );

   684 

   685 	$number = get_comments_number();

   686 

   687 	if ( $number > 1 )

   688 		$output = str_replace('%', number_format_i18n($number), ( false === $more ) ? __('% Comments') : $more);

   689 	elseif ( $number == 0 )

   690 		$output = ( false === $zero ) ? __('No Comments') : $zero;

   691 	else // must be one

   692 		$output = ( false === $one ) ? __('1 Comment') : $one;

   693 

   694 	/**

   695 	 * Filter the comments count for display.

   696 	 *

   697 	 * @since 1.5.2

   698 	 *

   699 	 * @param string $output A translatable string formatted based on whether the count is equal to 0, 1, or 1+. @see _n()

   700 	 * @param int    $number The number of post comments.

   701 	 */

   702 	echo apply_filters( 'comments_number', $output, $number );

   703 }

   704 

   705 /**

   706  * Retrieve the text of the current comment.

   707  *

   708  * @since 1.5.0

   709  *

   710  * @param int   $comment_ID Optional. The ID of the comment for which to get the text. Default current comment.

   711  * @param array $args       Optional. An array of arguments. @see Walker_Comment::comment()

   712  * @return string The comment content.

   713  */

   714 function get_comment_text( $comment_ID = 0, $args = array() ) {

   715 	$comment = get_comment( $comment_ID );

   716 

   717 	/**

   718 	 * Filter the text of a comment.

   719 	 *

   720 	 * @since 1.5.2

   721 	 *

   722 	 * @param string $comment->comment_content The text of the comment.

   723 	 * @param object $comment                  The comment object.

   724 	 * @param array  $args                     An array of arguments. @see Walker_Comment::comment()

   725 	 */

   726 	return apply_filters( 'get_comment_text', $comment->comment_content, $comment, $args );

   727 }

   728 

   729 /**

   730  * Display the text of the current comment.

   731  *

   732  * @since 0.71

   733  *

   734  * @param int   $comment_ID Optional. The ID of the comment for which to print the text.

   735  *                          Default 0.

   736  * @param array $args       Optional. An array of arguments. @see Walker_Comment::comment()

   737  *                          Default empty array.

   738  */

   739 function comment_text( $comment_ID = 0, $args = array() ) {

   740 	$comment = get_comment( $comment_ID );

   741 

   742 	$comment_text = get_comment_text( $comment_ID , $args );

   743 	/**

   744 	 * Filter the text of a comment to be displayed.

   745 	 *

   746 	 * @since 1.2.1

   747 	 *

   748 	 * @param string $comment_text The text of the current comment.

   749 	 * @param object $comment      The comment object.

   750 	 * @param array  $args         An array of arguments. @see Walker_Comment::comment()

   751 	 */

   752 	echo apply_filters( 'comment_text', $comment_text, $comment, $args );

   753 }

   754 

   755 /**

   756  * Retrieve the comment time of the current comment.

   757  *

   758  * @since 1.5.0

   759  *

   760  * @param string $d         Optional. The format of the time. Default user's settings.

   761  * @param bool   $gmt       Optional. Whether to use the GMT date. Default false.

   762  * @param bool   $translate Optional. Whether to translate the time (for use in feeds). Default true.

   763  * @return string The formatted time

   764  */

   765 function get_comment_time( $d = '', $gmt = false, $translate = true ) {

   766 	global $comment;

   767 	$comment_date = $gmt ? $comment->comment_date_gmt : $comment->comment_date;

   768 	if ( '' == $d )

   769 		$date = mysql2date(get_option('time_format'), $comment_date, $translate);

   770 	else

   771 		$date = mysql2date($d, $comment_date, $translate);

   772 

   773 	/**

   774 	 * Filter the returned comment time.

   775 	 *

   776 	 * @since 1.5.2

   777 	 *

   778 	 * @param string|int $date      The comment time, formatted as a date string or Unix timestamp.

   779 	 * @param string     $d         The date format.

   780 	 * @param bool       $gmt       Whether the GMT date is in use.

   781 	 * @param bool       $translate Whether the time is translated.

   782 	 */

   783 	return apply_filters( 'get_comment_time', $date, $d, $gmt, $translate );

   784 }

   785 

   786 /**

   787  * Display the comment time of the current comment.

   788  *

   789  * @since 0.71

   790  *

   791  * @param string $d Optional. The format of the time. Default user's settings.

   792  */

   793 function comment_time( $d = '' ) {

   794 	echo get_comment_time($d);

   795 }

   796 

   797 /**

   798  * Retrieve the comment type of the current comment.

   799  *

   800  * @since 1.5.0

   801  *

   802  * @param int $comment_ID Optional. The ID of the comment for which to get the type. Default current comment.

   803  * @return string The comment type

   804  */

   805 function get_comment_type( $comment_ID = 0 ) {

   806 	$comment = get_comment( $comment_ID );

   807 	if ( '' == $comment->comment_type )

   808 		$comment->comment_type = 'comment';

   809 

   810 	/**

   811 	 * Filter the returned comment type.

   812 	 *

   813 	 * @since 1.5.2

   814 	 *

   815 	 * @param string $comment->comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.

   816 	 */

   817 	return apply_filters( 'get_comment_type', $comment->comment_type );

   818 }

   819 

   820 /**

   821  * Display the comment type of the current comment.

   822  *

   823  * @since 0.71

   824  *

   825  * @param string $commenttxt   Optional. The string to display for comment type. Default false.

   826  * @param string $trackbacktxt Optional. The string to display for trackback type. Default false.

   827  * @param string $pingbacktxt  Optional. The string to display for pingback type. Default false.

   828  */

   829 function comment_type( $commenttxt = false, $trackbacktxt = false, $pingbacktxt = false ) {

   830 	if ( false === $commenttxt ) $commenttxt = _x( 'Comment', 'noun' );

   831 	if ( false === $trackbacktxt ) $trackbacktxt = __( 'Trackback' );

   832 	if ( false === $pingbacktxt ) $pingbacktxt = __( 'Pingback' );

   833 	$type = get_comment_type();

   834 	switch( $type ) {

   835 		case 'trackback' :

   836 			echo $trackbacktxt;

   837 			break;

   838 		case 'pingback' :

   839 			echo $pingbacktxt;

   840 			break;

   841 		default :

   842 			echo $commenttxt;

   843 	}

   844 }

   845 

   846 /**

   847  * Retrieve The current post's trackback URL.

   848  *

   849  * There is a check to see if permalink's have been enabled and if so, will

   850  * retrieve the pretty path. If permalinks weren't enabled, the ID of the

   851  * current post is used and appended to the correct page to go to.

   852  *

   853  * @since 1.5.0

   854  *

   855  * @return string The trackback URL after being filtered.

   856  */

   857 function get_trackback_url() {

   858 	if ( '' != get_option('permalink_structure') )

   859 		$tb_url = trailingslashit(get_permalink()) . user_trailingslashit('trackback', 'single_trackback');

   860 	else

   861 		$tb_url = get_option('siteurl') . '/wp-trackback.php?p=' . get_the_ID();

   862 

   863 	/**

   864 	 * Filter the returned trackback URL.

   865 	 *

   866 	 * @since 2.2.0

   867 	 *

   868 	 * @param string $tb_url The trackback URL.

   869 	 */

   870 	return apply_filters( 'trackback_url', $tb_url );

   871 }

   872 

   873 /**

   874  * Display the current post's trackback URL.

   875  *

   876  * @since 0.71

   877  *

   878  * @param bool $deprecated_echo Not used.

   879  * @return void|string Should only be used to echo the trackback URL, use get_trackback_url() for the result instead.

   880  */

   881 function trackback_url( $deprecated_echo = true ) {

   882 	if ( $deprecated_echo !== true )

   883 		_deprecated_argument( __FUNCTION__, '2.5', __('Use <code>get_trackback_url()</code> instead if you do not want the value echoed.') );

   884 	if ( $deprecated_echo )

   885 		echo get_trackback_url();

   886 	else

   887 		return get_trackback_url();

   888 }

   889 

   890 /**

   891  * Generate and display the RDF for the trackback information of current post.

   892  *

   893  * Deprecated in 3.0.0, and restored in 3.0.1.

   894  *

   895  * @since 0.71

   896  *

   897  * @param int $deprecated Not used (Was $timezone = 0).

   898  */

   899 function trackback_rdf( $deprecated = '' ) {

   900 	if ( !empty( $deprecated ) )

   901 		_deprecated_argument( __FUNCTION__, '2.5' );

   902 

   903 	if ( false !== stripos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') )

   904 		return;

   905 

   906 	echo '<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"

   907 			xmlns:dc="http://purl.org/dc/elements/1.1/"

   908 			xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/">

   909 		<rdf:Description rdf:about="';

   910 	the_permalink();

   911 	echo '"'."\n";

   912 	echo '    dc:identifier="';

   913 	the_permalink();

   914 	echo '"'."\n";

   915 	echo '    dc:title="'.str_replace('--', '--', wptexturize(strip_tags(get_the_title()))).'"'."\n";

   916 	echo '    trackback:ping="'.get_trackback_url().'"'." />\n";

   917 	echo '</rdf:RDF>';

   918 }

   919 

   920 /**

   921  * Whether the current post is open for comments.

   922  *

   923  * @since 1.5.0

   924  *

   925  * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.

   926  * @return bool True if the comments are open.

   927  */

   928 function comments_open( $post_id = null ) {

   929 

   930 	$_post = get_post($post_id);

   931 

   932 	$open = ( 'open' == $_post->comment_status );

   933 

   934 	/**

   935 	 * Filter whether the current post is open for comments.

   936 	 *

   937 	 * @since

   938 	 *

   939 	 * @param bool        $open    Whether the current post is open for comments.

   940 	 * @param int|WP_Post $post_id The post ID or WP_Post object.

   941 	 */

   942 	return apply_filters( 'comments_open', $open, $post_id );

   943 }

   944 

   945 /**

   946  * Whether the current post is open for pings.

   947  *

   948  * @since 1.5.0

   949  *

   950  * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.

   951  * @return bool True if pings are accepted

   952  */

   953 function pings_open( $post_id = null ) {

   954 

   955 	$_post = get_post($post_id);

   956 

   957 	$open = ( 'open' == $_post->ping_status );

   958 	return apply_filters( 'pings_open', $open, $post_id );

   959 }

   960 

   961 /**

   962  * Display form token for unfiltered comments.

   963  *

   964  * Will only display nonce token if the current user has permissions for

   965  * unfiltered html. Won't display the token for other users.

   966  *

   967  * The function was backported to 2.0.10 and was added to versions 2.1.3 and

   968  * above. Does not exist in versions prior to 2.0.10 in the 2.0 branch and in

   969  * the 2.1 branch, prior to 2.1.3. Technically added in 2.2.0.

   970  *

   971  * Backported to 2.0.10.

   972  *

   973  * @since 2.1.3

   974  */

   975 function wp_comment_form_unfiltered_html_nonce() {

   976 	$post = get_post();

   977 	$post_id = $post ? $post->ID : 0;

   978 

   979 	if ( current_user_can( 'unfiltered_html' ) ) {

   980 		wp_nonce_field( 'unfiltered-html-comment_' . $post_id, '_wp_unfiltered_html_comment_disabled', false );

   981 		echo "<script>(function(){if(window===window.parent){document.getElementById('_wp_unfiltered_html_comment_disabled').name='_wp_unfiltered_html_comment';}})();</script>\n";

   982 	}

   983 }

   984 

   985 /**

   986  * Load the comment template specified in $file.

   987  *

   988  * Will not display the comments template if not on single post or page, or if

   989  * the post does not have comments.

   990  *

   991  * Uses the WordPress database object to query for the comments. The comments

   992  * are passed through the 'comments_array' filter hook with the list of comments

   993  * and the post ID respectively.

   994  *

   995  * The $file path is passed through a filter hook called, 'comments_template'

   996  * which includes the TEMPLATEPATH and $file combined. Tries the $filtered path

   997  * first and if it fails it will require the default comment template from the

   998  * default theme. If either does not exist, then the WordPress process will be

   999  * halted. It is advised for that reason, that the default theme is not deleted.

  1000  *

  1001  * @todo Document globals

  1002  * @uses $withcomments Will not try to get the comments if the post has none.

  1003  *

  1004  * @since 1.5.0

  1005  *

  1006  * @param string $file              Optional. The file to load. Default '/comments.php'.

  1007  * @param bool   $separate_comments Optional. Whether to separate the comments by comment type. Default false.

  1008  * @return null Returns null if no comments appear.

  1009  */

  1010 function comments_template( $file = '/comments.php', $separate_comments = false ) {

  1011 	global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_ID, $user_identity, $overridden_cpage;

  1012 

  1013 	if ( !(is_single() || is_page() || $withcomments) || empty($post) )

  1014 		return;

  1015 

  1016 	if ( empty($file) )

  1017 		$file = '/comments.php';

  1018 

  1019 	$req = get_option('require_name_email');

  1020 

  1021 	/**

  1022 	 * Comment author information fetched from the comment cookies.

  1023 	 *

  1024 	 * @uses wp_get_current_commenter()

  1025 	 */

  1026 	$commenter = wp_get_current_commenter();

  1027 

  1028 	/**

  1029 	 * The name of the current comment author escaped for use in attributes.

  1030 	 */

  1031 	$comment_author = $commenter['comment_author']; // Escaped by sanitize_comment_cookies()

  1032 

  1033 	/**

  1034 	 * The email address of the current comment author escaped for use in attributes.

  1035 	 */

  1036 	$comment_author_email = $commenter['comment_author_email'];  // Escaped by sanitize_comment_cookies()

  1037 

  1038 	/**

  1039 	 * The url of the current comment author escaped for use in attributes.

  1040 	 */

  1041 	$comment_author_url = esc_url($commenter['comment_author_url']);

  1042 

  1043 	/** @todo Use API instead of SELECTs. */

  1044 	if ( $user_ID) {

  1045 		$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));

  1046 	} else if ( empty($comment_author) ) {

  1047 		$comments = get_comments( array('post_id' => $post->ID, 'status' => 'approve', 'order' => 'ASC') );

  1048 	} else {

  1049 		$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));

  1050 	}

  1051 

  1052 	// keep $comments for legacy's sake

  1053 	/**

  1054 	 * Filter the comments array.

  1055 	 *

  1056 	 * @since 2.1.0

  1057 	 *

  1058 	 * @param array $comments The array of comments supplied to the comments template.

  1059 	 * @param int   $post->ID The post ID.

  1060 	 */

  1061 	$wp_query->comments = apply_filters( 'comments_array', $comments, $post->ID );

  1062 	$comments = &$wp_query->comments;

  1063 	$wp_query->comment_count = count($wp_query->comments);

  1064 	update_comment_cache($wp_query->comments);

  1065 

  1066 	if ( $separate_comments ) {

  1067 		$wp_query->comments_by_type = separate_comments($comments);

  1068 		$comments_by_type = &$wp_query->comments_by_type;

  1069 	}

  1070 

  1071 	$overridden_cpage = false;

  1072 	if ( '' == get_query_var('cpage') && get_option('page_comments') ) {

  1073 		set_query_var( 'cpage', 'newest' == get_option('default_comments_page') ? get_comment_pages_count() : 1 );

  1074 		$overridden_cpage = true;

  1075 	}

  1076 

  1077 	if ( !defined('COMMENTS_TEMPLATE') )

  1078 		define('COMMENTS_TEMPLATE', true);

  1079 

  1080 	$theme_template = STYLESHEETPATH . $file;

  1081 	/**

  1082 	 * Filter the path to the theme template file used for the comments template.

  1083 	 *

  1084 	 * @since 1.5.2

  1085 	 *

  1086 	 * @param string $theme_template The path to the theme template file.

  1087 	 */

  1088 	$include = apply_filters( 'comments_template', $theme_template );

  1089 	if ( file_exists( $include ) )

  1090 		require( $include );

  1091 	elseif ( file_exists( TEMPLATEPATH . $file ) )

  1092 		require( TEMPLATEPATH . $file );

  1093 	else // Backward compat code will be removed in a future release

  1094 		require( ABSPATH . WPINC . '/theme-compat/comments.php');

  1095 }

  1096 

  1097 /**

  1098  * Display the JS popup script to show a comment.

  1099  *

  1100  * If the $file parameter is empty, then the home page is assumed. The defaults

  1101  * for the window are 400px by 400px.

  1102  *

  1103  * For the comment link popup to work, this function has to be called or the

  1104  * normal comment link will be assumed.

  1105  *

  1106  * @global string $wpcommentspopupfile  The URL to use for the popup window.

  1107  * @global int    $wpcommentsjavascript Whether to use JavaScript. Set when function is called.

  1108  *

  1109  * @since 0.71

  1110  *

  1111  * @param int $width  Optional. The width of the popup window. Default 400.

  1112  * @param int $height Optional. The height of the popup window. Default 400.

  1113  * @param string $file Optional. Sets the location of the popup window.

  1114  */

  1115 function comments_popup_script( $width = 400, $height = 400, $file = '' ) {

  1116 	global $wpcommentspopupfile, $wpcommentsjavascript;

  1117 

  1118 	if (empty ($file)) {

  1119 		$wpcommentspopupfile = '';  // Use the index.

  1120 	} else {

  1121 		$wpcommentspopupfile = $file;

  1122 	}

  1123 

  1124 	$wpcommentsjavascript = 1;

  1125 	$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";

  1126 	echo $javascript;

  1127 }

  1128 

  1129 /**

  1130  * Displays the link to the comments popup window for the current post ID.

  1131  *

  1132  * Is not meant to be displayed on single posts and pages. Should be used on the

  1133  * lists of posts

  1134  *

  1135  * @global string $wpcommentspopupfile  The URL to use for the popup window.