2006-04-19 10:13:28 +00:00
< ? php
2007-12-26 17:18:13 +00:00
/**
* Comment template functions
*
* These functions are meant to live inside of the WordPress loop .
*
* @ package WordPress
* @ subpackage Template
2006-04-19 10:13:28 +00:00
*/
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve the author of the current comment .
2007-12-26 17:18:13 +00:00
*
2008-06-22 20:23:23 +00:00
* If the comment has an empty comment_author field , then 'Anonymous' person is
* assumed .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses apply_filters () Calls 'get_comment_author' hook on the comment author
*
2010-01-25 17:34:13 +00:00
* @ param int $comment_ID The ID of the comment for which to retrieve the author . Optional .
2007-12-26 17:18:13 +00:00
* @ return string The comment author
*/
2010-01-25 17:34:13 +00:00
function get_comment_author ( $comment_ID = 0 ) {
$comment = get_comment ( $comment_ID );
2008-11-19 06:58:44 +00:00
if ( empty ( $comment -> comment_author ) ) {
if ( ! empty ( $comment -> user_id )){
$user = get_userdata ( $comment -> user_id );
$author = $user -> user_login ;
} else {
$author = __ ( 'Anonymous' );
}
} else {
2006-04-19 10:13:28 +00:00
$author = $comment -> comment_author ;
2008-11-19 06:58:44 +00:00
}
2006-04-19 10:13:28 +00:00
return apply_filters ( 'get_comment_author' , $author );
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Displays the author of the current comment .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
* @ uses apply_filters () Calls 'comment_author' on comment author before displaying
2010-01-26 22:49:05 +00:00
*
2010-01-25 17:34:13 +00:00
* @ param int $comment_ID The ID of the comment for which to print the author . Optional .
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function comment_author ( $comment_ID = 0 ) {
$author = apply_filters ( 'comment_author' , get_comment_author ( $comment_ID ) );
2006-04-19 10:13:28 +00:00
echo $author ;
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve the email of the author of the current comment .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses apply_filters () Calls the 'get_comment_author_email' hook on the comment author email
* @ uses $comment
*
2010-01-25 17:34:13 +00:00
* @ param int $comment_ID The ID of the comment for which to get the author ' s email . Optional .
2007-12-26 17:18:13 +00:00
* @ return string The current comment author ' s email
*/
2010-01-25 17:34:13 +00:00
function get_comment_author_email ( $comment_ID = 0 ) {
$comment = get_comment ( $comment_ID );
2006-04-19 10:13:28 +00:00
return apply_filters ( 'get_comment_author_email' , $comment -> comment_author_email );
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Display the email of the author of the current global $comment .
2007-12-26 17:18:13 +00:00
*
2008-06-22 20:23:23 +00:00
* Care should be taken to protect the email address and assure that email
* harvesters do not capture your commentors ' email address . Most assume that
* their email address will not appear in raw form on the blog . Doing so will
* enable anyone , including those that people don ' t want to get the email
* address and use it for their own means good and bad .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
* @ uses apply_filters () Calls 'author_email' hook on the author email
2010-01-25 17:34:13 +00:00
*
* @ param int $comment_ID The ID of the comment for which to print the author ' s email . Optional .
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function comment_author_email ( $comment_ID = 0 ) {
echo apply_filters ( 'author_email' , get_comment_author_email ( $comment_ID ) );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Display the html email link to the author of the current comment .
2007-12-26 17:18:13 +00:00
*
2008-06-22 20:23:23 +00:00
* Care should be taken to protect the email address and assure that email
* harvesters do not capture your commentors ' email address . Most assume that
* their email address will not appear in raw form on the blog . Doing so will
* enable anyone , including those that people don ' t want to get the email
* address and use it for their own means good and bad .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
* @ uses apply_filters () Calls 'comment_email' hook for the display of the comment author ' s email
2008-10-31 18:05:25 +00:00
* @ uses get_comment_author_email_link () For generating the link
2007-12-26 17:18:13 +00:00
* @ global object $comment The current Comment row object
*
* @ param string $linktext The text to display instead of the comment author ' s email address
* @ param string $before The text or HTML to display before the email link .
* @ param string $after The text or HTML to display after the email link .
*/
2006-04-19 10:13:28 +00:00
function comment_author_email_link ( $linktext = '' , $before = '' , $after = '' ) {
2008-10-31 18:05:25 +00:00
if ( $link = get_comment_author_email_link ( $linktext , $before , $after ) )
echo $link ;
}
/**
* Return the html email link to the author of the current comment .
*
* Care should be taken to protect the email address and assure that email
* harvesters do not capture your commentors ' email address . Most assume that
* their email address will not appear in raw form on the blog . Doing so will
* enable anyone , including those that people don ' t want to get the email
* address and use it for their own means good and bad .
*
* @ since 2.7
* @ uses apply_filters () Calls 'comment_email' hook for the display of the comment author ' s email
* @ global object $comment The current Comment row object
*
* @ param string $linktext The text to display instead of the comment author ' s email address
* @ param string $before The text or HTML to display before the email link .
* @ param string $after The text or HTML to display after the email link .
*/
function get_comment_author_email_link ( $linktext = '' , $before = '' , $after = '' ) {
2006-04-19 10:13:28 +00:00
global $comment ;
$email = apply_filters ( 'comment_email' , $comment -> comment_author_email );
if (( ! empty ( $email )) && ( $email != '@' )) {
$display = ( $linktext != '' ) ? $linktext : $email ;
2008-10-31 18:05:25 +00:00
$return = $before ;
$return .= " <a href='mailto: $email '> $display </a> " ;
$return .= $after ;
return $return ;
} else {
return '' ;
2006-04-19 10:13:28 +00:00
}
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve the html link to the url of the author of the current comment .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses apply_filters () Calls 'get_comment_author_link' hook on the complete link HTML or author
*
2010-01-25 17:34:13 +00:00
* @ param int $comment_ID The ID of the comment for which to get the author ' s link . Optional .
2007-12-26 17:18:13 +00:00
* @ return string Comment Author name or HTML link for author ' s URL
*/
2010-01-25 17:34:13 +00:00
function get_comment_author_link ( $comment_ID = 0 ) {
2007-12-26 17:18:13 +00:00
/** @todo Only call these functions when they are needed. Include in if... else blocks */
2010-01-25 17:34:13 +00:00
$url = get_comment_author_url ( $comment_ID );
$author = get_comment_author ( $comment_ID );
2006-04-19 10:13:28 +00:00
if ( empty ( $url ) || 'http://' == $url )
$return = $author ;
else
2008-11-18 22:06:51 +00:00
$return = " <a href=' $url ' rel='external nofollow' class='url'> $author </a> " ;
2006-04-19 10:13:28 +00:00
return apply_filters ( 'get_comment_author_link' , $return );
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Display the html link to the url of the author of the current comment .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
* @ see get_comment_author_link () Echos result
2010-01-25 17:34:13 +00:00
*
* @ param int The ID of the comment for which to print the author ' s link . Optional .
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function comment_author_link ( $comment_ID = 0 ) {
echo get_comment_author_link ( $comment_ID );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve the IP address of the author of the current comment .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses $comment
2008-02-05 06:47:27 +00:00
* @ uses apply_filters ()
2007-12-26 17:18:13 +00:00
*
2010-01-25 17:34:13 +00:00
* @ param int $comment_ID The ID of the comment for which to get the author ' s IP address . Optional .
* @ return string The comment author ' s IP address .
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function get_comment_author_IP ( $comment_ID = 0 ) {
$comment = get_comment ( $comment_ID );
2006-04-19 10:13:28 +00:00
return apply_filters ( 'get_comment_author_IP' , $comment -> comment_author_IP );
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Display the IP address of the author of the current comment .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
* @ see get_comment_author_IP () Echos Result
2010-01-25 17:34:13 +00:00
*
* @ param int $comment_ID The ID of the comment for which to print the author ' s IP address . Optional .
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function comment_author_IP ( $comment_ID = 0 ) {
echo get_comment_author_IP ( $comment_ID );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve the url of the author of the current comment .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses apply_filters () Calls 'get_comment_author_url' hook on the comment author ' s URL
*
2010-01-25 17:34:13 +00:00
* @ param int $comment_ID The ID of the comment for which to get the author ' s URL . Optional .
2007-12-26 17:18:13 +00:00
* @ return string
*/
2010-01-25 17:34:13 +00:00
function get_comment_author_url ( $comment_ID = 0 ) {
$comment = get_comment ( $comment_ID );
2009-05-10 07:26:30 +00:00
$url = ( 'http://' == $comment -> comment_author_url ) ? '' : $comment -> comment_author_url ;
2009-07-18 23:21:50 +00:00
$url = esc_url ( $url , array ( 'http' , 'https' ) );
2009-05-10 07:26:30 +00:00
return apply_filters ( 'get_comment_author_url' , $url );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Display the url of the author of the current comment .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
2008-02-05 06:47:27 +00:00
* @ uses apply_filters ()
2007-12-26 17:18:13 +00:00
* @ uses get_comment_author_url () Retrieves the comment author ' s URL
2010-01-25 17:34:13 +00:00
*
* @ param int $comment_ID The ID of the comment for which to print the author ' s URL . Optional .
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function comment_author_url ( $comment_ID = 0 ) {
echo apply_filters ( 'comment_url' , get_comment_author_url ( $comment_ID ));
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieves the HTML link of the url of the author of the current comment .
2007-12-26 17:18:13 +00:00
*
2008-06-22 20:23:23 +00:00
* $linktext parameter is only used if the URL does not exist for the comment
* author . If the URL does exist then the URL will be used and the $linktext
* will be ignored .
2007-12-26 17:18:13 +00:00
*
2008-06-22 20:23:23 +00:00
* Encapsulate the HTML link between the $before and $after . So it will appear
* in the order of $before , link , and finally $after .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses apply_filters () Calls the 'get_comment_author_url_link' on the complete HTML before returning .
*
* @ param string $linktext The text to display instead of the comment author ' s email address
* @ param string $before The text or HTML to display before the email link .
* @ param string $after The text or HTML to display after the email link .
* @ return string The HTML link between the $before and $after parameters
*/
2006-04-19 10:13:28 +00:00
function get_comment_author_url_link ( $linktext = '' , $before = '' , $after = '' ) {
$url = get_comment_author_url ();
$display = ( $linktext != '' ) ? $linktext : $url ;
$display = str_replace ( 'http://www.' , '' , $display );
$display = str_replace ( 'http://' , '' , $display );
if ( '/' == substr ( $display , - 1 ) )
$display = substr ( $display , 0 , - 1 );
$return = " $before <a href=' $url ' rel='external'> $display </a> $after " ;
return apply_filters ( 'get_comment_author_url_link' , $return );
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Displays the HTML link of the url of the author of the current comment .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
* @ see get_comment_author_url_link () Echos result
*
* @ param string $linktext The text to display instead of the comment author ' s email address
* @ param string $before The text or HTML to display before the email link .
* @ param string $after The text or HTML to display after the email link .
*/
2006-04-19 10:13:28 +00:00
function comment_author_url_link ( $linktext = '' , $before = '' , $after = '' ) {
echo get_comment_author_url_link ( $linktext , $before , $after );
}
2008-08-20 23:48:09 +00:00
/**
* Generates semantic classes for each comment element
*
2008-09-24 20:02:41 +00:00
* @ since 2.7 . 0
2008-08-20 23:48:09 +00:00
*
* @ param string | array $class One or more classes to add to the class list
* @ param int $comment_id An optional comment ID
* @ param int $post_id An optional post ID
2008-10-29 22:25:06 +00:00
* @ param bool $echo Whether comment_class should echo or return
2008-08-20 23:48:09 +00:00
*/
2008-09-11 19:25:50 +00:00
function comment_class ( $class = '' , $comment_id = null , $post_id = null , $echo = true ) {
// Separates classes with a single space, collates classes for comment DIV
$class = 'class="' . join ( ' ' , get_comment_class ( $class , $comment_id , $post_id ) ) . '"' ;
if ( $echo )
echo $class ;
else
return $class ;
2008-08-20 23:48:09 +00:00
}
/**
* Returns the classes for the comment div as an array
*
2008-09-24 20:02:41 +00:00
* @ since 2.7 . 0
2008-08-20 23:48:09 +00:00
*
* @ param string | array $class One or more classes to add to the class list
* @ param int $comment_id An optional comment ID
* @ param int $post_id An optional post ID
* @ return array Array of classes
*/
function get_comment_class ( $class = '' , $comment_id = null , $post_id = null ) {
2008-09-24 04:45:50 +00:00
global $comment_alt , $comment_depth , $comment_thread_alt ;
2008-08-20 23:48:09 +00:00
$comment = get_comment ( $comment_id );
$classes = array ();
// Get the comment type (comment, trackback),
2008-10-29 22:25:06 +00:00
$classes [] = ( empty ( $comment -> comment_type ) ) ? 'comment' : $comment -> comment_type ;
2008-08-20 23:48:09 +00:00
// If the comment author has an id (registered), then print the log in name
if ( $comment -> user_id > 0 && $user = get_userdata ( $comment -> user_id ) ) {
// For all registered users, 'byuser'
2009-04-05 17:38:19 +00:00
$classes [] = 'byuser' ;
2009-05-22 21:31:42 +00:00
$classes [] = 'comment-author-' . sanitize_html_class ( $user -> user_nicename , $comment -> user_id );
2008-08-20 23:48:09 +00:00
// For comment authors who are the author of the post
if ( $post = get_post ( $post_id ) ) {
if ( $comment -> user_id === $post -> post_author )
$classes [] = 'bypostauthor' ;
}
}
if ( empty ( $comment_alt ) )
$comment_alt = 0 ;
2008-09-24 04:45:50 +00:00
if ( empty ( $comment_depth ) )
$comment_depth = 1 ;
if ( empty ( $comment_thread_alt ) )
$comment_thread_alt = 0 ;
2008-08-20 23:48:09 +00:00
2008-09-11 19:25:50 +00:00
if ( $comment_alt % 2 ) {
2008-08-20 23:48:09 +00:00
$classes [] = 'odd' ;
2008-09-11 19:25:50 +00:00
$classes [] = 'alt' ;
} else {
2008-08-20 23:48:09 +00:00
$classes [] = 'even' ;
2008-09-11 19:25:50 +00:00
}
2008-08-20 23:48:09 +00:00
$comment_alt ++ ;
2008-09-24 04:45:50 +00:00
// Alt for top-level comments
if ( 1 == $comment_depth ) {
if ( $comment_thread_alt % 2 ) {
$classes [] = 'thread-odd' ;
$classes [] = 'thread-alt' ;
} else {
$classes [] = 'thread-even' ;
}
$comment_thread_alt ++ ;
}
$classes [] = " depth- $comment_depth " ;
2008-08-20 23:48:09 +00:00
if ( ! empty ( $class ) ) {
if ( ! is_array ( $class ) )
$class = preg_split ( '#\s+#' , $class );
$classes = array_merge ( $classes , $class );
}
2009-08-18 16:05:07 +00:00
$classes = array_map ( 'esc_attr' , $classes );
2008-08-20 23:48:09 +00:00
return apply_filters ( 'comment_class' , $classes , $class , $comment_id , $post_id );
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve the comment date of the current comment .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses apply_filters () Calls 'get_comment_date' hook with the formated date and the $d parameter respectively
* @ uses $comment
*
* @ param string $d The format of the date ( defaults to user ' s config )
2010-01-25 17:34:13 +00:00
* @ param int $comment_ID The ID of the comment for which to get the date . Optional .
2007-12-26 17:18:13 +00:00
* @ return string The comment ' s date
*/
2010-01-25 17:34:13 +00:00
function get_comment_date ( $d = '' , $comment_ID = 0 ) {
$comment = get_comment ( $comment_ID );
2006-04-19 10:13:28 +00:00
if ( '' == $d )
2009-05-14 02:00:32 +00:00
$date = mysql2date ( get_option ( 'date_format' ), $comment -> comment_date );
2006-04-19 10:13:28 +00:00
else
$date = mysql2date ( $d , $comment -> comment_date );
2006-11-20 01:46:20 +00:00
return apply_filters ( 'get_comment_date' , $date , $d );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Display the comment date of the current comment .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
*
* @ param string $d The format of the date ( defaults to user ' s config )
2010-01-25 17:34:13 +00:00
* @ param int $comment_ID The ID of the comment for which to print the date . Optional .
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function comment_date ( $d = '' , $comment_ID = 0 ) {
echo get_comment_date ( $d , $comment_ID );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve the excerpt of the current comment .
2007-12-26 17:18:13 +00:00
*
* Will cut each word and only output the first 20 words with '...' at the end .
* If the word count is less than 20 , then no truncating is done and no '...'
* will appear .
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses $comment
* @ uses apply_filters () Calls 'get_comment_excerpt' on truncated comment
*
2010-01-25 17:34:13 +00:00
* @ param int $comment_ID The ID of the comment for which to get the excerpt . Optional .
2007-12-26 17:18:13 +00:00
* @ return string The maybe truncated comment with 20 words or less
*/
2010-01-25 17:34:13 +00:00
function get_comment_excerpt ( $comment_ID = 0 ) {
$comment = get_comment ( $comment_ID );
2006-04-19 10:13:28 +00:00
$comment_text = strip_tags ( $comment -> comment_content );
$blah = explode ( ' ' , $comment_text );
if ( count ( $blah ) > 20 ) {
$k = 20 ;
$use_dotdotdot = 1 ;
} else {
$k = count ( $blah );
$use_dotdotdot = 0 ;
}
$excerpt = '' ;
for ( $i = 0 ; $i < $k ; $i ++ ) {
$excerpt .= $blah [ $i ] . ' ' ;
}
$excerpt .= ( $use_dotdotdot ) ? '...' : '' ;
return apply_filters ( 'get_comment_excerpt' , $excerpt );
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Display the excerpt of the current comment .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.2 . 0
2007-12-26 17:18:13 +00:00
* @ uses apply_filters () Calls 'comment_excerpt' hook before displaying excerpt
2010-01-25 17:34:13 +00:00
*
* @ param int $comment_ID The ID of the comment for which to print the excerpt . Optional .
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function comment_excerpt ( $comment_ID = 0 ) {
2010-04-18 03:45:24 +00:00
echo apply_filters ( 'comment_excerpt' , get_comment_excerpt ( $comment_ID ) );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve the comment id of the current comment .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses $comment
* @ uses apply_filters () Calls the 'get_comment_ID' hook for the comment ID
*
* @ return int The comment ID
*/
2006-04-19 10:13:28 +00:00
function get_comment_ID () {
global $comment ;
return apply_filters ( 'get_comment_ID' , $comment -> comment_ID );
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Displays the comment id of the current comment .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
* @ see get_comment_ID () Echos Result
*/
2006-04-19 10:13:28 +00:00
function comment_ID () {
echo get_comment_ID ();
}
2007-12-26 17:18:13 +00:00
/**
2008-10-27 16:31:26 +00:00
* Retrieve the link to a given comment .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses $comment
*
2008-08-04 22:29:37 +00:00
* @ param object | string | int $comment Comment to retrieve .
2008-11-20 06:41:55 +00:00
* @ param array $args Optional args .
2009-03-13 21:58:18 +00:00
* @ return string The permalink to the given comment .
2007-12-26 17:18:13 +00:00
*/
2008-11-20 06:41:55 +00:00
function get_comment_link ( $comment = null , $args = array () ) {
global $wp_rewrite , $in_comment_loop ;
2008-10-27 16:31:26 +00:00
2008-08-04 22:29:37 +00:00
$comment = get_comment ( $comment );
2008-10-27 16:31:26 +00:00
2008-11-20 06:41:55 +00:00
// Backwards compat
if ( ! is_array ( $args ) ) {
$page = $args ;
$args = array ();
$args [ 'page' ] = $page ;
}
$defaults = array ( 'type' => 'all' , 'page' => '' , 'per_page' => '' , 'max_depth' => '' );
$args = wp_parse_args ( $args , $defaults );
if ( '' === $args [ 'per_page' ] && get_option ( 'page_comments' ) )
2008-12-04 20:26:43 +00:00
$args [ 'per_page' ] = get_option ( 'comments_per_page' );
2008-11-20 06:41:55 +00:00
2009-01-20 20:55:57 +00:00
if ( empty ( $args [ 'per_page' ]) ) {
2008-11-20 06:41:55 +00:00
$args [ 'per_page' ] = 0 ;
$args [ 'page' ] = 0 ;
}
if ( $args [ 'per_page' ] ) {
if ( '' == $args [ 'page' ] )
$args [ 'page' ] = ( ! empty ( $in_comment_loop ) ) ? get_query_var ( 'cpage' ) : get_page_of_comment ( $comment -> comment_ID , $args );
2008-10-27 16:31:26 +00:00
if ( $wp_rewrite -> using_permalinks () )
2009-03-13 21:58:18 +00:00
$link = user_trailingslashit ( trailingslashit ( get_permalink ( $comment -> comment_post_ID ) ) . 'comment-page-' . $args [ 'page' ], 'comment' );
2008-10-27 16:31:26 +00:00
else
2009-03-13 21:58:18 +00:00
$link = add_query_arg ( 'cpage' , $args [ 'page' ], get_permalink ( $comment -> comment_post_ID ) );
2008-10-27 16:31:26 +00:00
} else {
2009-03-13 21:58:18 +00:00
$link = get_permalink ( $comment -> comment_post_ID );
2008-10-27 16:31:26 +00:00
}
2009-03-13 21:58:18 +00:00
return apply_filters ( 'get_comment_link' , $link . '#comment-' . $comment -> comment_ID , $comment , $args );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieves the link to the current post comments .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
*
2010-02-16 17:54:19 +00:00
* @ param int $post_id Optional post id
2007-12-26 17:18:13 +00:00
* @ return string The link to the comments
*/
2010-02-16 17:54:19 +00:00
function get_comments_link ( $post_id = 0 ) {
return get_permalink ( $post_id ) . '#comments' ;
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Displays the link to the current post comments .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
*
2009-12-30 16:23:39 +00:00
* @ param string $deprecated Not Used
2010-01-09 10:03:55 +00:00
* @ param bool $deprecated_2 Not Used
2007-12-26 17:18:13 +00:00
*/
2010-01-09 10:03:55 +00:00
function comments_link ( $deprecated = '' , $deprecated_2 = '' ) {
2009-12-30 16:23:39 +00:00
if ( ! empty ( $deprecated ) )
2010-01-09 10:03:55 +00:00
_deprecated_argument ( __FUNCTION__ , '0.72' );
if ( ! empty ( $deprecated_2 ) )
_deprecated_argument ( __FUNCTION__ , '1.3' );
2007-12-26 17:18:13 +00:00
echo get_comments_link ();
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve the amount of comments a post has .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses apply_filters () Calls the 'get_comments_number' hook on the number of comments
*
* @ param int $post_id The Post ID
* @ return int The number of comments a post has
*/
2006-04-19 10:13:28 +00:00
function get_comments_number ( $post_id = 0 ) {
2008-01-04 19:36:34 +00:00
global $id ;
2006-04-19 10:13:28 +00:00
$post_id = ( int ) $post_id ;
if ( ! $post_id )
2007-03-23 00:59:21 +00:00
$post_id = ( int ) $id ;
2006-04-19 10:13:28 +00:00
$post = get_post ( $post_id );
if ( ! isset ( $post -> comment_count ) )
$count = 0 ;
else
$count = $post -> comment_count ;
2009-09-01 20:27:03 +00:00
return apply_filters ( 'get_comments_number' , $count , $post_id );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Display the language string for the number of comments the current post has .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
* @ uses $id
* @ uses apply_filters () Calls the 'comments_number' hook on the output and number of comments respectively .
*
* @ param string $zero Text for no comments
* @ param string $one Text for one comment
* @ param string $more Text for more than one comment
* @ param string $deprecated Not used .
*/
2007-03-25 23:18:19 +00:00
function comments_number ( $zero = false , $one = false , $more = false , $deprecated = '' ) {
2006-11-19 07:45:28 +00:00
global $id ;
2009-12-30 16:23:39 +00:00
if ( ! empty ( $deprecated ) )
2010-01-09 10:03:55 +00:00
_deprecated_argument ( __FUNCTION__ , '1.3' );
2009-12-30 16:23:39 +00:00
2006-11-19 07:45:28 +00:00
$number = get_comments_number ( $id );
if ( $number > 1 )
2008-05-08 17:54:40 +00:00
$output = str_replace ( '%' , number_format_i18n ( $number ), ( false === $more ) ? __ ( '% Comments' ) : $more );
2006-11-19 07:45:28 +00:00
elseif ( $number == 0 )
$output = ( false === $zero ) ? __ ( 'No Comments' ) : $zero ;
else // must be one
$output = ( false === $one ) ? __ ( '1 Comment' ) : $one ;
echo apply_filters ( 'comments_number' , $output , $number );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve the text of the current comment .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses $comment
*
2010-01-25 17:34:13 +00:00
* @ param int $comment_ID The ID of the comment for which to get the text . Optional .
2007-12-26 17:18:13 +00:00
* @ return string The comment content
*/
2010-01-25 17:34:13 +00:00
function get_comment_text ( $comment_ID = 0 ) {
$comment = get_comment ( $comment_ID );
2006-04-19 10:13:28 +00:00
return apply_filters ( 'get_comment_text' , $comment -> comment_content );
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Displays the text of the current comment .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
* @ uses apply_filters () Passes the comment content through the 'comment_text' hook before display
* @ uses get_comment_text () Gets the comment content
2010-01-25 17:34:13 +00:00
*
* @ param int $comment_ID The ID of the comment for which to print the text . Optional .
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function comment_text ( $comment_ID = 0 ) {
2006-04-19 10:13:28 +00:00
echo apply_filters ( 'comment_text' , get_comment_text () );
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve the comment time of the current comment .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses $comment
* @ uses apply_filter () Calls 'get_comment_time' hook with the formatted time , the $d parameter , and $gmt parameter passed .
*
* @ param string $d Optional . The format of the time ( defaults to user ' s config )
* @ param bool $gmt Whether to use the GMT date
2009-05-14 02:00:32 +00:00
* @ param bool $translate Whether to translate the time ( for use in feeds )
2007-12-26 17:18:13 +00:00
* @ return string The formatted time
*/
2009-05-14 02:00:32 +00:00
function get_comment_time ( $d = '' , $gmt = false , $translate = true ) {
2006-04-19 10:13:28 +00:00
global $comment ;
2009-12-14 10:21:58 +00:00
$comment_date = $gmt ? $comment -> comment_date_gmt : $comment -> comment_date ;
2006-04-19 10:13:28 +00:00
if ( '' == $d )
2009-05-14 02:00:32 +00:00
$date = mysql2date ( get_option ( 'time_format' ), $comment_date , $translate );
2006-04-19 10:13:28 +00:00
else
2009-05-14 02:00:32 +00:00
$date = mysql2date ( $d , $comment_date , $translate );
2009-12-14 10:21:58 +00:00
return apply_filters ( 'get_comment_time' , $date , $d , $gmt , $translate );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Display the comment time of the current comment .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
*
* @ param string $d Optional . The format of the time ( defaults to user ' s config )
*/
2006-04-19 10:13:28 +00:00
function comment_time ( $d = '' ) {
echo get_comment_time ( $d );
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve the comment type of the current comment .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses $comment
* @ uses apply_filters () Calls the 'get_comment_type' hook on the comment type
*
2010-01-25 17:34:13 +00:00
* @ param int $comment_ID The ID of the comment for which to get the type . Optional .
2007-12-26 17:18:13 +00:00
* @ return string The comment type
*/
2010-01-25 17:34:13 +00:00
function get_comment_type ( $comment_ID = 0 ) {
$comment = get_comment ( $comment_ID );
2006-04-19 10:13:28 +00:00
if ( '' == $comment -> comment_type )
$comment -> comment_type = 'comment' ;
return apply_filters ( 'get_comment_type' , $comment -> comment_type );
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Display the comment type of the current comment .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
*
* @ param string $commenttxt The string to display for comment type
* @ param string $trackbacktxt The string to display for trackback type
* @ param string $pingbacktxt The string to display for pingback type
*/
2009-04-16 18:51:50 +00:00
function comment_type ( $commenttxt = false , $trackbacktxt = false , $pingbacktxt = false ) {
if ( false === $commenttxt ) $commenttxt = _x ( 'Comment' , 'noun' );
if ( false === $trackbacktxt ) $trackbacktxt = __ ( 'Trackback' );
if ( false === $pingbacktxt ) $pingbacktxt = __ ( 'Pingback' );
2006-04-19 10:13:28 +00:00
$type = get_comment_type ();
switch ( $type ) {
case 'trackback' :
echo $trackbacktxt ;
break ;
case 'pingback' :
echo $pingbacktxt ;
break ;
default :
echo $commenttxt ;
}
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Retrieve The current post ' s trackback URL .
2007-12-26 17:18:13 +00:00
*
2008-06-22 20:23:23 +00:00
* There is a check to see if permalink ' s have been enabled and if so , will
* retrieve the pretty path . If permalinks weren ' t enabled , the ID of the
* current post is used and appended to the correct page to go to .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses apply_filters () Calls 'trackback_url' on the resulting trackback URL
* @ uses $id
*
* @ return string The trackback URL after being filtered
*/
2006-04-19 10:13:28 +00:00
function get_trackback_url () {
global $id ;
2007-08-29 23:08:44 +00:00
if ( '' != get_option ( 'permalink_structure' ) ) {
2007-03-10 06:18:43 +00:00
$tb_url = trailingslashit ( get_permalink ()) . user_trailingslashit ( 'trackback' , 'single_trackback' );
2007-08-29 23:08:44 +00:00
} else {
$tb_url = get_option ( 'siteurl' ) . '/wp-trackback.php?p=' . $id ;
}
2007-03-26 23:40:49 +00:00
return apply_filters ( 'trackback_url' , $tb_url );
2006-04-19 10:13:28 +00:00
}
2007-08-29 23:08:44 +00:00
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Displays the current post ' s trackback URL .
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
* @ uses get_trackback_url () Gets the trackback url for the current post
*
2009-12-30 16:23:39 +00:00
* @ param bool $deprecated_echo Remove backwards compat in 2.5
2007-12-26 17:18:13 +00:00
* @ return void | string Should only be used to echo the trackback URL , use get_trackback_url () for the result instead .
*/
2009-12-30 16:23:39 +00:00
function trackback_url ( $deprecated_echo = true ) {
if ( $deprecated_echo !== true )
2010-04-11 10:41:54 +00:00
_deprecated_argument ( __FUNCTION__ , '2.5' , __ ( 'Use <code>get_trackback_url()</code> instead if you do not want the value echoed.' ) );
2009-12-30 16:23:39 +00:00
if ( $deprecated_echo )
echo get_trackback_url ();
else
return get_trackback_url ();
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Whether the current post is open for comments .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ uses $post
*
2008-02-04 20:27:45 +00:00
* @ param int $post_id An optional post ID to check instead of the current post .
2007-12-26 17:18:13 +00:00
* @ return bool True if the comments are open
*/
2008-02-04 20:27:45 +00:00
function comments_open ( $post_id = NULL ) {
$_post = get_post ( $post_id );
2008-02-05 06:47:27 +00:00
2008-02-04 20:27:45 +00:00
$open = ( 'open' == $_post -> comment_status );
return apply_filters ( 'comments_open' , $open , $post_id );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Whether the current post is open for pings .
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2008-02-05 06:47:27 +00:00
* @ uses $post
2007-12-26 17:18:13 +00:00
*
2008-02-04 20:27:45 +00:00
* @ param int $post_id An optional post ID to check instead of the current post .
2007-12-26 17:18:13 +00:00
* @ return bool True if pings are accepted
*/
2008-02-13 06:39:45 +00:00
function pings_open ( $post_id = NULL ) {
2008-02-04 20:27:45 +00:00
$_post = get_post ( $post_id );
2008-02-13 06:39:45 +00:00
$open = ( 'open' == $_post -> ping_status );
2008-02-04 20:27:45 +00:00
return apply_filters ( 'pings_open' , $open , $post_id );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Displays form token for unfiltered comments .
2007-12-26 17:18:13 +00:00
*
2008-06-22 20:23:23 +00:00
* Will only display nonce token if the current user has permissions for
* unfiltered html . Won ' t display the token for other users .
2007-12-26 17:18:13 +00:00
*
2008-06-22 20:23:23 +00:00
* The function was backported to 2.0 . 10 and was added to versions 2.1 . 3 and
* above . Does not exist in versions prior to 2.0 . 10 in the 2.0 branch and in
* the 2.1 branch , prior to 2.1 . 3. Technically added in 2.2 . 0.
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* Backported to 2.0 . 10.
*
2007-12-26 17:18:13 +00:00
* @ since 2.1 . 3
* @ uses $post Gets the ID of the current post for the token
*/
2007-03-14 23:10:57 +00:00
function wp_comment_form_unfiltered_html_nonce () {
global $post ;
2008-11-06 01:58:33 +00:00
$post_id = 0 ;
if ( ! empty ( $post ) )
$post_id = $post -> ID ;
2007-03-14 23:10:57 +00:00
if ( current_user_can ( 'unfiltered_html' ) )
2008-11-06 01:58:33 +00:00
wp_nonce_field ( 'unfiltered-html-comment_' . $post_id , '_wp_unfiltered_html_comment' , false );
2007-03-14 23:10:57 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Loads the comment template specified in $file .
2007-12-26 17:18:13 +00:00
*
2008-06-22 20:23:23 +00:00
* Will not display the comments template if not on single post or page , or if
* the post does not have comments .
2007-12-26 17:18:13 +00:00
*
* Uses the WordPress database object to query for the comments . The comments
* are passed through the 'comments_array' filter hook with the list of comments
* and the post ID respectively .
*
* The $file path is passed through a filter hook called , 'comments_template'
* which includes the TEMPLATEPATH and $file combined . Tries the $filtered path
* first and if it fails it will require the default comment themplate from the
* default theme . If either does not exist , then the WordPress process will be
* halted . It is advised for that reason , that the default theme is not deleted .
*
2008-09-24 20:02:41 +00:00
* @ since 1.5 . 0
2007-12-26 17:18:13 +00:00
* @ global array $comment List of comment objects for the current post
* @ uses $wpdb
* @ uses $id
* @ uses $post
* @ uses $withcomments Will not try to get the comments if the post has none .
*
* @ param string $file Optional , default '/comments.php' . The file to load
2008-12-09 18:03:31 +00:00
* @ param bool $separate_comments Optional , whether to separate the comments by comment type . Default is false .
2007-12-26 17:18:13 +00:00
* @ return null Returns null if no comments appear
*/
2008-10-06 23:16:26 +00:00
function comments_template ( $file = '/comments.php' , $separate_comments = false ) {
2008-10-24 07:27:19 +00:00
global $wp_query , $withcomments , $post , $wpdb , $id , $comment , $user_login , $user_ID , $user_identity , $overridden_cpage ;
2006-04-19 10:13:28 +00:00
2009-08-18 19:33:56 +00:00
if ( ! ( is_single () || is_page () || $withcomments ) || empty ( $post ) )
2006-06-22 20:52:12 +00:00
return ;
2008-10-06 23:16:26 +00:00
if ( empty ( $file ) )
$file = '/comments.php' ;
2010-01-26 22:49:05 +00:00
2006-08-30 21:46:31 +00:00
$req = get_option ( 'require_name_email' );
2009-07-20 01:11:14 +00:00
/**
2009-07-20 01:41:05 +00:00
* Comment author information fetched from the comment cookies .
2009-07-20 01:11:14 +00:00
*
* @ uses wp_get_current_commenter ()
*/
2006-06-22 20:52:12 +00:00
$commenter = wp_get_current_commenter ();
2009-07-20 01:11:14 +00:00
/**
2009-07-20 01:41:05 +00:00
* The name of the current comment author escaped for use in attributes .
2009-07-20 01:11:14 +00:00
*/
2009-07-20 01:41:05 +00:00
$comment_author = $commenter [ 'comment_author' ]; // Escaped by sanitize_comment_cookies()
2009-07-20 01:11:14 +00:00
/**
2009-07-20 01:41:05 +00:00
* The email address of the current comment author escaped for use in attributes .
2009-09-14 14:03:32 +00:00
*/
2009-07-20 01:41:05 +00:00
$comment_author_email = $commenter [ 'comment_author_email' ]; // Escaped by sanitize_comment_cookies()
2009-07-20 01:11:14 +00:00
/**
2009-07-20 01:41:05 +00:00
* The url of the current comment author escaped for use in attributes .
2009-09-14 14:03:32 +00:00
*/
2009-07-20 01:41:05 +00:00
$comment_author_url = esc_url ( $commenter [ 'comment_author_url' ]);
2006-04-19 10:13:28 +00:00
2007-12-26 17:18:13 +00:00
/** @todo Use API instead of SELECTs. */
2007-04-11 03:12:11 +00:00
if ( $user_ID ) {
2009-03-06 08:16:35 +00:00
$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 ));
2007-09-03 23:32:58 +00:00
} else if ( empty ( $comment_author ) ) {
2009-03-06 08:16:35 +00:00
$comments = get_comments ( array ( 'post_id' => $post -> ID , 'status' => 'approve' , 'order' => 'ASC' ) );
2006-04-19 10:13:28 +00:00
} else {
2009-05-06 20:24:57 +00:00
$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 ));
2006-04-19 10:13:28 +00:00
}
2008-10-06 23:16:26 +00:00
// keep $comments for legacy's sake
2008-09-16 00:23:38 +00:00
$wp_query -> comments = apply_filters ( 'comments_array' , $comments , $post -> ID );
$comments = & $wp_query -> comments ;
2007-02-24 07:33:29 +00:00
$wp_query -> comment_count = count ( $wp_query -> comments );
2008-09-16 00:23:38 +00:00
update_comment_cache ( $wp_query -> comments );
2006-12-01 03:30:26 +00:00
2008-10-06 23:16:26 +00:00
if ( $separate_comments ) {
$wp_query -> comments_by_type = & separate_comments ( $comments );
$comments_by_type = & $wp_query -> comments_by_type ;
}
2008-10-24 07:27:19 +00:00
$overridden_cpage = FALSE ;
2008-12-12 20:08:49 +00:00
if ( '' == get_query_var ( 'cpage' ) && get_option ( 'page_comments' ) ) {
set_query_var ( 'cpage' , 'newest' == get_option ( 'default_comments_page' ) ? get_comment_pages_count () : 1 );
2008-10-24 07:27:19 +00:00
$overridden_cpage = TRUE ;
}
2008-10-23 16:08:47 +00:00
2009-04-16 18:51:50 +00:00
if ( ! defined ( 'COMMENTS_TEMPLATE' ) || ! COMMENTS_TEMPLATE )
define ( 'COMMENTS_TEMPLATE' , true );
2008-08-09 05:36:14 +00:00
2008-07-30 06:21:14 +00:00
$include = apply_filters ( 'comments_template' , STYLESHEETPATH . $file );
2006-04-19 10:13:28 +00:00
if ( file_exists ( $include ) )
require ( $include );
2008-07-30 06:21:14 +00:00
elseif ( file_exists ( TEMPLATEPATH . $file ) )
require ( TEMPLATEPATH . $file );
2006-04-19 10:13:28 +00:00
else
2010-04-13 21:56:57 +00:00
require ( get_theme_root () . '/' . WP_FALLBACK_THEME . '/comments.php' );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2008-06-22 20:23:23 +00:00
* Displays the JS popup script to show a comment .
2007-12-26 17:18:13 +00:00
*
* If the $file parameter is empty , then the home page is assumed . The defaults
* for the window are 400 px by 400 px .
*
* For the comment link popup to work , this function has to be called or the
* normal comment link will be assumed .
*
* @ since 0.71
* @ global string $wpcommentspopupfile The URL to use for the popup window
2010-02-24 20:13:23 +00:00
* @ global int $wpcommentsjavascript Whether to use JavaScript . Set when function is called
2007-12-26 17:18:13 +00:00
*
* @ param int $width Optional . The width of the popup window
* @ param int $height Optional . The height of the popup window
* @ param string $file Optional . Sets the location of the popup window
*/
2006-04-19 10:13:28 +00:00
function comments_popup_script ( $width = 400 , $height = 400 , $file = '' ) {
2007-12-26 17:18:13 +00:00
global $wpcommentspopupfile , $wpcommentsjavascript ;
2006-04-19 10:13:28 +00:00
2007-12-26 17:18:13 +00:00
if ( empty ( $file )) {
$wpcommentspopupfile = '' ; // Use the index.
} else {
$wpcommentspopupfile = $file ;
}
2006-04-19 10:13:28 +00:00
2007-12-26 17:18:13 +00:00
$wpcommentsjavascript = 1 ;
$javascript = " <script type='text/javascript'> \n function wpopen (macagna) { \n window.open(macagna, '_blank', 'width= $width ,height= $height ,scrollbars=yes,status=yes'); \n } \n </script> \n " ;
echo $javascript ;
}
/**
2008-06-22 20:23:23 +00:00
* Displays the link to the comments popup window for the current post ID .
2007-12-26 17:18:13 +00:00
*
2008-06-22 20:23:23 +00:00
* Is not meant to be displayed on single posts and pages . Should be used on the
* lists of posts
2007-12-26 17:18:13 +00:00
*
* @ since 0.71
* @ uses $id
* @ uses $wpcommentspopupfile
* @ uses $wpcommentsjavascript
* @ uses $post
*
* @ param string $zero The string to display when no comments
* @ param string $one The string to display when only one comment is available
* @ param string $more The string to display when there are more than one comment
* @ param string $css_class The CSS class to use for comments
* @ param string $none The string to display when comments have been turned off
* @ return null Returns null on single posts and pages .
*/
2009-04-16 18:51:50 +00:00
function comments_popup_link ( $zero = false , $one = false , $more = false , $css_class = '' , $none = false ) {
2010-02-20 02:01:46 +00:00
global $id , $wpcommentspopupfile , $wpcommentsjavascript ;
2009-04-20 18:18:39 +00:00
2009-04-16 18:51:50 +00:00
if ( false === $zero ) $zero = __ ( 'No Comments' );
if ( false === $one ) $one = __ ( '1 Comment' );
if ( false === $more ) $more = __ ( '% Comments' );
if ( false === $none ) $none = __ ( 'Comments Off' );
2009-04-20 18:18:39 +00:00
2007-12-10 20:49:46 +00:00
$number = get_comments_number ( $id );
2006-04-19 10:13:28 +00:00
2009-04-17 07:02:55 +00:00
if ( 0 == $number && ! comments_open () && ! pings_open () ) {
2009-08-18 16:05:07 +00:00
echo '<span' . (( ! empty ( $css_class )) ? ' class="' . esc_attr ( $css_class ) . '"' : '' ) . '>' . $none . '</span>' ;
2006-04-19 10:13:28 +00:00
return ;
}
2008-09-03 19:54:14 +00:00
if ( post_password_required () ) {
2010-01-21 21:37:43 +00:00
echo __ ( 'Enter your password to view comments.' );
2008-09-03 19:54:14 +00:00
return ;
2006-04-19 10:13:28 +00:00
}
2007-12-10 20:49:46 +00:00
echo '<a href="' ;
if ( $wpcommentsjavascript ) {
if ( empty ( $wpcommentspopupfile ) )
2010-01-04 17:23:29 +00:00
$home = home_url ();
2006-04-19 10:13:28 +00:00
else
2006-08-30 21:46:31 +00:00
$home = get_option ( 'siteurl' );
2007-12-10 20:49:46 +00:00
echo $home . '/' . $wpcommentspopupfile . '?comments_popup=' . $id ;
echo '" onclick="wpopen(this.href); return false"' ;
2006-04-19 10:13:28 +00:00
} else { // if comments_popup_script() is not in the template, display simple comment link
if ( 0 == $number )
2007-12-10 20:49:46 +00:00
echo get_permalink () . '#respond' ;
2006-04-19 10:13:28 +00:00
else
2007-12-10 20:49:46 +00:00
comments_link ();
echo '"' ;
2006-04-19 10:13:28 +00:00
}
2007-12-10 20:49:46 +00:00
if ( ! empty ( $css_class ) ) {
echo ' class="' . $css_class . '" ' ;
2006-04-19 10:13:28 +00:00
}
2010-01-08 08:34:39 +00:00
$title = the_title_attribute ( array ( 'echo' => 0 ) );
2008-02-05 06:47:27 +00:00
2007-12-10 20:49:46 +00:00
echo apply_filters ( 'comments_popup_link_attributes' , '' );
2009-08-18 16:05:07 +00:00
echo ' title="' . esc_attr ( sprintf ( __ ( 'Comment on %s' ), $title ) ) . '">' ;
2009-12-30 16:54:28 +00:00
comments_number ( $zero , $one , $more );
2007-12-10 20:49:46 +00:00
echo '</a>' ;
2006-04-19 10:13:28 +00:00
}
2008-09-24 20:02:41 +00:00
/**
* Retrieve HTML content for reply to comment link .
*
* The default arguments that can be override are 'add_below' , 'respond_id' ,
* 'reply_text' , 'login_text' , and 'depth' . The 'login_text' argument will be
* used , if the user must log in or register first before posting a comment . The
* 'reply_text' will be used , if they can post a reply . The 'add_below' and
* 'respond_id' arguments are for the JavaScript moveAddCommentForm () function
* parameters .
*
* @ since 2.7 . 0
*
* @ param array $args Optional . Override default options .
* @ param int $comment Optional . Comment being replied to .
* @ param int $post Optional . Post that the comment is going to be displayed on .
* @ return string | bool | null Link to show comment form , if successful . False , if comments are closed .
*/
2008-10-29 22:56:48 +00:00
function get_comment_reply_link ( $args = array (), $comment = null , $post = null ) {
2008-09-11 19:25:50 +00:00
global $user_ID ;
$defaults = array ( 'add_below' => 'comment' , 'respond_id' => 'respond' , 'reply_text' => __ ( 'Reply' ),
2008-10-07 18:03:43 +00:00
'login_text' => __ ( 'Log in to Reply' ), 'depth' => 0 , 'before' => '' , 'after' => '' );
2008-09-11 19:25:50 +00:00
$args = wp_parse_args ( $args , $defaults );
2008-09-23 21:11:27 +00:00
if ( 0 == $args [ 'depth' ] || $args [ 'max_depth' ] <= $args [ 'depth' ] )
2008-09-16 00:24:43 +00:00
return ;
2008-09-12 23:45:15 +00:00
2008-09-11 19:25:50 +00:00
extract ( $args , EXTR_SKIP );
$comment = get_comment ( $comment );
2010-02-25 07:56:25 +00:00
if ( empty ( $post ) )
$post = $comment -> comment_post_ID ;
2008-09-11 19:25:50 +00:00
$post = get_post ( $post );
2009-04-17 07:02:55 +00:00
if ( ! comments_open ( $post -> ID ) )
2008-09-11 19:25:50 +00:00
return false ;
$link = '' ;
if ( get_option ( 'comment_registration' ) && ! $user_ID )
2009-05-18 16:00:33 +00:00
$link = '<a rel="nofollow" class="comment-reply-login" href="' . esc_url ( wp_login_url ( get_permalink () ) ) . '">' . $login_text . '</a>' ;
2008-12-09 18:03:31 +00:00
else
2009-05-18 16:00:33 +00:00
$link = " <a rel='nofollow' class='comment-reply-link' href=' " . esc_url ( add_query_arg ( 'replytocom' , $comment -> comment_ID ) ) . " # " . $respond_id . " ' onclick='return addComment.moveForm( \" $add_below - $comment->comment_ID\ " , \ " $comment->comment_ID\ " , \ " $respond_id\ " , \ " $post->ID\ " ) ' > $reply_text </ a > " ;
2008-10-29 22:56:48 +00:00
return apply_filters ( 'comment_reply_link' , $before . $link . $after , $args , $comment , $post );
2008-09-11 19:25:50 +00:00
}
2008-09-24 20:02:41 +00:00
/**
2008-10-29 22:56:48 +00:00
* Displays the HTML content for reply to comment link .
2008-09-24 20:02:41 +00:00
*
* @ since 2.7 . 0
2008-10-29 22:56:48 +00:00
* @ see get_comment_reply_link () Echoes result
*
* @ param array $args Optional . Override default options .
* @ param int $comment Optional . Comment being replied to .
* @ param int $post Optional . Post that the comment is going to be displayed on .
* @ return string | bool | null Link to show comment form , if successful . False , if comments are closed .
*/
function comment_reply_link ( $args = array (), $comment = null , $post = null ) {
echo get_comment_reply_link ( $args , $comment , $post );
}
2008-12-10 21:06:13 +00:00
2008-12-10 11:49:37 +00:00
/**
* Retrieve HTML content for reply to post link .
*
* The default arguments that can be override are 'add_below' , 'respond_id' ,
* 'reply_text' , 'login_text' , and 'depth' . The 'login_text' argument will be
* used , if the user must log in or register first before posting a comment . The
* 'reply_text' will be used , if they can post a reply . The 'add_below' and
* 'respond_id' arguments are for the JavaScript moveAddCommentForm () function
* parameters .
*
* @ since 2.7 . 0
*
* @ param array $args Optional . Override default options .
2008-12-10 21:06:13 +00:00
* @ param int | object $post Optional . Post that the comment is going to be displayed on . Defaults to current post .
2008-12-10 11:49:37 +00:00
* @ return string | bool | null Link to show comment form , if successful . False , if comments are closed .
*/
2008-12-10 21:06:13 +00:00
function get_post_reply_link ( $args = array (), $post = null ) {
2008-12-10 11:49:37 +00:00
global $user_ID ;
2008-12-10 21:08:20 +00:00
$defaults = array ( 'add_below' => 'post' , 'respond_id' => 'respond' , 'reply_text' => __ ( 'Leave a Comment' ),
2008-12-10 11:49:37 +00:00
'login_text' => __ ( 'Log in to leave a Comment' ), 'before' => '' , 'after' => '' );
$args = wp_parse_args ( $args , $defaults );
extract ( $args , EXTR_SKIP );
$post = get_post ( $post );
2009-03-18 02:43:45 +00:00
2008-12-10 21:06:13 +00:00
if ( ! comments_open ( $post -> ID ) )
2008-12-10 11:49:37 +00:00
return false ;
if ( get_option ( 'comment_registration' ) && ! $user_ID ) {
2009-04-14 18:31:49 +00:00
$link = '<a rel="nofollow" href="' . wp_login_url ( get_permalink () ) . '">' . $login_text . '</a>' ;
2008-12-10 11:49:37 +00:00
} else {
2009-01-10 10:21:28 +00:00
$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 > " ;
2008-12-10 11:49:37 +00:00
}
return apply_filters ( 'post_comments_link' , $before . $link . $after , $post );
}
/**
* Displays the HTML content for reply to post link .
* @ since 2.7 . 0
2008-12-10 21:06:13 +00:00
* @ see get_post_reply_link ()
2008-12-10 11:49:37 +00:00
*
* @ param array $args Optional . Override default options .
2008-12-10 21:06:13 +00:00
* @ param int | object $post Optional . Post that the comment is going to be displayed on .
2008-12-10 11:49:37 +00:00
* @ return string | bool | null Link to show comment form , if successful . False , if comments are closed .
*/
2008-12-10 21:06:13 +00:00
function post_reply_link ( $args = array (), $post = null ) {
2008-12-10 21:13:32 +00:00
echo get_post_reply_link ( $args , $post );
2008-12-10 11:49:37 +00:00
}
2008-10-29 22:56:48 +00:00
/**
* Retrieve HTML content for cancel comment reply link .
2008-09-24 20:02:41 +00:00
*
2008-10-29 22:56:48 +00:00
* @ since 2.7 . 0
2008-12-09 18:03:31 +00:00
*
2008-10-09 07:37:05 +00:00
* @ param string $text Optional . Text to display for cancel reply link .
2008-09-24 20:02:41 +00:00
*/
2008-10-29 22:56:48 +00:00
function get_cancel_comment_reply_link ( $text = '' ) {
2008-09-11 19:25:50 +00:00
if ( empty ( $text ) )
$text = __ ( 'Click here to cancel reply.' );
2008-12-09 18:03:31 +00:00
2008-10-09 07:37:05 +00:00
$style = isset ( $_GET [ 'replytocom' ]) ? '' : ' style="display:none;"' ;
2009-05-18 15:11:07 +00:00
$link = esc_html ( remove_query_arg ( 'replytocom' ) ) . '#respond' ;
2008-10-29 22:56:48 +00:00
return apply_filters ( 'cancel_comment_reply_link' , '<a rel="nofollow" id="cancel-comment-reply-link" href="' . $link . '"' . $style . '>' . $text . '</a>' , $link , $text );
}
2008-10-09 07:37:05 +00:00
2008-10-29 22:56:48 +00:00
/**
* Display HTML content for cancel comment reply link .
*
* @ since 2.7 . 0
*
* @ param string $text Optional . Text to display for cancel reply link .
*/
function cancel_comment_reply_link ( $text = '' ) {
echo get_cancel_comment_reply_link ( $text );
2008-10-09 07:37:05 +00:00
}
/**
2010-04-11 08:56:18 +00:00
* Retrieve hidden input HTML for replying to comments .
2008-10-09 07:37:05 +00:00
*
2010-04-11 15:23:20 +00:00
* @ since 3.0 . 0
*
2010-04-11 08:56:18 +00:00
* @ return string Hidden input HTML for replying to comments
2008-10-09 07:37:05 +00:00
*/
2010-04-11 08:56:18 +00:00
function get_comment_id_fields () {
2008-10-14 19:06:18 +00:00
global $id ;
2008-10-09 07:37:05 +00:00
$replytoid = isset ( $_GET [ 'replytocom' ]) ? ( int ) $_GET [ 'replytocom' ] : 0 ;
2010-04-11 08:56:18 +00:00
$result = " <input type='hidden' name='comment_post_ID' value=' $id ' id='comment_post_ID' /> \n " ;
$result .= " <input type='hidden' name='comment_parent' id='comment_parent' value=' $replytoid ' /> \n " ;
return apply_filters ( 'comment_id_fields' , $result , $id , $replytoid );
}
/**
* Output hidden input HTML for replying to comments .
*
* @ since 2.7 . 0
* @ see get_comment_id_fields () Echoes result
*/
function comment_id_fields () {
echo get_comment_id_fields ();
2008-10-09 07:37:05 +00:00
}
/**
* Display text based on comment reply status . Only affects users with Javascript disabled .
*
* @ since 2.7 . 0
*
* @ param string $noreplytext Optional . Text to display when not replying to a comment .
* @ param string $replytext Optional . Text to display when replying to a comment . Accepts " %s " for the author of the comment being replied to .
* @ param string $linktoparent Optional . Boolean to control making the author ' s name a link to their comment .
*/
2009-04-16 18:51:50 +00:00
function comment_form_title ( $noreplytext = false , $replytext = false , $linktoparent = TRUE ) {
2008-10-09 07:37:05 +00:00
global $comment ;
2009-04-20 18:18:39 +00:00
2009-04-16 18:51:50 +00:00
if ( false === $noreplytext ) $noreplytext = __ ( 'Leave a Reply' );
if ( false === $replytext ) $replytext = __ ( 'Leave a Reply to %s' );
2008-10-09 07:37:05 +00:00
$replytoid = isset ( $_GET [ 'replytocom' ]) ? ( int ) $_GET [ 'replytocom' ] : 0 ;
if ( 0 == $replytoid )
echo $noreplytext ;
else {
$comment = get_comment ( $replytoid );
$author = ( $linktoparent ) ? '<a href="#comment-' . get_comment_ID () . '">' . get_comment_author () . '</a>' : get_comment_author ();
printf ( $replytext , $author );
}
2008-09-11 19:25:50 +00:00
}
2008-09-24 20:02:41 +00:00
/**
* HTML comment list class .
*
* @ package WordPress
* @ uses Walker
* @ since unknown
*/
2008-09-11 19:25:50 +00:00
class Walker_Comment extends Walker {
2008-09-24 20:02:41 +00:00
/**
* @ see Walker :: $tree_type
* @ since unknown
* @ var string
*/
2008-09-11 19:25:50 +00:00
var $tree_type = 'comment' ;
2008-09-24 20:02:41 +00:00
/**
* @ see Walker :: $db_fields
* @ since unknown
* @ var array
*/
2008-09-11 19:25:50 +00:00
var $db_fields = array ( 'parent' => 'comment_parent' , 'id' => 'comment_ID' );
2008-09-24 20:02:41 +00:00
/**
* @ see Walker :: start_lvl ()
* @ since unknown
*
* @ param string $output Passed by reference . Used to append additional content .
* @ param int $depth Depth of comment .
* @ param array $args Uses 'style' argument for type of HTML list .
*/
2008-09-11 19:25:50 +00:00
function start_lvl ( & $output , $depth , $args ) {
2008-09-24 04:45:50 +00:00
$GLOBALS [ 'comment_depth' ] = $depth + 1 ;
2008-09-12 19:18:39 +00:00
switch ( $args [ 'style' ] ) {
case 'div' :
break ;
case 'ol' :
echo " <ol class='children'> \n " ;
break ;
default :
case 'ul' :
echo " <ul class='children'> \n " ;
break ;
}
2008-09-11 19:25:50 +00:00
}
2008-09-24 20:02:41 +00:00
/**
* @ see Walker :: end_lvl ()
* @ since unknown
*
* @ param string $output Passed by reference . Used to append additional content .
* @ param int $depth Depth of comment .
* @ param array $args Will only append content if style argument value is 'ol' or 'ul' .
*/
2008-09-11 19:25:50 +00:00
function end_lvl ( & $output , $depth , $args ) {
2008-09-24 04:45:50 +00:00
$GLOBALS [ 'comment_depth' ] = $depth + 1 ;
2008-09-12 19:18:39 +00:00
switch ( $args [ 'style' ] ) {
case 'div' :
break ;
case 'ol' :
echo " </ol> \n " ;
break ;
default :
case 'ul' :
echo " </ul> \n " ;
break ;
}
2008-09-11 19:25:50 +00:00
}
2010-04-02 04:05:01 +00:00
/**
2010-04-02 05:33:18 +00:00
* This function is designed to enhance Walker :: display_element () to
* display children of higher nesting levels than selected inline on
* the highest depth level displayed . This prevents them being orphaned
* at the end of the comment list .
2010-04-02 04:05:01 +00:00
*
* Example : max_depth = 2 , with 5 levels of nested content .
* 1
* 1.1
* 1.1 . 1
* 1.1 . 1.1
* 1.1 . 1.1 . 1
* 1.1 . 2
* 1.1 . 2.1
* 2
* 2.2
*
*/
function display_element ( $element , & $children_elements , $max_depth , $depth = 0 , $args , & $output ) {
if ( ! $element )
return ;
$id_field = $this -> db_fields [ 'id' ];
$id = $element -> $id_field ;
2010-04-02 05:33:18 +00:00
parent :: display_element ( $element , $children_elements , $max_depth , $depth , $args , $output );
2010-04-02 05:13:57 +00:00
2010-04-02 05:33:18 +00:00
// If we're at the max depth, and the current element still has children, loop over those and display them at this level
// This is to prevent them being orphaned to the end of the list.
2010-04-02 05:13:57 +00:00
if ( $max_depth <= $depth + 1 && isset ( $children_elements [ $id ]) ) {
2010-04-02 05:33:18 +00:00
foreach ( $children_elements [ $id ] as $child )
2010-04-02 05:13:57 +00:00
$this -> display_element ( $child , $children_elements , $max_depth , $depth , $args , $output );
2010-04-02 05:33:18 +00:00
2010-04-02 05:13:57 +00:00
unset ( $children_elements [ $id ] );
}
2010-04-02 04:05:01 +00:00
}
2008-09-24 20:02:41 +00:00
/**
* @ see Walker :: start_el ()
* @ since unknown
*
* @ param string $output Passed by reference . Used to append additional content .
* @ param object $comment Comment data object .
* @ param int $depth Depth of comment in reference to parents .
* @ param array $args
*/
2008-09-11 19:25:50 +00:00
function start_el ( & $output , $comment , $depth , $args ) {
$depth ++ ;
2008-09-24 04:45:50 +00:00
$GLOBALS [ 'comment_depth' ] = $depth ;
2008-09-11 19:25:50 +00:00
if ( ! empty ( $args [ 'callback' ]) ) {
call_user_func ( $args [ 'callback' ], $comment , $args , $depth );
return ;
}
$GLOBALS [ 'comment' ] = $comment ;
extract ( $args , EXTR_SKIP );
2008-09-24 04:45:50 +00:00
if ( 'div' == $args [ 'style' ] ) {
2008-09-11 19:25:50 +00:00
$tag = 'div' ;
2008-09-24 04:45:50 +00:00
$add_below = 'comment' ;
} else {
2008-09-11 19:25:50 +00:00
$tag = 'li' ;
2008-09-24 04:45:50 +00:00
$add_below = 'div-comment' ;
}
2008-09-11 19:25:50 +00:00
?>
2008-11-20 13:36:44 +00:00
<< ? php echo $tag ?> <?php comment_class(empty( $args['has_children'] ) ? '' : 'parent') ?> id="comment-<?php comment_ID() ?>">
2009-10-15 21:47:35 +00:00
< ? php if ( 'div' != $args [ 'style' ] ) : ?>
2009-04-16 22:15:12 +00:00
< div id = " div-comment-<?php comment_ID() ?> " class = " comment-body " >
2008-09-11 19:25:50 +00:00
< ? php endif ; ?>
< div class = " comment-author vcard " >
2008-10-16 20:05:34 +00:00
< ? php if ( $args [ 'avatar_size' ] != 0 ) echo get_avatar ( $comment , $args [ 'avatar_size' ] ); ?>
2008-11-24 02:13:31 +00:00
< ? php printf ( __ ( '<cite class="fn">%s</cite> <span class="says">says:</span>' ), get_comment_author_link ()) ?>
2008-09-11 19:25:50 +00:00
</ div >
< ? php if ( $comment -> comment_approved == '0' ) : ?>
< em >< ? php _e ( 'Your comment is awaiting moderation.' ) ?> </em>
< br />
< ? php endif ; ?>
2010-01-21 21:37:43 +00:00
< div class = " comment-meta commentmetadata " >< a href = " <?php echo htmlspecialchars( get_comment_link( $comment->comment_ID ) ) ?> " >
< ? php
/* translators: 1: date, 2: time */
printf ( __ ( '%1$s at %2$s' ), get_comment_date (), get_comment_time ()) ?> </a><?php edit_comment_link(__('(Edit)'),' ','' );
?>
</ div >
2008-09-11 19:25:50 +00:00
2008-10-28 16:17:48 +00:00
< ? php comment_text () ?>
2008-09-11 19:25:50 +00:00
2008-10-09 07:37:05 +00:00
< div class = " reply " >
2008-10-31 02:58:22 +00:00
< ? php comment_reply_link ( array_merge ( $args , array ( 'add_below' => $add_below , 'depth' => $depth , 'max_depth' => $args [ 'max_depth' ]))) ?>
2008-10-28 16:17:48 +00:00
</ div >
2009-10-15 21:47:35 +00:00
< ? php if ( 'div' != $args [ 'style' ] ) : ?>
2008-09-11 19:25:50 +00:00
</ div >
< ? php endif ; ?>
< ? php
}
2008-09-24 20:02:41 +00:00
/**
* @ see Walker :: end_el ()
* @ since unknown
*
* @ param string $output Passed by reference . Used to append additional content .
* @ param object $comment
* @ param int $depth Depth of comment .
* @ param array $args
*/
2008-09-11 19:25:50 +00:00
function end_el ( & $output , $comment , $depth , $args ) {
2008-09-12 19:18:39 +00:00
if ( ! empty ( $args [ 'end-callback' ]) ) {
call_user_func ( $args [ 'end-callback' ], $comment , $args , $depth );
return ;
}
2008-09-11 19:25:50 +00:00
if ( 'div' == $args [ 'style' ] )
echo " </div> \n " ;
else
echo " </li> \n " ;
}
}
/**
* List comments
*
* Used in the comments . php template to list comments for a particular post
*
2008-09-24 20:02:41 +00:00
* @ since 2.7 . 0
2008-09-11 19:25:50 +00:00
* @ uses Walker_Comment
*
2008-10-23 16:08:47 +00:00
* @ param string | array $args Formatting options
* @ param array $comments Optional array of comment objects . Defaults to $wp_query -> comments
2008-09-11 19:25:50 +00:00
*/
2008-09-16 00:23:38 +00:00
function wp_list_comments ( $args = array (), $comments = null ) {
2008-11-20 06:41:55 +00:00
global $wp_query , $comment_alt , $comment_depth , $comment_thread_alt , $overridden_cpage , $in_comment_loop ;
$in_comment_loop = true ;
2008-09-24 04:45:50 +00:00
$comment_alt = $comment_thread_alt = 0 ;
$comment_depth = 1 ;
2008-09-16 00:23:38 +00:00
2008-10-31 02:58:22 +00:00
$defaults = array ( 'walker' => null , 'max_depth' => '' , 'style' => 'ul' , 'callback' => null , 'end-callback' => null , 'type' => 'all' ,
2008-10-28 16:41:47 +00:00
'page' => '' , 'per_page' => '' , 'avatar_size' => 32 , 'reverse_top_level' => null , 'reverse_children' => '' );
2008-09-11 19:25:50 +00:00
$r = wp_parse_args ( $args , $defaults );
2008-11-13 20:36:36 +00:00
// Figure out what comments we'll be looping through ($_comments)
if ( null !== $comments ) {
$comments = ( array ) $comments ;
if ( empty ( $comments ) )
return ;
if ( 'all' != $r [ 'type' ] ) {
$comments_by_type = & separate_comments ( $comments );
if ( empty ( $comments_by_type [ $r [ 'type' ]]) )
return ;
$_comments = $comments_by_type [ $r [ 'type' ]];
} else {
$_comments = $comments ;
}
} else {
if ( empty ( $wp_query -> comments ) )
return ;
if ( 'all' != $r [ 'type' ] ) {
if ( empty ( $wp_query -> comments_by_type ) )
$wp_query -> comments_by_type = & separate_comments ( $wp_query -> comments );
if ( empty ( $wp_query -> comments_by_type [ $r [ 'type' ]]) )
return ;
$_comments = $wp_query -> comments_by_type [ $r [ 'type' ]];
} else {
$_comments = $wp_query -> comments ;
}
}
2008-09-23 21:11:27 +00:00
if ( '' === $r [ 'per_page' ] && get_option ( 'page_comments' ) )
$r [ 'per_page' ] = get_query_var ( 'comments_per_page' );
if ( empty ( $r [ 'per_page' ]) ) {
2008-09-24 05:20:17 +00:00
$r [ 'per_page' ] = 0 ;
2008-09-23 21:11:27 +00:00
$r [ 'page' ] = 0 ;
}
2008-10-31 02:58:22 +00:00
if ( '' === $r [ 'max_depth' ] ) {
2008-09-23 21:11:27 +00:00
if ( get_option ( 'thread_comments' ) )
2008-10-31 02:58:22 +00:00
$r [ 'max_depth' ] = get_option ( 'thread_comments_depth' );
2008-09-23 21:11:27 +00:00
else
2008-10-31 02:58:22 +00:00
$r [ 'max_depth' ] = - 1 ;
2008-09-23 21:11:27 +00:00
}
2008-10-23 16:08:47 +00:00
if ( '' === $r [ 'page' ] ) {
2008-11-13 20:36:36 +00:00
if ( empty ( $overridden_cpage ) ) {
2008-10-23 16:08:47 +00:00
$r [ 'page' ] = get_query_var ( 'cpage' );
} else {
2010-03-19 21:15:00 +00:00
$threaded = ( - 1 != $r [ 'max_depth' ] );
2008-11-13 20:36:36 +00:00
$r [ 'page' ] = ( 'newest' == get_option ( 'default_comments_page' ) ) ? get_comment_pages_count ( $_comments , $r [ 'per_page' ], $threaded ) : 1 ;
set_query_var ( 'cpage' , $r [ 'page' ] );
2008-10-23 16:08:47 +00:00
}
}
// Validation check
$r [ 'page' ] = intval ( $r [ 'page' ]);
if ( 0 == $r [ 'page' ] && 0 != $r [ 'per_page' ] )
$r [ 'page' ] = 1 ;
2008-10-28 16:41:47 +00:00
if ( null === $r [ 'reverse_top_level' ] )
2010-03-19 21:15:00 +00:00
$r [ 'reverse_top_level' ] = ( 'desc' == get_option ( 'comment_order' ) );
2008-10-23 16:08:47 +00:00
2008-09-11 19:25:50 +00:00
extract ( $r , EXTR_SKIP );
if ( empty ( $walker ) )
2008-11-13 20:36:36 +00:00
$walker = new Walker_Comment ;
2008-09-11 19:25:50 +00:00
2008-11-13 20:36:36 +00:00
$walker -> paged_walk ( $_comments , $max_depth , $page , $per_page , $r );
$wp_query -> max_num_comment_pages = $walker -> max_pages ;
2008-11-20 06:41:55 +00:00
$in_comment_loop = false ;
2008-09-11 19:25:50 +00:00
}
2010-01-23 18:06:37 +00:00
/**
* Outputs a complete commenting form for use within a template .
* Most strings and form fields may be controlled through the $args array passed
* into the function , while you may also choose to use the comments_form_default_fields
* filter to modify the array of default fields if you ' d just like to add a new
* one or remove a single field . All fields are also individually passed through
* a filter of the form comments_form_field_ $name where $name is the key used
* in the array of fields .
*
2010-03-26 19:13:36 +00:00
* @ since 3.0 . 0
2010-01-23 18:06:37 +00:00
* @ param array $args Options for strings , fields etc in the form
* @ param mixed $post_id Post ID to generate the form for , uses the current post if null
* @ return void
*/
function comment_form ( $args = array (), $post_id = null ) {
global $user_identity , $id ;
2010-01-26 22:49:05 +00:00
2010-01-23 18:06:37 +00:00
if ( null === $post_id )
$post_id = $id ;
else
$id = $post_id ;
2010-01-26 22:49:05 +00:00
2010-01-23 18:06:37 +00:00
$commenter = wp_get_current_commenter ();
2010-01-26 22:49:05 +00:00
2010-01-23 18:06:37 +00:00
$req = get_option ( 'require_name_email' );
$aria_req = ( $req ? " aria-required='true' " : '' );
2010-04-15 16:25:08 +00:00
$fields = array (
'author' => '<p class="comment-form-author">' . '<label for="author">' . __ ( 'Name' ) . '</label> ' . ( $req ? '<span class="required">*</span>' : '' ) .
2010-04-16 18:29:39 +00:00
'<input id="author" name="author" type="text" value="' . esc_attr ( $commenter [ 'comment_author' ] ) . '" size="30"' . $aria_req . ' /></p>' ,
2010-04-15 16:25:08 +00:00
'email' => '<p class="comment-form-email"><label for="email">' . __ ( 'Email' ) . '</label> ' . ( $req ? '<span class="required">*</span>' : '' ) .
2010-04-16 18:29:39 +00:00
'<input id="email" name="email" type="text" value="' . esc_attr ( $commenter [ 'comment_author_email' ] ) . '" size="30"' . $aria_req . ' /></p>' ,
2010-04-15 16:25:08 +00:00
'url' => '<p class="comment-form-url"><label for="url">' . __ ( 'Website' ) . '</label>' .
2010-04-16 18:29:39 +00:00
'<input id="url" name="url" type="text" value="' . esc_attr ( $commenter [ 'comment_author_url' ] ) . '" size="30" /></p>' ,
2010-04-15 16:25:08 +00:00
);
$defaults = array (
'fields' => apply_filters ( 'comment_form_default_fields' , $fields ),
2010-04-16 22:27:37 +00:00
'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>' ,
2010-04-15 16:25:08 +00:00
'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>' ,
2010-04-16 22:27:37 +00:00
'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>' ,
2010-04-23 15:01:21 +00:00
'comment_notes_before' => '<p class="comment-notes">' . __ ( 'Your email address will not be published.' ) . ( $req ? __ ( ' Required fields are marked <span class="required">*</span>' ) : '' ) . '</p>' ,
2010-04-15 16:25:08 +00:00
'comment_notes_after' => '<dl class="form-allowed-tags"><dt>' . __ ( 'You may use these <abbr title="HyperText Markup Language">HTML</abbr> tags and attributes:' ) . '</dt> <dd><code>' . allowed_tags () . '</code></dd></dl>' ,
'id_form' => 'commentform' ,
'id_submit' => 'submit' ,
'title_reply' => __ ( 'Leave a Reply' ),
'title_reply_to' => __ ( 'Leave a Reply to %s' ),
'cancel_reply_link' => __ ( 'Cancel reply' ),
'label_submit' => __ ( 'Post Comment' ),
2010-04-28 04:28:51 +00:00
'echo' => true ,
2010-04-15 16:25:08 +00:00
);
2010-01-23 18:06:37 +00:00
$args = wp_parse_args ( $args , apply_filters ( 'comment_form_defaults' , $defaults ) );
2010-04-28 04:28:51 +00:00
ob_start ();
2010-01-23 18:06:37 +00:00
?>
< ? php if ( comments_open () ) : ?>
< ? php do_action ( 'comment_form_before' ); ?>
< div id = " respond " >
2010-02-08 20:54:29 +00:00
< 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>
2010-01-23 18:06:37 +00:00
< ? php if ( get_option ( 'comment_registration' ) && ! is_user_logged_in () ) : ?>
< ? php echo $args [ 'must_log_in' ]; ?>
< ? php do_action ( 'comment_form_must_log_in_after' ); ?>
< ? php else : ?>
< form action = " <?php echo site_url( '/wp-comments-post.php' ); ?> " method = " post " id = " <?php echo esc_attr( $args['id_form'] ); ?> " >
< ? php do_action ( 'comment_form_top' ); ?>
< ? php if ( is_user_logged_in () ) : ?>
< ? php echo apply_filters ( 'comment_form_logged_in' , $args [ 'logged_in_as' ], $commenter , $user_identity ); ?>
< ? php do_action ( 'comment_form_logged_in_after' , $commenter , $user_identity ); ?>
< ? php else : ?>
2010-02-08 20:54:29 +00:00
< ? php echo $args [ 'comment_notes_before' ]; ?>
2010-01-23 18:06:37 +00:00
< ? php
do_action ( 'comment_form_before_fields' );
foreach ( ( array ) $args [ 'fields' ] as $name => $field ) {
echo apply_filters ( " comment_form_field_ { $name } " , $field ) . " \n " ;
}
do_action ( 'comment_form_after_fields' );
?>
< ? php endif ; ?>
< ? php echo apply_filters ( 'comment_form_field_comment' , $args [ 'comment_field' ] ); ?>
2010-02-08 20:54:29 +00:00
< ? php echo $args [ 'comment_notes_after' ]; ?>
2010-02-17 19:28:03 +00:00
< p class = " form-submit " >
2010-04-16 18:29:39 +00:00
< input name = " submit " type = " submit " id = " <?php echo esc_attr( $args['id_submit'] ); ?> " value = " <?php echo esc_attr( $args['label_submit'] ); ?> " />
2010-01-23 18:06:37 +00:00
< ? php comment_id_fields (); ?>
2010-02-17 19:28:03 +00:00
</ p >
2010-02-08 18:27:02 +00:00
< ? php do_action ( 'comment_form' , $post_id ); ?>
2010-01-23 18:06:37 +00:00
</ form >
< ? php endif ; ?>
2010-04-15 16:16:51 +00:00
</ div ><!-- #respond -->
2010-01-23 18:06:37 +00:00
< ? php do_action ( 'comment_form_after' ); ?>
< ? php else : ?>
< ? php do_action ( 'comment_form_comments_closed' ); ?>
2010-04-28 04:28:51 +00:00
< ? php endif ;
$form = apply_filters ( 'comment_form_output' , ob_get_clean (), $args );
if ( $args [ 'echo' ] )
echo $form ;
else
return $form ;
2010-01-23 18:06:37 +00:00
}
2008-12-10 11:49:37 +00:00
?>