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
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2007-12-26 17:18:13 +00:00
*
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to retrieve the author.
* Default current comment.
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 );
2013-08-27 13:17:09 +00:00
if ( empty ( $comment -> comment_author ) ) {
if ( $comment -> user_id && $user = get_userdata ( $comment -> user_id ) )
$author = $user -> display_name ;
else
2008-11-19 06:58:44 +00:00
$author = __ ( 'Anonymous' );
} else {
2006-04-19 10:13:28 +00:00
$author = $comment -> comment_author ;
2008-11-19 06:58:44 +00:00
}
2013-08-27 13:17:09 +00:00
2013-09-23 21:21:09 +00:00
/**
* Filter the returned comment author name.
*
2013-10-30 14:39:10 +00:00
* @since 1.5.0
2014-10-30 03:52:22 +00:00
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
2013-09-23 21:21:09 +00:00
*
2015-09-03 18:17:24 +00:00
* @param string $author The comment author's username.
* @param int $comment_ID The comment ID.
* @param WP_Comment $comment The comment object.
2013-09-23 21:21:09 +00:00
*/
2015-09-10 18:10:25 +00:00
return apply_filters ( 'get_comment_author' , $author , $comment -> comment_ID , $comment );
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 author of the current comment.
2007-12-26 17:18:13 +00:00
*
* @since 0.71
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2010-01-26 22:49:05 +00:00
*
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author.
* Default current comment.
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function comment_author ( $comment_ID = 0 ) {
2015-09-10 18:10:25 +00:00
$comment = get_comment ( $comment_ID );
$author = get_comment_author ( $comment );
2014-11-28 11:22:23 +00:00
2013-09-23 21:21:09 +00:00
/**
* Filter the comment author's name for display.
*
2013-10-30 14:39:10 +00:00
* @since 1.2.0
2014-10-30 03:52:22 +00:00
* @since 4.1.0 The `$comment_ID` parameter was added.
2013-09-23 21:21:09 +00:00
*
2014-10-30 03:52:22 +00:00
* @param string $author The comment author's username.
* @param int $comment_ID The comment ID.
2013-09-23 21:21:09 +00:00
*/
2015-09-10 18:10:25 +00:00
echo apply_filters ( 'comment_author' , $author , $comment -> 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 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
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2007-12-26 17:18:13 +00:00
*
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's email.
* Default current comment.
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 );
2014-11-28 11:22:23 +00:00
2013-09-23 21:21:09 +00:00
/**
* Filter the comment author's returned email address.
*
2013-10-30 14:39:10 +00:00
* @since 1.5.0
2014-10-30 03:52:22 +00:00
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
2013-09-23 21:21:09 +00:00
*
2015-09-03 18:17:24 +00:00
* @param string $comment_author_email The comment author's email address.
* @param int $comment_ID The comment ID.
* @param WP_Comment $comment The comment object.
2013-09-23 21:21:09 +00:00
*/
2015-09-10 18:10:25 +00:00
return apply_filters ( 'get_comment_author_email' , $comment -> comment_author_email , $comment -> comment_ID , $comment );
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 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
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2010-01-25 17:34:13 +00:00
*
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's email.
* Default current comment.
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function comment_author_email ( $comment_ID = 0 ) {
2015-09-10 18:10:25 +00:00
$comment = get_comment ( $comment_ID );
$author_email = get_comment_author_email ( $comment );
2014-11-28 11:22:23 +00:00
2013-09-23 21:21:09 +00:00
/**
* Filter the comment author's email for display.
*
2013-10-30 14:39:10 +00:00
* @since 1.2.0
2014-10-30 03:52:22 +00:00
* @since 4.1.0 The `$comment_ID` parameter was added.
2013-09-23 21:21:09 +00:00
*
* @param string $author_email The comment author's email address.
2014-10-30 03:52:22 +00:00
* @param int $comment_ID The comment ID.
2013-09-23 21:21:09 +00:00
*/
2015-09-10 18:10:25 +00:00
echo apply_filters ( 'author_email' , $author_email , $comment -> 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
*
2013-09-23 04:16:08 +00:00
* @since 0.71
2007-12-26 17:18:13 +00:00
*
2014-02-10 03:20:12 +00:00
* @param string $linktext Optional. Text to display instead of the comment author's email address.
* Default empty.
2014-02-10 04:07:12 +00:00
* @param string $before Optional. Text or HTML to display before the email link. Default empty.
2014-02-10 03:20:12 +00:00
* @param string $after Optional. Text or HTML to display after the email link. Default empty.
2007-12-26 17:18:13 +00:00
*/
2013-09-23 04:16:08 +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.
*
2013-12-24 18:57:12 +00:00
* @since 2.7.0
2008-10-31 18:05:25 +00:00
*
2014-02-10 03:20:12 +00:00
* @param string $linktext Optional. Text to display instead of the comment author's email address.
* Default empty.
* @param string $before Optional. Text or HTML to display before the email link. Default empty.
* @param string $after Optional. Text or HTML to display after the email link. Default empty.
2015-05-24 05:19:24 +00:00
* @return string
2008-10-31 18:05:25 +00:00
*/
2013-09-23 04:16:08 +00:00
function get_comment_author_email_link ( $linktext = '' , $before = '' , $after = '' ) {
2015-09-09 02:51:24 +00:00
$comment = get_comment ();
2013-09-23 21:21:09 +00:00
/**
* Filter the comment author's email for display.
*
* Care should be taken to protect the email address and assure that email
2014-11-28 11:22:23 +00:00
* harvesters do not capture your commenter's email address.
2013-09-23 21:21:09 +00:00
*
2013-10-30 14:39:10 +00:00
* @since 1.2.0
2014-10-30 03:52:22 +00:00
* @since 4.1.0 The `$comment` parameter was added.
2013-09-23 21:21:09 +00:00
*
2015-09-03 18:17:24 +00:00
* @param string $comment_author_email The comment author's email address.
* @param WP_Comment $comment The comment object.
2013-09-23 21:21:09 +00:00
*/
2014-10-29 19:07:22 +00:00
$email = apply_filters ( 'comment_email' , $comment -> comment_author_email , $comment );
2006-04-19 10:13:28 +00:00
if (( ! empty ( $email )) && ( $email != '@' )) {
$display = ( $linktext != '' ) ? $linktext : $email ;
2008-10-31 18:05:25 +00:00
$return = $before ;
2015-11-29 02:43:24 +00:00
$return .= sprintf ( '<a href="%1$s">%2$s</a>' , esc_url ( 'mailto:' . $email ), esc_html ( $display ) );
2008-10-31 18:05:25 +00:00
$return .= $after ;
return $return ;
} else {
return '' ;
2006-04-19 10:13:28 +00:00
}
}
2007-12-26 17:18:13 +00:00
/**
2013-09-19 05:56:10 +00:00
* Retrieve the HTML link to the URL of the author of the current comment.
2013-09-22 10:16:09 +00:00
*
2013-09-19 05:56:10 +00:00
* Both get_comment_author_url() and get_comment_author() rely on get_comment(),
* which falls back to the global comment variable if the $comment_ID argument is empty.
2007-12-26 17:18:13 +00:00
*
2008-09-24 20:02:41 +00:00
* @since 1.5.0
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2007-12-26 17:18:13 +00:00
*
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's link.
* Default current comment.
2013-09-19 05:56:10 +00:00
* @return string The comment author name or HTML link for author's URL.
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function get_comment_author_link ( $comment_ID = 0 ) {
2015-09-10 18:10:25 +00:00
$comment = get_comment ( $comment_ID );
$url = get_comment_author_url ( $comment );
$author = get_comment_author ( $comment );
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>" ;
2013-09-23 21:21:09 +00:00
/**
* Filter the comment author's link for display.
*
2013-10-30 14:39:10 +00:00
* @since 1.5.0
2014-10-30 03:52:22 +00:00
* @since 4.1.0 The `$author` and `$comment_ID` parameters were added.
2013-09-23 21:21:09 +00:00
*
2014-10-30 03:52:22 +00:00
* @param string $return The HTML-formatted comment author link.
* Empty for an invalid URL.
* @param string $author The comment author's username.
* @param int $comment_ID The comment ID.
2013-09-23 21:21:09 +00:00
*/
2015-09-10 18:10:25 +00:00
return apply_filters ( 'get_comment_author_link' , $return , $author , $comment -> 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 link to the url of the author of the current comment.
2007-12-26 17:18:13 +00:00
*
* @since 0.71
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2014-02-10 03:20:12 +00:00
*
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's link.
* Default current comment.
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
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2007-12-26 17:18:13 +00:00
*
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's IP address.
* Default current comment.
2014-02-10 03:20:12 +00:00
* @return string 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 );
2013-09-23 21:21:09 +00:00
/**
* Filter the comment author's returned IP address.
*
2013-10-30 14:39:10 +00:00
* @since 1.5.0
2014-10-30 03:52:22 +00:00
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
2013-09-23 21:21:09 +00:00
*
2015-09-03 18:17:24 +00:00
* @param string $comment_author_IP The comment author's IP address.
* @param int $comment_ID The comment ID.
* @param WP_Comment $comment The comment object.
2013-09-23 21:21:09 +00:00
*/
2015-09-10 18:10:25 +00:00
return apply_filters ( 'get_comment_author_IP' , $comment -> comment_author_IP , $comment -> comment_ID , $comment );
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 IP address of the author of the current comment.
2007-12-26 17:18:13 +00:00
*
* @since 0.71
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2010-01-25 17:34:13 +00:00
*
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's IP address.
* Default current comment.
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function comment_author_IP ( $comment_ID = 0 ) {
2015-11-29 02:43:24 +00:00
echo esc_html ( 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
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2007-12-26 17:18:13 +00:00
*
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's URL.
* Default current comment.
2015-09-16 13:52:25 +00:00
* @return string Comment author URL.
2007-12-26 17:18:13 +00:00
*/
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' ) );
2014-11-28 11:22:23 +00:00
2013-10-30 14:39:10 +00:00
/**
* Filter the comment author's URL.
*
* @since 1.5.0
2014-10-30 03:52:22 +00:00
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
2013-10-30 14:39:10 +00:00
*
2015-09-03 18:17:24 +00:00
* @param string $url The comment author's URL.
* @param int $comment_ID The comment ID.
* @param WP_Comment $comment The comment object.
2013-10-30 14:39:10 +00:00
*/
2015-09-10 18:10:25 +00:00
return apply_filters ( 'get_comment_author_url' , $url , $comment -> comment_ID , $comment );
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
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2010-01-25 17:34:13 +00:00
*
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's URL.
* Default current comment.
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function comment_author_url ( $comment_ID = 0 ) {
2015-09-10 18:10:25 +00:00
$comment = get_comment ( $comment_ID );
$author_url = get_comment_author_url ( $comment );
2014-11-28 11:22:23 +00:00
2013-09-23 21:21:09 +00:00
/**
* Filter the comment author's URL for display.
*
2013-10-30 14:39:10 +00:00
* @since 1.2.0
2014-10-30 03:52:22 +00:00
* @since 4.1.0 The `$comment_ID` parameter was added.
2013-09-23 21:21:09 +00:00
*
* @param string $author_url The comment author's URL.
2014-10-30 03:52:22 +00:00
* @param int $comment_ID The comment ID.
2013-09-23 21:21:09 +00:00
*/
2015-09-10 18:10:25 +00:00
echo apply_filters ( 'comment_url' , $author_url , $comment -> 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
*
2014-02-10 03:20:12 +00:00
* @param string $linktext Optional. The text to display instead of the comment
* author's email address. Default empty.
* @param string $before Optional. The text or HTML to display before the email link.
* Default empty.
* @param string $after Optional. The text or HTML to display after the email link.
* Default empty.
2013-09-23 04:16:08 +00:00
* @return string The HTML link between the $before and $after parameters.
2007-12-26 17:18:13 +00:00
*/
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 );
2014-10-29 19:07:22 +00:00
if ( '/' == substr ( $display , - 1 ) ) {
2006-04-19 10:13:28 +00:00
$display = substr ( $display , 0 , - 1 );
2014-10-29 19:07:22 +00:00
}
2006-04-19 10:13:28 +00:00
$return = " $before <a href=' $url ' rel='external'> $display </a> $after " ;
2013-09-23 21:21:09 +00:00
/**
* Filter the comment author's returned URL link.
*
2013-10-30 14:39:10 +00:00
* @since 1.5.0
2013-09-23 21:21:09 +00:00
*
* @param string $return The HTML-formatted comment author URL link.
*/
return apply_filters ( 'get_comment_author_url_link' , $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
* 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
*
2014-02-10 03:20:12 +00:00
* @param string $linktext Optional. Text to display instead of the comment author's
* email address. Default empty.
* @param string $before Optional. Text or HTML to display before the email link.
* Default empty.
* @param string $after Optional. Text or HTML to display after the email link.
* Default empty.
2007-12-26 17:18:13 +00:00
*/
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
/**
2014-02-10 03:20:12 +00:00
* Generates semantic classes for each comment element.
2008-08-20 23:48:09 +00:00
*
2008-09-24 20:02:41 +00:00
* @since 2.7.0
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object.
2008-08-20 23:48:09 +00:00
*
2015-09-09 02:34:24 +00:00
* @param string|array $class Optional. One or more classes to add to the class list.
2014-02-10 03:20:12 +00:00
* Default empty.
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment Comment ID or WP_Comment object. Default current comment.
* @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
* @param bool $echo Optional. Whether to cho or return the output.
2014-02-10 03:20:12 +00:00
* Default true.
2015-09-16 13:52:25 +00:00
* @return string If `$echo` is false, the class will be returned. Void otherwise.
2008-08-20 23:48:09 +00:00
*/
2015-09-09 02:34:24 +00:00
function comment_class ( $class = '' , $comment = null , $post_id = null , $echo = true ) {
2008-09-11 19:25:50 +00:00
// Separates classes with a single space, collates classes for comment DIV
2015-09-09 02:34:24 +00:00
$class = 'class="' . join ( ' ' , get_comment_class ( $class , $comment , $post_id ) ) . '"' ;
2008-09-11 19:25:50 +00:00
if ( $echo )
echo $class ;
else
return $class ;
2008-08-20 23:48:09 +00:00
}
/**
2014-02-10 03:20:12 +00:00
* Returns the classes for the comment div as an array.
2008-08-20 23:48:09 +00:00
*
2008-09-24 20:02:41 +00:00
* @since 2.7.0
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object.
2008-08-20 23:48:09 +00:00
*
2015-05-24 05:19:24 +00:00
* @global int $comment_alt
* @global int $comment_depth
* @global int $comment_thread_alt
*
2015-09-09 02:34:24 +00:00
* @param string|array $class Optional. One or more classes to add to the class list. Default empty.
* @param int|WP_Comment $comment_id Comment ID or WP_Comment object. Default current comment.
* @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
2013-09-23 04:16:08 +00:00
* @return array An array of classes.
2008-08-20 23:48:09 +00:00
*/
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
$classes = array ();
2015-09-23 14:09:26 +00:00
$comment = get_comment ( $comment_id );
if ( ! $comment ) {
return $classes ;
}
2008-08-20 23:48:09 +00:00
// 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
2015-02-23 02:52:24 +00:00
// Add classes for comment authors that are registered users.
if ( $comment -> user_id > 0 && $user = get_userdata ( $comment -> user_id ) ) {
2009-04-05 17:38:19 +00:00
$classes [] = 'byuser' ;
2015-02-23 02:52:24 +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 ) ) {
2015-02-23 02:52:24 +00:00
if ( $comment -> user_id === $post -> post_author ) {
2008-08-20 23:48:09 +00:00
$classes [] = 'bypostauthor' ;
2015-02-23 02:52:24 +00:00
}
2008-08-20 23:48:09 +00:00
}
}
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 );
2013-09-23 21:21:09 +00:00
/**
* Filter the returned CSS classes for the current comment.
*
* @since 2.7.0
*
* @param array $classes An array of comment classes.
* @param string $class A comma-separated list of additional classes added to the list.
* @param int $comment_id The comment id.
2015-09-16 13:52:25 +00:00
* @param WP_Comment $comment The comment object.
2013-09-23 21:21:09 +00:00
* @param int|WP_Post $post_id The post ID or WP_Post object.
*/
2015-09-10 18:10:25 +00:00
return apply_filters ( 'comment_class' , $classes , $class , $comment -> comment_ID , $comment , $post_id );
2008-08-20 23:48:09 +00:00
}
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
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2007-12-26 17:18:13 +00:00
*
2015-09-09 02:34:24 +00:00
* @param string $d Optional. The format of the date. Default user's setting.
* @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to get the date.
* Default current comment.
2013-09-23 04:16:08 +00:00
* @return string The comment's date.
2007-12-26 17:18:13 +00:00
*/
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 );
2013-09-23 21:21:09 +00:00
/**
* Filter the returned comment date.
*
2013-10-30 14:39:10 +00:00
* @since 1.5.0
2013-09-23 21:21:09 +00:00
*
2014-02-26 16:41:14 +00:00
* @param string|int $date Formatted date string or Unix timestamp.
* @param string $d The format of the date.
2015-09-03 18:17:24 +00:00
* @param WP_Comment $comment The comment object.
2013-09-23 21:21:09 +00:00
*/
2014-02-26 16:41:14 +00:00
return apply_filters ( 'get_comment_date' , $date , $d , $comment );
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
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2007-12-26 17:18:13 +00:00
*
2015-09-16 13:52:25 +00:00
* @param string $d Optional. The format of the date. Default user's settings.
* @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the date.
* Default current comment.
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
*
2013-05-08 21:27:31 +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 '…'
2007-12-26 17:18:13 +00:00
* will appear.
*
2008-09-24 20:02:41 +00:00
* @since 1.5.0
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2007-12-26 17:18:13 +00:00
*
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to get the excerpt.
* Default current comment.
2013-09-23 04:16:08 +00:00
* @return string The maybe truncated comment with 20 words or less.
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function get_comment_excerpt ( $comment_ID = 0 ) {
$comment = get_comment ( $comment_ID );
2015-09-24 21:05:25 +00:00
$comment_text = strip_tags ( str_replace ( array ( " \n " , " \r " ), ' ' , $comment -> comment_content ) );
$words = explode ( ' ' , $comment_text );
2014-10-29 19:07:22 +00:00
2015-09-24 21:05:25 +00:00
/**
* Filter the amount of words used in the comment excerpt.
*
* @since 4.4.0
*
* @param int $comment_excerpt_length The amount of words you want to display in the comment excerpt.
*/
$comment_excerpt_length = apply_filters ( 'comment_excerpt_length' , 20 );
2014-10-29 19:07:22 +00:00
2015-09-24 21:05:25 +00:00
$use_ellipsis = count ( $words ) > $comment_excerpt_length ;
if ( $use_ellipsis ) {
$words = array_slice ( $words , 0 , $comment_excerpt_length );
2006-04-19 10:13:28 +00:00
}
2014-04-12 00:01:15 +00:00
2015-09-24 21:05:25 +00:00
$excerpt = trim ( join ( ' ' , $words ) );
if ( $use_ellipsis ) {
$excerpt .= '…' ;
}
2014-04-12 00:01:15 +00:00
/**
* Filter the retrieved comment excerpt.
*
* @since 1.5.0
2014-10-30 03:52:22 +00:00
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
2014-04-12 00:01:15 +00:00
*
2015-09-03 18:17:24 +00:00
* @param string $excerpt The comment excerpt text.
* @param int $comment_ID The comment ID.
* @param WP_Comment $comment The comment object.
2014-04-12 00:01:15 +00:00
*/
2015-09-10 18:10:25 +00:00
return apply_filters ( 'get_comment_excerpt' , $excerpt , $comment -> comment_ID , $comment );
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 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
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2010-01-25 17:34:13 +00:00
*
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the excerpt.
* Default current comment.
2007-12-26 17:18:13 +00:00
*/
2010-01-25 17:34:13 +00:00
function comment_excerpt ( $comment_ID = 0 ) {
2015-09-10 18:10:25 +00:00
$comment = get_comment ( $comment_ID );
$comment_excerpt = get_comment_excerpt ( $comment );
2014-11-28 11:22:23 +00:00
2013-09-23 21:21:09 +00:00
/**
* Filter the comment excerpt for display.
*
2013-10-30 14:39:10 +00:00
* @since 1.2.0
2014-10-30 03:52:22 +00:00
* @since 4.1.0 The `$comment_ID` parameter was added.
2013-09-23 21:21:09 +00:00
*
2014-10-30 03:52:22 +00:00
* @param string $comment_excerpt The comment excerpt text.
* @param int $comment_ID The comment ID.
2013-09-23 21:21:09 +00:00
*/
2015-09-10 18:10:25 +00:00
echo apply_filters ( 'comment_excerpt' , $comment_excerpt , $comment -> 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
*
2013-09-23 04:16:08 +00:00
* @return int The comment ID.
2007-12-26 17:18:13 +00:00
*/
2006-04-19 10:13:28 +00:00
function get_comment_ID () {
2015-09-09 02:51:24 +00:00
$comment = get_comment ();
2014-11-28 11:22:23 +00:00
2013-09-23 21:21:09 +00:00
/**
* Filter the returned comment ID.
*
2013-10-30 14:39:10 +00:00
* @since 1.5.0
2014-10-30 03:52:22 +00:00
* @since 4.1.0 The `$comment_ID` parameter was added.
2013-09-23 21:21:09 +00:00
*
2015-09-03 18:17:24 +00:00
* @param int $comment_ID The current comment ID.
* @param WP_Comment $comment The comment object.
2013-09-23 21:21:09 +00:00
*/
2014-10-29 19:07:22 +00:00
return apply_filters ( 'get_comment_ID' , $comment -> comment_ID , $comment );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2013-09-23 04:16:08 +00:00
* Display the comment id of the current comment.
2007-12-26 17:18:13 +00:00
*
* @since 0.71
*/
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
2015-10-01 05:13:25 +00:00
* @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object. Added `$cpage` argument.
2007-12-26 17:18:13 +00:00
*
2014-02-10 03:20:12 +00:00
* @see get_page_of_comment()
*
2015-05-24 05:19:24 +00:00
* @global WP_Rewrite $wp_rewrite
* @global bool $in_comment_loop
*
2015-09-03 18:17:24 +00:00
* @param WP_Comment|int|null $comment Comment to retrieve. Default current comment.
2015-09-30 04:13:25 +00:00
* @param array $args {
* An array of optional arguments to override the defaults.
*
2015-10-01 05:13:25 +00:00
* @type string $type Passed to {@see get_page_of_comment()}.
* @type int $page Current page of comments, for calculating comment pagination.
* @type int $per_page Per-page value for comment pagination.
* @type int $max_depth Passed to {@see get_page_of_comment()}.
* @type int|string $cpage Value to use for the comment's "comment-page" or "cpage" value. If provided, this
* value overrides any value calculated from `$page` and `$per_page`.
2015-09-30 04:13:25 +00:00
* }
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
2014-03-28 02:38:14 +00:00
if ( ! is_array ( $args ) ) {
$args = array ( 'page' => $args );
2008-11-20 06:41:55 +00:00
}
2015-10-01 05:13:25 +00:00
$defaults = array (
'type' => 'all' ,
'page' => '' ,
'per_page' => '' ,
'max_depth' => '' ,
'cpage' => null ,
);
2008-11-20 06:41:55 +00:00
$args = wp_parse_args ( $args , $defaults );
2015-10-01 05:13:25 +00:00
$link = get_permalink ( $comment -> comment_post_ID );
// The 'cpage' param takes precedence.
if ( ! is_null ( $args [ 'cpage' ] ) ) {
$cpage = $args [ 'cpage' ];
// No 'cpage' is provided, so we calculate one.
} else {
2015-10-21 16:26:42 +00:00
if ( '' === $args [ 'per_page' ] && get_option ( 'page_comments' ) ) {
2015-10-01 05:13:25 +00:00
$args [ 'per_page' ] = get_option ( 'comments_per_page' );
}
if ( empty ( $args [ 'per_page' ] ) ) {
$args [ 'per_page' ] = 0 ;
$args [ 'page' ] = 0 ;
}
$cpage = $args [ 'page' ];
2008-11-20 06:41:55 +00:00
2015-10-01 05:13:25 +00:00
if ( '' == $cpage ) {
if ( ! empty ( $in_comment_loop ) ) {
$cpage = get_query_var ( 'cpage' );
} else {
// Requires a database hit, so we only do it when we can't figure out from context.
$cpage = get_page_of_comment ( $comment -> comment_ID , $args );
}
}
/*
* If the default page displays the oldest comments, the permalinks for comments on the default page
* do not need a 'cpage' query var.
*/
$default_comments_page = get_option ( 'default_comments_page' );
if ( 'oldest' === get_option ( 'default_comments_page' ) && 1 === $cpage ) {
$cpage = '' ;
}
2008-11-20 06:41:55 +00:00
}
2015-12-14 19:46:46 +00:00
if ( $cpage && get_option ( 'page_comments' ) ) {
2015-10-01 05:13:25 +00:00
if ( $wp_rewrite -> using_permalinks () ) {
if ( $cpage ) {
$link = trailingslashit ( $link ) . $wp_rewrite -> comments_pagination_base . '-' . $cpage ;
}
2008-10-27 16:31:26 +00:00
2015-10-01 05:13:25 +00:00
$link = user_trailingslashit ( $link , 'comment' );
} elseif ( $cpage ) {
$link = add_query_arg ( 'cpage' , $cpage , $link );
}
}
if ( $wp_rewrite -> using_permalinks () ) {
$link = user_trailingslashit ( $link , 'comment' );
2008-10-27 16:31:26 +00:00
}
2009-03-13 21:58:18 +00:00
2013-09-23 21:21:09 +00:00
$link = $link . '#comment-' . $comment -> comment_ID ;
2015-10-01 05:13:25 +00:00
2013-09-23 21:21:09 +00:00
/**
* Filter the returned single comment permalink.
*
* @since 2.8.0
2015-10-01 05:13:25 +00:00
* @since 4.4.0 Added the `$cpage` parameter.
2013-09-23 21:21:09 +00:00
*
2014-02-10 03:20:12 +00:00
* @see get_page_of_comment()
*
2015-09-03 18:17:24 +00:00
* @param string $link The comment permalink with '#comment-$id' appended.
* @param WP_Comment $comment The current comment object.
* @param array $args An array of arguments to override the defaults.
2015-10-01 05:13:25 +00:00
* @param int $cpage The calculated 'cpage' value.
2013-09-23 21:21:09 +00:00
*/
2015-10-01 05:13:25 +00:00
return apply_filters ( 'get_comment_link' , $link , $comment , $args , $cpage );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2015-09-16 13:52:25 +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
*
2014-07-03 19:28:14 +00:00
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
2013-09-23 04:16:08 +00:00
* @return string The link to the comments.
2007-12-26 17:18:13 +00:00
*/
2013-09-23 04:16:08 +00:00
function get_comments_link ( $post_id = 0 ) {
2015-09-12 07:36:25 +00:00
$hash = get_comments_number ( $post_id ) ? '#comments' : '#respond' ;
$comments_link = get_permalink ( $post_id ) . $hash ;
2015-09-16 13:52:25 +00:00
2013-09-23 21:21:09 +00:00
/**
* Filter the returned post comments permalink.
*
2014-04-12 00:01:15 +00:00
* @since 3.6.0
2013-09-23 21:21:09 +00:00
*
2014-02-10 03:20:12 +00:00
* @param string $comments_link Post comments permalink with '#comments' appended.
* @param int|WP_Post $post_id Post ID or WP_Post object.
2013-09-23 21:21:09 +00:00
*/
return apply_filters ( 'get_comments_link' , $comments_link , $post_id );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2013-09-23 04:16:08 +00:00
* Display the link to the current post comments.
2007-12-26 17:18:13 +00:00
*
* @since 0.71
*
2013-09-23 04:16:08 +00:00
* @param string $deprecated Not Used.
2014-12-01 01:34:24 +00:00
* @param string $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' );
2013-03-06 19:57:31 +00:00
echo esc_url ( 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
*
2014-07-03 19:28:14 +00:00
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
2013-09-23 04:16:08 +00:00
* @return int The number of comments a post has.
2007-12-26 17:18:13 +00:00
*/
2006-04-19 10:13:28 +00:00
function get_comments_number ( $post_id = 0 ) {
2014-05-23 17:44:14 +00:00
$post = get_post ( $post_id );
2010-09-04 15:51:04 +00:00
2014-05-30 19:47:14 +00:00
if ( ! $post ) {
2006-04-19 10:13:28 +00:00
$count = 0 ;
2014-05-23 17:44:14 +00:00
} else {
2006-04-19 10:13:28 +00:00
$count = $post -> comment_count ;
2014-05-30 19:47:14 +00:00
$post_id = $post -> ID ;
2014-05-23 17:44:14 +00:00
}
2006-04-19 10:13:28 +00:00
2013-09-23 21:21:09 +00:00
/**
* Filter the returned comment count for a post.
*
2013-10-30 14:39:10 +00:00
* @since 1.5.0
2013-09-23 21:21:09 +00:00
*
2014-05-28 22:36:15 +00:00
* @param int $count Number of comments a post has.
2014-05-28 22:05:18 +00:00
* @param int $post_id Post ID.
2013-09-23 21:21:09 +00:00
*/
2014-05-30 19:47:14 +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
*
2013-09-23 04:16:08 +00:00
* @param string $zero Optional. Text for no comments. Default false.
* @param string $one Optional. Text for one comment. Default false.
* @param string $more Optional. Text for more than one comment. Default false.
2007-12-26 17:18:13 +00:00
* @param string $deprecated Not used.
*/
2007-03-25 23:18:19 +00:00
function comments_number ( $zero = false , $one = false , $more = false , $deprecated = '' ) {
2014-06-29 23:13:15 +00:00
if ( ! empty ( $deprecated ) ) {
2010-01-09 10:03:55 +00:00
_deprecated_argument ( __FUNCTION__ , '1.3' );
2014-06-29 23:13:15 +00:00
}
echo get_comments_number_text ( $zero , $one , $more );
}
2009-12-30 16:23:39 +00:00
2014-06-29 23:13:15 +00:00
/**
* Display the language string for the number of comments the current post has.
*
* @since 4.0.0
*
* @param string $zero Optional. Text for no comments. Default false.
* @param string $one Optional. Text for one comment. Default false.
* @param string $more Optional. Text for more than one comment. Default false.
*/
function get_comments_number_text ( $zero = false , $one = false , $more = false ) {
2010-11-29 17:34:43 +00:00
$number = get_comments_number ();
2006-11-19 07:45:28 +00:00
2014-06-29 23:13:15 +00:00
if ( $number > 1 ) {
2015-11-05 15:36:28 +00:00
if ( false === $more ) {
/* translators: %s: number of comments */
$output = sprintf ( _n ( '%s Comment' , '%s Comments' , $number ), number_format_i18n ( $number ) );
} else {
// % Comments
$output = str_replace ( '%' , number_format_i18n ( $number ), $more );
}
2014-06-29 23:13:15 +00:00
} elseif ( $number == 0 ) {
$output = ( false === $zero ) ? __ ( 'No Comments' ) : $zero ;
} else { // must be one
$output = ( false === $one ) ? __ ( '1 Comment' ) : $one ;
}
2013-09-23 21:21:09 +00:00
/**
* Filter the comments count for display.
*
2013-10-30 14:39:10 +00:00
* @since 1.5.0
2013-09-23 21:21:09 +00:00
*
2014-02-10 03:20:12 +00:00
* @see _n()
*
* @param string $output A translatable string formatted based on whether the count
* is equal to 0, 1, or 1+.
2013-09-23 21:21:09 +00:00
* @param int $number The number of post comments.
*/
2014-06-29 23:13:15 +00:00
return 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
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2007-12-26 17:18:13 +00:00
*
2014-02-10 03:20:12 +00:00
* @see Walker_Comment::comment()
*
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to get the text.
* Default current comment.
* @param array $args Optional. An array of arguments. Default empty.
2013-09-21 18:18:09 +00:00
* @return string The comment content.
2007-12-26 17:18:13 +00:00
*/
2013-09-21 18:18:09 +00:00
function get_comment_text ( $comment_ID = 0 , $args = array () ) {
2010-01-25 17:34:13 +00:00
$comment = get_comment ( $comment_ID );
2013-09-21 18:18:09 +00:00
/**
* Filter the text of a comment.
*
2013-10-30 14:39:10 +00:00
* @since 1.5.0
2013-09-21 18:18:09 +00:00
*
2014-02-10 03:20:12 +00:00
* @see Walker_Comment::comment()
*
2015-09-03 18:17:24 +00:00
* @param string $comment_content Text of the comment.
* @param WP_Comment $comment The comment object.
* @param array $args An array of arguments.
2013-09-21 18:18:09 +00:00
*/
return apply_filters ( 'get_comment_text' , $comment -> comment_content , $comment , $args );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2013-09-21 18:18:09 +00:00
* Display the text of the current comment.
2007-12-26 17:18:13 +00:00
*
* @since 0.71
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2010-01-25 17:34:13 +00:00
*
2014-02-10 03:20:12 +00:00
* @see Walker_Comment::comment()
*
2015-09-09 02:34:24 +00:00
* @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the text.
* Default current comment.
* @param array $args Optional. An array of arguments. Default empty array. Default empty.
2007-12-26 17:18:13 +00:00
*/
2013-09-21 18:18:09 +00:00
function comment_text ( $comment_ID = 0 , $args = array () ) {
2010-10-25 03:11:01 +00:00
$comment = get_comment ( $comment_ID );
2013-09-21 18:18:09 +00:00
2015-09-12 02:28:26 +00:00
$comment_text = get_comment_text ( $comment , $args );
2013-09-21 18:18:09 +00:00
/**
* Filter the text of a comment to be displayed.
*
2013-10-30 14:39:10 +00:00
* @since 1.2.0
2013-09-21 18:18:09 +00:00
*
2014-02-10 03:20:12 +00:00
* @see Walker_Comment::comment()
*
2015-09-03 18:17:24 +00:00
* @param string $comment_text Text of the current comment.
* @param WP_Comment $comment The comment object.
* @param array $args An array of arguments.
2013-09-21 18:18:09 +00:00
*/
echo apply_filters ( 'comment_text' , $comment_text , $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
* 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
*
2013-09-23 04:16:08 +00:00
* @param string $d Optional. The format of the time. Default user's settings.
* @param bool $gmt Optional. Whether to use the GMT date. Default false.
2014-02-10 03:20:12 +00:00
* @param bool $translate Optional. Whether to translate the time (for use in feeds).
* Default true.
* @return string The formatted time.
2007-12-26 17:18:13 +00:00
*/
2009-05-14 02:00:32 +00:00
function get_comment_time ( $d = '' , $gmt = false , $translate = true ) {
2015-09-09 02:51:24 +00:00
$comment = get_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 );
2013-09-23 21:21:09 +00:00
/**
* Filter the returned comment time.
*
2013-10-30 14:39:10 +00:00
* @since 1.5.0
2013-09-23 21:21:09 +00:00
*
* @param string|int $date The comment time, formatted as a date string or Unix timestamp.
2014-02-10 03:20:12 +00:00
* @param string $d Date format.
2013-09-23 21:21:09 +00:00
* @param bool $gmt Whether the GMT date is in use.
* @param bool $translate Whether the time is translated.
2015-09-03 18:17:24 +00:00
* @param WP_Comment $comment The comment object.
2013-09-23 21:21:09 +00:00
*/
2014-02-26 16:41:14 +00:00
return apply_filters ( 'get_comment_time' , $date , $d , $gmt , $translate , $comment );
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
*
2013-09-23 04:16:08 +00:00
* @param string $d Optional. The format of the time. Default user's settings.
2007-12-26 17:18:13 +00:00
*/
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
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
2007-12-26 17:18:13 +00:00
*
2015-09-16 13:52:25 +00:00
* @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to get the type.
* Default current comment.
2014-02-10 03:20:12 +00:00
* @return string The comment type.
2007-12-26 17:18:13 +00:00
*/
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' ;
2013-09-23 21:21:09 +00:00
/**
* Filter the returned comment type.
*
2013-10-30 14:39:10 +00:00
* @since 1.5.0
2014-10-30 03:52:22 +00:00
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
2013-09-23 21:21:09 +00:00
*
2015-09-03 18:17:24 +00:00
* @param string $comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
* @param int $comment_ID The comment ID.
* @param WP_Comment $comment The comment object.
2013-09-23 21:21:09 +00:00
*/
2015-09-10 18:10:25 +00:00
return apply_filters ( 'get_comment_type' , $comment -> comment_type , $comment -> comment_ID , $comment );
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 type of the current comment.
2007-12-26 17:18:13 +00:00
*
* @since 0.71
*
2014-02-10 03:20:12 +00:00
* @param string $commenttxt Optional. String to display for comment type. Default false.
* @param string $trackbacktxt Optional. String to display for trackback type. Default false.
* @param string $pingbacktxt Optional. String to display for pingback type. Default false.
2007-12-26 17:18:13 +00:00
*/
2013-09-23 04:16:08 +00:00
function comment_type ( $commenttxt = false , $trackbacktxt = false , $pingbacktxt = false ) {
2010-06-30 00:05:18 +00:00
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
*
2013-09-23 04:16:08 +00:00
* @return string The trackback URL after being filtered.
2007-12-26 17:18:13 +00:00
*/
2006-04-19 10:13:28 +00:00
function get_trackback_url () {
2013-09-23 21:21:09 +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' );
2013-09-23 21:21:09 +00:00
else
2010-08-28 11:57:28 +00:00
$tb_url = get_option ( 'siteurl' ) . '/wp-trackback.php?p=' . get_the_ID ();
2013-09-23 21:21:09 +00:00
/**
* Filter the returned trackback URL.
*
* @since 2.2.0
*
* @param string $tb_url The trackback URL.
*/
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
/**
2013-09-23 04:16:08 +00:00
* Display the current post's trackback URL.
2007-12-26 17:18:13 +00:00
*
* @since 0.71
*
2013-09-23 04:16:08 +00:00
* @param bool $deprecated_echo Not used.
2014-02-10 03:20:12 +00:00
* @return void|string Should only be used to echo the trackback URL, use get_trackback_url()
* for the result instead.
2007-12-26 17:18:13 +00:00
*/
2009-12-30 16:23:39 +00:00
function trackback_url ( $deprecated_echo = true ) {
2015-11-05 23:39:25 +00:00
if ( true !== $deprecated_echo ) {
_deprecated_argument ( __FUNCTION__ , '2.5' ,
/* translators: %s: get_trackback_url() */
sprintf ( __ ( 'Use %s instead if you do not want the value echoed.' ),
'<code>get_trackback_url()</code>'
)
);
}
if ( $deprecated_echo ) {
2009-12-30 16:23:39 +00:00
echo get_trackback_url ();
2015-11-05 23:39:25 +00:00
} else {
2009-12-30 16:23:39 +00:00
return get_trackback_url ();
2015-11-05 23:39:25 +00:00
}
2006-04-19 10:13:28 +00:00
}
2010-07-03 05:55:04 +00:00
/**
2013-09-23 04:16:08 +00:00
* Generate and display the RDF for the trackback information of current post.
2010-07-03 05:55:04 +00:00
*
* Deprecated in 3.0.0, and restored in 3.0.1.
*
* @since 0.71
*
2013-09-23 04:16:08 +00:00
* @param int $deprecated Not used (Was $timezone = 0).
2010-07-03 05:55:04 +00:00
*/
function trackback_rdf ( $deprecated = '' ) {
2014-03-12 12:54:15 +00:00
if ( ! empty ( $deprecated ) ) {
2010-07-03 05:55:04 +00:00
_deprecated_argument ( __FUNCTION__ , '2.5' );
2014-03-12 12:54:15 +00:00
}
2010-07-03 05:55:04 +00:00
2014-03-12 12:54:15 +00:00
if ( isset ( $_SERVER [ 'HTTP_USER_AGENT' ] ) && false !== stripos ( $_SERVER [ 'HTTP_USER_AGENT' ], 'W3C_Validator' ) ) {
2010-07-03 05:55:04 +00:00
return ;
2014-03-12 12:54:15 +00:00
}
2010-07-03 05:55:04 +00:00
echo '<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/">
<rdf:Description rdf:about="' ;
the_permalink ();
echo '"' . " \n " ;
echo ' dc:identifier="' ;
the_permalink ();
echo '"' . " \n " ;
echo ' dc:title="' . str_replace ( '--' , '--' , wptexturize ( strip_tags ( get_the_title ()))) . '"' . " \n " ;
echo ' trackback:ping="' . get_trackback_url () . '"' . " /> \n " ;
echo '</rdf:RDF>' ;
}
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
*
2014-02-10 03:20:12 +00:00
* @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
2013-09-23 04:16:08 +00:00
* @return bool True if the comments are open.
2007-12-26 17:18:13 +00:00
*/
2012-01-05 20:50:54 +00:00
function comments_open ( $post_id = null ) {
2008-02-04 20:27:45 +00:00
$_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 );
2013-09-23 21:21:09 +00:00
/**
* Filter whether the current post is open for comments.
*
2014-04-12 00:01:15 +00:00
* @since 2.5.0
2013-09-23 21:21:09 +00:00
*
* @param bool $open Whether the current post is open for comments.
* @param int|WP_Post $post_id The post ID or WP_Post object.
*/
2008-02-04 20:27:45 +00:00
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
2007-12-26 17:18:13 +00:00
*
2014-02-10 03:20:12 +00:00
* @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
2007-12-26 17:18:13 +00:00
* @return bool True if pings are accepted
*/
2012-01-05 20:50:54 +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 );
2014-04-12 00:01:15 +00:00
/**
* Filter whether the current post is open for pings.
*
* @since 2.5.0
*
* @param bool $open Whether the current post is open for pings.
* @param int|WP_Post $post_id The post ID or WP_Post object.
*/
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
/**
2013-09-23 04:16:08 +00:00
* Display 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
*/
2007-03-14 23:10:57 +00:00
function wp_comment_form_unfiltered_html_nonce () {
2012-09-04 16:29:28 +00:00
$post = get_post ();
$post_id = $post ? $post -> ID : 0 ;
2008-11-06 01:58:33 +00:00
2012-06-01 20:47:08 +00:00
if ( current_user_can ( 'unfiltered_html' ) ) {
wp_nonce_field ( 'unfiltered-html-comment_' . $post_id , '_wp_unfiltered_html_comment_disabled' , false );
echo "<script>(function(){if(window===window.parent){document.getElementById('_wp_unfiltered_html_comment_disabled').name='_wp_unfiltered_html_comment';}})();</script> \n " ;
}
2007-03-14 23:10:57 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2013-09-23 04:16:08 +00:00
* Load 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'
2014-07-09 18:07:16 +00:00
* which includes the TEMPLATEPATH and $file combined. Tries the $filtered path
2011-09-03 16:02:41 +00:00
* first and if it fails it will require the default comment template from the
2007-12-26 17:18:13 +00:00
* 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.
*
2015-12-23 07:53:26 +00:00
* Will not try to get the comments if the post has none.
2007-12-26 17:18:13 +00:00
*
2013-09-23 04:16:08 +00:00
* @since 1.5.0
*
2015-10-10 15:45:25 +00:00
* @global WP_Query $wp_query
* @global WP_Post $post
* @global wpdb $wpdb
* @global int $id
* @global WP_Comment $comment
* @global string $user_login
* @global int $user_ID
* @global string $user_identity
* @global bool $overridden_cpage
2015-12-23 07:53:26 +00:00
* @global bool $withcomments
2015-05-24 05:19:24 +00:00
*
2013-09-23 04:16:08 +00:00
* @param string $file Optional. The file to load. Default '/comments.php'.
2014-02-10 03:20:12 +00:00
* @param bool $separate_comments Optional. Whether to separate the comments by comment type.
* Default false.
2007-12-26 17:18:13 +00:00
*/
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
2014-02-10 03:20:12 +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
*/
2006-06-22 20:52:12 +00:00
$commenter = wp_get_current_commenter ();
2009-07-20 01:11:14 +00:00
2014-02-10 03:20:12 +00:00
/*
2009-07-20 01:41:05 +00:00
* The name of the current comment author escaped for use in attributes.
2014-02-10 03:20:12 +00:00
* Escaped by sanitize_comment_cookies().
2009-07-20 01:11:14 +00:00
*/
2014-02-10 03:20:12 +00:00
$comment_author = $commenter [ 'comment_author' ];
2009-07-20 01:11:14 +00:00
2014-02-10 03:20:12 +00:00
/*
2009-07-20 01:41:05 +00:00
* The email address of the current comment author escaped for use in attributes.
2014-02-10 03:20:12 +00:00
* Escaped by sanitize_comment_cookies().
2009-09-14 14:03:32 +00:00
*/
2014-02-10 03:20:12 +00:00
$comment_author_email = $commenter [ 'comment_author_email' ];
2009-07-20 01:11:14 +00:00
2014-02-10 03:20:12 +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
2014-10-19 19:39:20 +00:00
$comment_args = array (
'orderby' => 'comment_date_gmt' ,
2015-10-21 16:26:42 +00:00
'order' => 'ASC' ,
2014-10-19 19:39:20 +00:00
'status' => 'approve' ,
'post_id' => $post -> ID ,
2015-09-25 20:40:25 +00:00
'no_found_rows' => false ,
2015-09-17 20:01:24 +00:00
'update_comment_meta_cache' => false , // We lazy-load comment meta for performance.
2014-10-19 19:39:20 +00:00
);
2016-01-08 22:17:26 +00:00
if ( get_option ( 'thread_comments' ) ) {
$comment_args [ 'hierarchical' ] = 'threaded' ;
} else {
$comment_args [ 'hierarchical' ] = false ;
}
2014-10-19 19:39:20 +00:00
if ( $user_ID ) {
$comment_args [ 'include_unapproved' ] = array ( $user_ID );
2015-01-08 07:05:25 +00:00
} elseif ( ! empty ( $comment_author_email ) ) {
2014-10-19 19:39:20 +00:00
$comment_args [ 'include_unapproved' ] = array ( $comment_author_email );
2006-04-19 10:13:28 +00:00
}
2015-10-21 16:26:42 +00:00
$per_page = 0 ;
if ( get_option ( 'page_comments' ) ) {
$per_page = ( int ) get_query_var ( 'comments_per_page' );
if ( 0 === $per_page ) {
$per_page = ( int ) get_option ( 'comments_per_page' );
}
2015-09-25 20:40:25 +00:00
2015-10-21 16:26:42 +00:00
$comment_args [ 'number' ] = $per_page ;
$page = ( int ) get_query_var ( 'cpage' );
2015-09-28 19:30:26 +00:00
2015-10-21 16:26:42 +00:00
if ( $page ) {
$comment_args [ 'offset' ] = ( $page - 1 ) * $per_page ;
} elseif ( 'oldest' === get_option ( 'default_comments_page' ) ) {
$comment_args [ 'offset' ] = 0 ;
} else {
// If fetching the first page of 'newest', we need a top-level comment count.
$top_level_query = new WP_Comment_Query ();
2015-12-21 03:07:32 +00:00
$top_level_args = array (
2015-10-21 16:26:42 +00:00
'count' => true ,
'orderby' => false ,
'post_id' => $post -> ID ,
2015-12-21 03:07:32 +00:00
'status' => 'approve' ,
);
2016-01-13 03:13:25 +00:00
if ( $comment_args [ 'hierarchical' ] ) {
$top_level_args [ 'parent' ] = 0 ;
}
2015-12-21 03:07:32 +00:00
if ( isset ( $comment_args [ 'include_unapproved' ] ) ) {
$top_level_args [ 'include_unapproved' ] = $comment_args [ 'include_unapproved' ];
}
$top_level_count = $top_level_query -> query ( $top_level_args );
2015-10-21 16:26:42 +00:00
$comment_args [ 'offset' ] = ( ceil ( $top_level_count / $per_page ) - 1 ) * $per_page ;
}
2015-09-25 20:40:25 +00:00
}
2016-01-09 04:44:26 +00:00
/**
* Filters the arguments used to query comments in comments_template().
*
* @since 4.5.0
*
* @param array $comment_args {
* Array of arguments. See WP_Comment_Query::__construct() for detailed descriptions.
*
* @type string|array $orderby Field(s) to order by.
* @type string $order Order of results. Accepts 'ASC' or 'DESC'.
* @type string $status Comment status.
2016-01-11 02:28:27 +00:00
* @type array $include_unapproved Array of IDs or email addresses whose unapproved comments
* will be included in results.
2016-01-09 04:44:26 +00:00
* @type int $post_id ID of the post.
* @type bool $no_found_rows Whether to refrain from querying for found rows.
* @type bool $update_comment_meta_cache Whether to prime cache for comment meta.
* @type bool|string $hierarchical Whether to query for comments hierarchically.
* @type int $offset Comment offset.
* @type int $number Number of comments to fetch.
* }
*/
$comment_args = apply_filters ( 'comments_template_query_args' , $comment_args );
2015-09-25 20:40:25 +00:00
$comment_query = new WP_Comment_Query ( $comment_args );
$_comments = $comment_query -> comments ;
// Trees must be flattened before they're passed to the walker.
2016-01-08 22:17:26 +00:00
if ( $comment_args [ 'hierarchical' ] ) {
$comments_flat = array ();
foreach ( $_comments as $_comment ) {
$comments_flat [] = $_comment ;
$comment_children = $_comment -> get_children ( array (
'format' => 'flat' ,
'status' => $comment_args [ 'status' ],
'orderby' => $comment_args [ 'orderby' ]
) );
foreach ( $comment_children as $comment_child ) {
$comments_flat [] = $comment_child ;
}
2015-12-14 19:37:43 +00:00
}
2016-01-08 22:17:26 +00:00
} else {
$comments_flat = $_comments ;
2015-09-25 20:40:25 +00:00
}
2014-10-19 19:39:20 +00:00
2013-09-23 21:21:09 +00:00
/**
* Filter the comments array.
*
* @since 2.1.0
*
2014-02-10 03:20:12 +00:00
* @param array $comments Array of comments supplied to the comments template.
* @param int $post_ID Post ID.
2013-09-23 21:21:09 +00:00
*/
2015-09-25 20:40:25 +00:00
$wp_query -> comments = apply_filters ( 'comments_array' , $comments_flat , $post -> ID );
2015-09-30 01:35:26 +00:00
// Set up lazy-loading for comment metadata.
add_action ( 'get_comment_metadata' , array ( $wp_query , 'lazyload_comment_meta' ), 10 , 2 );
2008-09-16 00:23:38 +00:00
$comments = & $wp_query -> comments ;
2007-02-24 07:33:29 +00:00
$wp_query -> comment_count = count ( $wp_query -> comments );
2015-09-25 20:40:25 +00:00
$wp_query -> max_num_comment_pages = $comment_query -> max_num_pages ;
2006-12-01 03:30:26 +00:00
2008-10-06 23:16:26 +00:00
if ( $separate_comments ) {
2012-10-04 18:21:47 +00:00
$wp_query -> comments_by_type = separate_comments ( $comments );
2008-10-06 23:16:26 +00:00
$comments_by_type = & $wp_query -> comments_by_type ;
2015-09-24 16:31:24 +00:00
} else {
$wp_query -> comments_by_type = array ();
2008-10-06 23:16:26 +00:00
}
2012-01-05 20:50:54 +00:00
$overridden_cpage = false ;
2015-10-21 16:26:42 +00:00
if ( '' == get_query_var ( 'cpage' ) && $wp_query -> max_num_comment_pages > 1 ) {
2008-12-12 20:08:49 +00:00
set_query_var ( 'cpage' , 'newest' == get_option ( 'default_comments_page' ) ? get_comment_pages_count () : 1 );
2012-01-05 20:50:54 +00:00
$overridden_cpage = true ;
2008-10-24 07:27:19 +00:00
}
2008-10-23 16:08:47 +00:00
2012-07-25 17:54:35 +00:00
if ( ! defined ( 'COMMENTS_TEMPLATE' ) )
2009-04-16 18:51:50 +00:00
define ( 'COMMENTS_TEMPLATE' , true );
2008-08-09 05:36:14 +00:00
2014-07-09 18:07:16 +00:00
$theme_template = STYLESHEETPATH . $file ;
2013-09-23 21:21:09 +00:00
/**
* Filter the path to the theme template file used for the comments template.
*
2013-10-30 14:39:10 +00:00
* @since 1.5.1
2013-09-23 21:21:09 +00:00
*
* @param string $theme_template The path to the theme template file.
*/
$include = apply_filters ( 'comments_template' , $theme_template );
2006-04-19 10:13:28 +00:00
if ( file_exists ( $include ) )
require ( $include );
2014-07-09 18:07:16 +00:00
elseif ( file_exists ( TEMPLATEPATH . $file ) )
require ( TEMPLATEPATH . $file );
2010-05-03 09:57:24 +00:00
else // Backward compat code will be removed in a future release
2010-07-16 09:40:09 +00:00
require ( ABSPATH . WPINC . '/theme-compat/comments.php' );
2006-04-19 10:13:28 +00:00
}
2007-12-26 17:18:13 +00:00
/**
2015-12-10 03:06:30 +00:00
* Displays the link to the comments for the current post ID.
2013-09-23 04:16:08 +00:00
*
2007-12-26 17:18:13 +00:00
* @since 0.71
2013-09-23 04:16:08 +00:00
*
2014-02-10 03:20:12 +00:00
* @param string $zero Optional. String to display when no comments. Default false.
* @param string $one Optional. String to display when only one comment is available.
* Default false.
* @param string $more Optional. String to display when there are more than one comment.
* Default false.
* @param string $css_class Optional. CSS class to use for comments. Default empty.
* @param string $none Optional. String to display when comments have been turned off.
* Default false.
2007-12-26 17:18:13 +00:00
*/
2009-04-16 18:51:50 +00:00
function comments_popup_link ( $zero = false , $one = false , $more = false , $css_class = '' , $none = false ) {
2010-08-28 11:57:28 +00:00
$id = get_the_ID ();
2015-02-09 19:27:28 +00:00
$title = get_the_title ();
2007-12-10 20:49:46 +00:00
$number = get_comments_number ( $id );
2015-02-09 20:15:27 +00:00
if ( false === $zero ) {
2015-03-18 21:52:27 +00:00
/* translators: %s: post title */
$zero = sprintf ( __ ( 'No Comments<span class="screen-reader-text"> on %s</span>' ), $title );
2015-02-09 20:15:27 +00:00
}
2015-03-18 21:52:27 +00:00
2015-02-09 20:15:27 +00:00
if ( false === $one ) {
2015-03-18 21:52:27 +00:00
/* translators: %s: post title */
$one = sprintf ( __ ( '1 Comment<span class="screen-reader-text"> on %s</span>' ), $title );
2015-02-09 20:15:27 +00:00
}
2015-03-18 21:52:27 +00:00
2015-02-09 20:15:27 +00:00
if ( false === $more ) {
2015-03-18 21:52:27 +00:00
/* translators: 1: Number of comments 2: post title */
$more = _n ( '%1$s Comment<span class="screen-reader-text"> on %2$s</span>' , '%1$s Comments<span class="screen-reader-text"> on %2$s</span>' , $number );
$more = sprintf ( $more , number_format_i18n ( $number ), $title );
2015-02-09 20:15:27 +00:00
}
2015-03-18 21:52:27 +00:00
2015-02-09 20:15:27 +00:00
if ( false === $none ) {
2015-03-18 21:52:27 +00:00
/* translators: %s: post title */
$none = sprintf ( __ ( 'Comments Off<span class="screen-reader-text"> on %s</span>' ), $title );
2015-02-09 20:15:27 +00:00
}
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 () ) {
2015-05-03 16:18:28 +00:00
_e ( '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="' ;
2015-12-10 03:06:30 +00:00
if ( 0 == $number ) {
$respond_link = get_permalink () . '#respond' ;
/**
* Filter the respond link when a post has no comments.
*
* @since 4.4.0
*
* @param string $respond_link The default response link.
* @param integer $id The post ID.
*/
echo apply_filters ( 'respond_link' , $respond_link , $id );
2015-09-15 20:46:35 +00:00
} else {
2015-12-10 03:06:30 +00:00
comments_link ();
2006-04-19 10:13:28 +00:00
}
2015-12-10 03:06:30 +00:00
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
}
2008-02-05 06:47:27 +00:00
2013-09-23 21:21:09 +00:00
$attributes = '' ;
/**
2015-12-10 03:06:30 +00:00
* Filter the comments link attributes for display.
2013-09-23 21:21:09 +00:00
*
* @since 2.5.0
*
2015-12-10 03:06:30 +00:00
* @param string $attributes The comments link attributes. Default empty.
2013-09-23 21:21:09 +00:00
*/
echo apply_filters ( 'comments_popup_link_attributes' , $attributes );
2007-12-10 20:49:46 +00:00
2015-02-09 19:27:28 +00:00
echo '>' ;
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.
*
* @since 2.7.0
2015-09-16 13:52:25 +00:00
* @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object.
2008-09-24 20:02:41 +00:00
*
2013-09-13 19:20:09 +00:00
* @param array $args {
2013-09-23 04:16:08 +00:00
* Optional. Override default arguments.
*
2014-02-10 03:20:12 +00:00
* @type string $add_below The first part of the selector used to identify the comment to respond below.
* The resulting value is passed as the first parameter to addComment.moveForm(),
* concatenated as $add_below-$comment->comment_ID. Default 'comment'.
* @type string $respond_id The selector identifying the responding comment. Passed as the third parameter
* to addComment.moveForm(), and appended to the link URL as a hash value.
* Default 'respond'.
* @type string $reply_text The text of the Reply link. Default 'Reply'.
* @type string $login_text The text of the link to reply if logged out. Default 'Log in to Reply'.
* @type int $depth' The depth of the new comment. Must be greater than 0 and less than the value
* of the 'thread_comments_depth' option set in Settings > Discussion. Default 0.
* @type string $before The text or HTML to add before the reply link. Default empty.
* @type string $after The text or HTML to add after the reply link. Default empty.
2013-09-13 19:20:09 +00:00
* }
2015-09-16 13:52:25 +00:00
* @param int|WP_Comment $comment Comment being replied to. Default current comment.
* @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
* Default current post.
2015-05-24 05:40:25 +00:00
* @return void|false|string Link to show comment form, if successful. False, if comments are closed.
2008-09-24 20:02:41 +00:00
*/
2014-05-15 15:35:15 +00:00
function get_comment_reply_link ( $args = array (), $comment = null , $post = null ) {
2013-09-13 19:20:09 +00:00
$defaults = array (
2014-10-02 20:41:16 +00:00
'add_below' => 'comment' ,
'respond_id' => 'respond' ,
'reply_text' => __ ( 'Reply' ),
'reply_to_text' => __ ( 'Reply to %s' ),
'login_text' => __ ( 'Log in to Reply' ),
'depth' => 0 ,
'before' => '' ,
'after' => ''
2013-09-13 19:20:09 +00:00
);
2008-09-11 19:25:50 +00:00
2014-05-15 15:35:15 +00:00
$args = wp_parse_args ( $args , $defaults );
2008-09-11 19:25:50 +00:00
2014-05-15 15:35:15 +00:00
if ( 0 == $args [ 'depth' ] || $args [ 'max_depth' ] <= $args [ 'depth' ] ) {
2008-09-16 00:24:43 +00:00
return ;
2014-05-15 15:35:15 +00:00
}
2008-09-12 23:45:15 +00:00
2014-05-15 15:35:15 +00:00
$comment = get_comment ( $comment );
2014-10-02 20:45:16 +00:00
2014-05-15 15:35:15 +00:00
if ( empty ( $post ) ) {
2010-02-25 07:56:25 +00:00
$post = $comment -> comment_post_ID ;
2014-05-15 15:35:15 +00:00
}
2014-10-02 20:45:16 +00:00
2014-05-15 15:35:15 +00:00
$post = get_post ( $post );
2008-09-11 19:25:50 +00:00
2014-05-15 15:35:15 +00:00
if ( ! comments_open ( $post -> ID ) ) {
2008-09-11 19:25:50 +00:00
return false ;
2014-05-15 15:35:15 +00:00
}
2008-09-11 19:25:50 +00:00
2014-10-27 11:45:18 +00:00
/**
* Filter the comment reply link arguments.
*
* @since 4.1.0
*
2015-09-16 13:52:25 +00:00
* @param array $args Comment reply link arguments. See get_comment_reply_link()
* for more information on accepted arguments.
* @param WP_Comment $comment The object of the comment being replied to.
* @param WP_Post $post The WP_Post object.
2014-10-27 11:45:18 +00:00
*/
$args = apply_filters ( 'comment_reply_link_args' , $args , $comment , $post );
2014-05-15 15:35:15 +00:00
if ( get_option ( 'comment_registration' ) && ! is_user_logged_in () ) {
2014-10-02 20:45:16 +00:00
$link = sprintf ( '<a rel="nofollow" class="comment-reply-login" href="%s">%s</a>' ,
esc_url ( wp_login_url ( get_permalink () ) ),
$args [ 'login_text' ]
);
2014-05-15 15:35:15 +00:00
} else {
2014-10-02 20:45:16 +00:00
$onclick = sprintf ( 'return addComment.moveForm( "%1$s-%2$s", "%2$s", "%3$s", "%4$s" )' ,
$args [ 'add_below' ], $comment -> comment_ID , $args [ 'respond_id' ], $post -> ID
);
2015-07-02 11:09:25 +00:00
$link = sprintf ( "<a rel='nofollow' class='comment-reply-link' href='%s' onclick='%s' aria-label='%s'>%s</a>" ,
2015-07-02 00:47:24 +00:00
esc_url ( add_query_arg ( 'replytocom' , $comment -> comment_ID , get_permalink ( $post -> ID ) ) ) . "#" . $args [ 'respond_id' ],
2014-10-02 20:45:16 +00:00
$onclick ,
esc_attr ( sprintf ( $args [ 'reply_to_text' ], $comment -> comment_author ) ),
$args [ 'reply_text' ]
);
2014-05-15 15:35:15 +00:00
}
2015-09-16 13:52:25 +00:00
2013-09-13 19:20:09 +00:00
/**
* Filter the comment reply link.
*
* @since 2.7.0
*
* @param string $link The HTML markup for the comment reply link.
* @param array $args An array of arguments overriding the defaults.
* @param object $comment The object of the comment being replied.
* @param WP_Post $post The WP_Post object.
*/
2014-05-15 15:35:15 +00:00
return apply_filters ( 'comment_reply_link' , $args [ 'before' ] . $link . $args [ '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
*
2014-02-10 03:20:12 +00:00
* @see get_comment_reply_link()
*
* @param array $args Optional. Override default options.
* @param int $comment Comment being replied to. Default current comment.
* @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
* Default current post.
2013-09-23 04:16:08 +00:00
* @return mixed Link to show comment form, if successful. False, if comments are closed.
2008-10-29 22:56:48 +00:00
*/
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.
*
* @since 2.7.0
*
2013-09-23 04:16:08 +00:00
* @param array $args {
* Optional. Override default arguments.
*
2014-02-10 03:20:12 +00:00
* @type string $add_below The first part of the selector used to identify the comment to respond below.
* The resulting value is passed as the first parameter to addComment.moveForm(),
* concatenated as $add_below-$comment->comment_ID. Default is 'post'.
* @type string $respond_id The selector identifying the responding comment. Passed as the third parameter
* to addComment.moveForm(), and appended to the link URL as a hash value.
* Default 'respond'.
* @type string $reply_text Text of the Reply link. Default is 'Leave a Comment'.
* @type string $login_text Text of the link to reply if logged out. Default is 'Log in to leave a Comment'.
* @type string $before Text or HTML to add before the reply link. Default empty.
* @type string $after Text or HTML to add after the reply link. Default empty.
2013-09-23 04:16:08 +00:00
* }
2014-02-10 03:20:12 +00:00
* @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on.
* Default current post.
2014-12-01 01:34:24 +00:00
* @return false|null|string Link to show comment form, if successful. False, if comments are closed.
2008-12-10 11:49:37 +00:00
*/
2008-12-10 21:06:13 +00:00
function get_post_reply_link ( $args = array (), $post = null ) {
2013-09-22 10:16:09 +00:00
$defaults = array (
'add_below' => 'post' ,
'respond_id' => 'respond' ,
'reply_text' => __ ( 'Leave a Comment' ),
'login_text' => __ ( 'Log in to leave a Comment' ),
'before' => '' ,
'after' => '' ,
);
2008-12-10 11:49:37 +00:00
$args = wp_parse_args ( $args , $defaults );
2014-10-02 20:45:16 +00:00
2008-12-10 11:49:37 +00:00
$post = get_post ( $post );
2009-03-18 02:43:45 +00:00
2014-05-15 06:49:14 +00:00
if ( ! comments_open ( $post -> ID ) ) {
2008-12-10 11:49:37 +00:00
return false ;
2014-05-15 06:49:14 +00:00
}
2008-12-10 11:49:37 +00:00
2014-05-15 06:49:14 +00:00
if ( get_option ( 'comment_registration' ) && ! is_user_logged_in () ) {
2015-02-11 16:11:28 +00:00
$link = sprintf ( '<a rel="nofollow" class="comment-reply-login" href="%s">%s</a>' ,
2014-10-02 20:45:16 +00:00
wp_login_url ( get_permalink () ),
$args [ 'login_text' ]
);
2014-05-15 06:49:14 +00:00
} else {
2014-10-02 20:45:16 +00:00
$onclick = sprintf ( 'return addComment.moveForm( "%1$s-%2$s", "0", "%3$s", "%2$s" )' ,
$args [ 'add_below' ], $post -> ID , $args [ 'respond_id' ]
);
$link = sprintf ( "<a rel='nofollow' class='comment-reply-link' href='%s' onclick='%s'>%s</a>" ,
get_permalink ( $post -> ID ) . '#' . $args [ 'respond_id' ],
$onclick ,
$args [ 'reply_text' ]
);
2014-05-15 06:49:14 +00:00
}
$formatted_link = $args [ 'before' ] . $link . $args [ 'after' ];
2015-09-16 13:52:25 +00:00
2013-09-23 21:21:09 +00:00
/**
* Filter the formatted post comments link HTML.
*
* @since 2.7.0
*
* @param string $formatted The HTML-formatted post comments link.
* @param int|WP_Post $post The post ID or WP_Post object.
*/
return apply_filters ( 'post_comments_link' , $formatted_link , $post );
2008-12-10 11:49:37 +00:00
}
/**
* Displays the HTML content for reply to post link.
2013-09-22 10:16:09 +00:00
*
2008-12-10 11:49:37 +00:00
* @since 2.7.0
*
2014-02-10 03:20:12 +00:00
* @see get_post_reply_link()
*
* @param array $args Optional. Override default options,
* @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
* Default 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 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
*
2013-09-23 04:16:08 +00:00
* @param string $text Optional. Text to display for cancel reply link. Default empty.
2015-05-24 05:19:24 +00:00
* @return string
2008-09-24 20:02:41 +00:00
*/
2013-09-23 04:16:08 +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
2015-07-02 00:47:24 +00:00
$style = isset ( $_GET [ 'replytocom' ]) ? '' : ' style="display:none;"' ;
$link = esc_html ( remove_query_arg ( 'replytocom' ) ) . '#respond' ;
2013-09-23 21:21:09 +00:00
2015-07-02 00:47:24 +00:00
$formatted_link = '<a rel="nofollow" id="cancel-comment-reply-link" href="' . $link . '"' . $style . '>' . $text . '</a>' ;
2015-09-16 13:52:25 +00:00
2013-09-23 21:21:09 +00:00
/**
* Filter the cancel comment reply link HTML.
*
* @since 2.7.0
*
* @param string $formatted_link The HTML-formatted cancel comment reply link.
2014-02-10 03:20:12 +00:00
* @param string $link Cancel comment reply link URL.
* @param string $text Cancel comment reply link text.
2013-09-23 21:21:09 +00:00
*/
return apply_filters ( 'cancel_comment_reply_link' , $formatted_link , $link , $text );
2008-10-29 22:56:48 +00:00
}
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
*
2013-09-23 04:16:08 +00:00
* @param string $text Optional. Text to display for cancel reply link. Default empty.
2008-10-29 22:56:48 +00:00
*/
2013-09-23 04:16:08 +00:00
function cancel_comment_reply_link ( $text = '' ) {
2008-10-29 22:56:48 +00:00
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
*
2013-09-23 04:16:08 +00:00
* @param int $id Optional. Post ID. Default current post ID.
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
*/
2011-05-05 19:33:47 +00:00
function get_comment_id_fields ( $id = 0 ) {
if ( empty ( $id ) )
$id = get_the_ID ();
2008-10-14 19:06:18 +00:00
2015-07-02 00:47:24 +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 " ;
2015-07-02 00:47:24 +00:00
$result .= "<input type='hidden' name='comment_parent' id='comment_parent' value=' $replytoid ' /> \n " ;
2013-09-23 21:21:09 +00:00
/**
* Filter the returned comment id fields.
*
* @since 3.0.0
*
2015-07-02 00:47:24 +00:00
* @param string $result The HTML-formatted hidden id field comment elements.
* @param int $id The post ID.
* @param int $replytoid The id of the comment being replied to.
2013-09-23 21:21:09 +00:00
*/
2015-07-02 00:47:24 +00:00
return apply_filters ( 'comment_id_fields' , $result , $id , $replytoid );
2010-04-11 08:56:18 +00:00
}
/**
* Output hidden input HTML for replying to comments.
*
* @since 2.7.0
2013-09-23 04:16:08 +00:00
*
* @param int $id Optional. Post ID. Default current post ID.
2010-04-11 08:56:18 +00:00
*/
2011-05-05 19:33:47 +00:00
function comment_id_fields ( $id = 0 ) {
echo get_comment_id_fields ( $id );
2008-10-09 07:37:05 +00:00
}
/**
2013-09-23 04:16:08 +00:00
* Display text based on comment reply status.
*
2014-12-02 00:31:22 +00:00
* Only affects users with JavaScript disabled.
2008-10-09 07:37:05 +00:00
*
* @since 2.7.0
*
2014-02-10 03:20:12 +00:00
* @param string $noreplytext Optional. Text to display when not replying to a comment.
* Default false.
2015-07-02 00:47:24 +00:00
* @param string $replytext Optional. Text to display when replying to a comment.
* Default false. 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. Default true.
2008-10-09 07:37:05 +00:00
*/
2015-07-02 00:47:24 +00:00
function comment_form_title ( $noreplytext = false , $replytext = false , $linktoparent = true ) {
2015-09-09 02:51:24 +00:00
$comment = get_comment ();
2009-04-20 18:18:39 +00:00
2009-04-16 18:51:50 +00:00
if ( false === $noreplytext ) $noreplytext = __ ( 'Leave a Reply' );
2015-07-02 00:47:24 +00:00
if ( false === $replytext ) $replytext = __ ( 'Leave a Reply to %s' );
$replytoid = isset ( $_GET [ 'replytocom' ]) ? ( int ) $_GET [ 'replytocom' ] : 0 ;
2008-10-09 07:37:05 +00:00
2015-07-02 00:47:24 +00:00
if ( 0 == $replytoid )
echo $noreplytext ;
else {
$comment = get_comment ( $replytoid );
2015-09-11 06:05:24 +00:00
$author = ( $linktoparent ) ? '<a href="#comment-' . get_comment_ID () . '">' . get_comment_author ( $comment ) . '</a>' : get_comment_author ( $comment );
2015-07-02 00:47:24 +00:00
printf ( $replytext , $author );
}
2008-09-11 19:25:50 +00:00
}
/**
2013-09-23 04:16:08 +00:00
* List comments.
2008-09-11 19:25:50 +00:00
*
2013-09-23 04:16:08 +00:00
* Used in the comments.php template to list comments for a particular post.
2008-09-11 19:25:50 +00:00
*
2008-09-24 20:02:41 +00:00
* @since 2.7.0
2008-09-11 19:25:50 +00:00
*
2014-02-10 03:20:12 +00:00
* @see WP_Query->comments
*
2015-05-24 05:19:24 +00:00
* @global WP_Query $wp_query
* @global int $comment_alt
* @global int $comment_depth
* @global int $comment_thread_alt
* @global bool $overridden_cpage
* @global bool $in_comment_loop
*
2013-09-23 04:16:08 +00:00
* @param string|array $args {
* Optional. Formatting options.
*
2014-07-24 22:25:16 +00:00
* @type object $walker Instance of a Walker class to list comments. Default null.
2014-02-10 03:20:12 +00:00
* @type int $max_depth The maximum comments depth. Default empty.
* @type string $style The style of list ordering. Default 'ul'. Accepts 'ul', 'ol'.
* @type string $callback Callback function to use. Default null.
* @type string $end-callback Callback function to use at the end. Default null.
* @type string $type Type of comments to list.
* Default 'all'. Accepts 'all', 'comment', 'pingback', 'trackback', 'pings'.
* @type int $page Page ID to list comments for. Default empty.
* @type int $per_page Number of comments to list per page. Default empty.
* @type int $avatar_size Height and width dimensions of the avatar size. Default 32.
* @type string $reverse_top_level Ordering of the listed comments. Default null. Accepts 'desc', 'asc'.
* @type bool $reverse_children Whether to reverse child comments in the list. Default null.
* @type string $format How to format the comments list.
* Default 'html5' if the theme supports it. Accepts 'html5', 'xhtml'.
* @type bool $short_ping Whether to output short pings. Default false.
* @type bool $echo Whether to echo the output or return it. Default true.
2013-09-23 04:16:08 +00:00
* }
2015-09-03 18:17:24 +00:00
* @param array $comments Optional. Array of WP_Comment objects.
2008-09-11 19:25:50 +00:00
*/
2013-09-23 04:16:08 +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
2013-03-14 04:26:04 +00:00
$defaults = array (
'walker' => null ,
'max_depth' => '' ,
'style' => 'ul' ,
'callback' => null ,
'end-callback' => null ,
'type' => 'all' ,
'page' => '' ,
'per_page' => '' ,
'avatar_size' => 32 ,
'reverse_top_level' => null ,
'reverse_children' => '' ,
2013-06-06 15:31:34 +00:00
'format' => current_theme_supports ( 'html5' , 'comment-list' ) ? 'html5' : 'xhtml' ,
2013-03-14 04:26:04 +00:00
'short_ping' => false ,
2013-11-24 14:59:10 +00:00
'echo' => true ,
2013-03-14 04:26:04 +00:00
);
2008-09-11 19:25:50 +00:00
$r = wp_parse_args ( $args , $defaults );
2014-05-06 11:58:14 +00:00
/**
* Filter the arguments used in retrieving the comment list.
*
* @since 4.0.0
*
2014-07-14 01:02:15 +00:00
* @see wp_list_comments()
*
2014-05-06 11:58:14 +00:00
* @param array $r An array of arguments for displaying comments.
*/
$r = apply_filters ( 'wp_list_comments_args' , $r );
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' ] ) {
2012-10-04 18:26:25 +00:00
$comments_by_type = separate_comments ( $comments );
2008-11-13 20:36:36 +00:00
if ( empty ( $comments_by_type [ $r [ 'type' ]]) )
return ;
$_comments = $comments_by_type [ $r [ 'type' ]];
} else {
$_comments = $comments ;
}
} else {
2016-01-13 03:27:27 +00:00
/*
* If 'page' or 'per_page' has been passed, and does not match what's in $wp_query,
* perform a separate comment query and allow Walker_Comment to paginate.
*/
if ( is_singular () && ( $r [ 'page' ] || $r [ 'per_page' ] ) ) {
$current_cpage = get_query_var ( 'cpage' );
if ( ! $current_cpage ) {
$current_cpage = 'newest' === get_option ( 'default_comments_page' ) ? 1 : $wp_query -> max_num_comment_pages ;
}
2015-09-25 20:40:25 +00:00
2016-01-13 03:27:27 +00:00
$current_per_page = get_query_var ( 'comments_per_page' );
if ( $r [ 'page' ] != $current_cpage || $r [ 'per_page' ] != $current_per_page ) {
$comments = get_comments ( array (
'post_id' => get_queried_object_id (),
'orderby' => 'comment_date_gmt' ,
'order' => 'ASC' ,
'status' => 'all' ,
) );
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 ;
}
}
2015-10-01 05:13:25 +00:00
2016-01-13 03:27:27 +00:00
// Otherwise, fall back on the comments from `$wp_query->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' ]];
2015-10-01 05:13:25 +00:00
} else {
2016-01-13 03:27:27 +00:00
$_comments = $wp_query -> comments ;
2015-10-01 05:13:25 +00:00
}
2016-01-13 03:27:27 +00:00
if ( $wp_query -> max_num_comment_pages ) {
$default_comments_page = get_option ( 'default_comments_page' );
$cpage = get_query_var ( 'cpage' );
if ( 'newest' === $default_comments_page ) {
$r [ 'cpage' ] = $cpage ;
/*
* When first page shows oldest comments, post permalink is the same as
* the comment permalink.
*/
} elseif ( $cpage == 1 ) {
$r [ 'cpage' ] = '' ;
} else {
$r [ 'cpage' ] = $cpage ;
}
$r [ 'page' ] = 0 ;
$r [ 'per_page' ] = 0 ;
}
2015-09-25 20:40:25 +00:00
}
2008-11-13 20:36:36 +00:00
}
2015-10-21 16:26:42 +00:00
if ( '' === $r [ 'per_page' ] && get_option ( 'page_comments' ) ) {
2008-09-23 21:11:27 +00:00
$r [ 'per_page' ] = get_query_var ( 'comments_per_page' );
2015-10-21 16:26:42 +00:00
}
2008-09-23 21:11:27 +00:00
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
2014-05-15 06:43:15 +00:00
if ( empty ( $r [ 'walker' ] ) ) {
2008-11-13 20:36:36 +00:00
$walker = new Walker_Comment ;
2014-05-15 06:43:15 +00:00
} else {
$walker = $r [ 'walker' ];
}
2008-09-11 19:25:50 +00:00
2014-05-15 06:43:15 +00:00
$output = $walker -> paged_walk ( $_comments , $r [ 'max_depth' ], $r [ 'page' ], $r [ 'per_page' ], $r );
2008-11-20 06:41:55 +00:00
$in_comment_loop = false ;
2013-11-24 14:59:10 +00:00
2014-05-15 06:43:15 +00:00
if ( $r [ 'echo' ] ) {
2013-11-24 14:59:10 +00:00
echo $output ;
2014-05-15 06:43:15 +00:00
} else {
2013-11-24 14:59:10 +00:00
return $output ;
2014-05-15 06:43:15 +00:00
}
2008-09-11 19:25:50 +00:00
}
2010-01-23 18:06:37 +00:00
/**
2013-09-23 04:16:08 +00:00
* Output a complete commenting form for use within a template.
*
2010-01-23 18:06:37 +00:00
* Most strings and form fields may be controlled through the $args array passed
2010-05-10 08:47:13 +00:00
* into the function, while you may also choose to use the comment_form_default_fields
2010-01-23 18:06:37 +00:00
* 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
2010-05-10 08:47:13 +00:00
* a filter of the form comment_form_field_$name where $name is the key used
2010-01-23 18:06:37 +00:00
* in the array of fields.
*
2010-03-26 19:13:36 +00:00
* @since 3.0.0
2015-03-17 18:38:29 +00:00
* @since 4.1.0 Introduced the 'class_submit' argument.
2015-10-06 17:17:24 +00:00
* @since 4.2.0 Introduced the 'submit_button' and 'submit_fields' arguments.
* @since 4.4.0 Introduced the 'class_form', 'title_reply_before', 'title_reply_after',
2015-09-24 21:33:26 +00:00
* 'cancel_reply_before', and 'cancel_reply_after' arguments.
2013-09-23 04:16:08 +00:00
*
2013-09-23 17:16:08 +00:00
* @param array $args {
* Optional. Default arguments and form fields to override.
*
2014-02-10 03:20:12 +00:00
* @type array $fields {
2013-09-23 17:16:08 +00:00
* Default comment fields, filterable by default via the 'comment_form_default_fields' hook.
*
2014-02-10 03:20:12 +00:00
* @type string $author Comment author field HTML.
* @type string $email Comment author email field HTML.
* @type string $url Comment author URL field HTML.
2013-09-23 17:16:08 +00:00
* }
2014-02-10 03:20:12 +00:00
* @type string $comment_field The comment textarea field HTML.
* @type string $must_log_in HTML element for a 'must be logged in to comment' message.
2014-11-24 05:19:23 +00:00
* @type string $logged_in_as HTML element for a 'logged in as [user]' message.
2015-11-20 18:56:27 +00:00
* @type string $comment_notes_before HTML element for a message displayed before the comment fields
* if the user is not logged in.
2014-02-10 03:20:12 +00:00
* Default 'Your email address will not be published.'.
2015-11-20 18:56:27 +00:00
* @type string $comment_notes_after HTML element for a message displayed after the textarea field.
2014-02-10 03:20:12 +00:00
* @type string $id_form The comment form element id attribute. Default 'commentform'.
* @type string $id_submit The comment submit element id attribute. Default 'submit'.
2015-10-06 17:17:24 +00:00
* @type string $class_form The comment form element class attribute. Default 'comment-form'.
2014-10-02 01:44:15 +00:00
* @type string $class_submit The comment submit element class attribute. Default 'submit'.
2014-06-24 00:10:15 +00:00
* @type string $name_submit The comment submit element name attribute. Default 'submit'.
2014-02-10 03:20:12 +00:00
* @type string $title_reply The translatable 'reply' button label. Default 'Leave a Reply'.
* @type string $title_reply_to The translatable 'reply-to' button label. Default 'Leave a Reply to %s',
* where %s is the author of the comment being replied to.
2015-09-18 19:18:26 +00:00
* @type string $title_reply_before HTML displayed before the comment form title.
* Default: '<h3 id="reply-title" class="comment-reply-title">'.
* @type string $title_reply_after HTML displayed after the comment form title.
* Default: '</h3>'.
2015-09-24 21:33:26 +00:00
* @type string $cancel_reply_before HTML displayed before the cancel reply link.
* @type string $cancel_reply_after HTML displayed after the cancel reply link.
2014-02-10 03:20:12 +00:00
* @type string $cancel_reply_link The translatable 'cancel reply' button label. Default 'Cancel reply'.
* @type string $label_submit The translatable 'submit' button label. Default 'Post a comment'.
2015-03-10 19:08:26 +00:00
* @type string $submit_button HTML format for the Submit button.
* Default: '<input name="%1$s" type="submit" id="%2$s" class="%3$s" value="%4$s" />'.
* @type string $submit_field HTML format for the markup surrounding the Submit button and comment hidden
* fields. Default: '<p class="form-submit">%1$s %2$s</a>', where %1$s is the
* submit button markup and %2$s is the comment hidden fields.
2014-02-10 03:20:12 +00:00
* @type string $format The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'.
2013-09-23 17:16:08 +00:00
* }
2014-02-10 03:20:12 +00:00
* @param int|WP_Post $post_id Post ID or WP_Post object to generate the form for. Default current post.
2010-01-23 18:06:37 +00:00
*/
function comment_form ( $args = array (), $post_id = null ) {
if ( null === $post_id )
2013-05-23 18:40:16 +00:00
$post_id = get_the_ID ();
2010-01-26 22:49:05 +00:00
2010-01-23 18:06:37 +00:00
$commenter = wp_get_current_commenter ();
2011-11-14 21:35:44 +00:00
$user = wp_get_current_user ();
2012-04-06 19:18:45 +00:00
$user_identity = $user -> exists () ? $user -> display_name : '' ;
2010-01-26 22:49:05 +00:00
2013-08-28 05:28:09 +00:00
$args = wp_parse_args ( $args );
2013-06-06 15:31:34 +00:00
if ( ! isset ( $args [ 'format' ] ) )
$args [ 'format' ] = current_theme_supports ( 'html5' , 'comment-form' ) ? 'html5' : 'xhtml' ;
2013-03-13 20:31:43 +00:00
$req = get_option ( 'require_name_email' );
2010-01-23 18:06:37 +00:00
$aria_req = ( $req ? " aria-required='true'" : '' );
2015-01-16 15:56:23 +00:00
$html_req = ( $req ? " required='required'" : '' );
2013-06-06 15:31:34 +00:00
$html5 = 'html5' === $args [ 'format' ];
2013-03-13 20:31:43 +00:00
$fields = array (
2012-10-05 16:34:32 +00:00
'author' => '<p class="comment-form-author">' . '<label for="author">' . __ ( 'Name' ) . ( $req ? ' <span class="required">*</span>' : '' ) . '</label> ' .
2016-01-13 01:25:26 +00:00
'<input id="author" name="author" type="text" value="' . esc_attr ( $commenter [ 'comment_author' ] ) . '" size="30" maxlength="245"' . $aria_req . $html_req . ' /></p>' ,
2012-10-05 16:34:32 +00:00
'email' => '<p class="comment-form-email"><label for="email">' . __ ( 'Email' ) . ( $req ? ' <span class="required">*</span>' : '' ) . '</label> ' .
2016-01-13 01:25:26 +00:00
'<input id="email" name="email" ' . ( $html5 ? 'type="email"' : 'type="text"' ) . ' value="' . esc_attr ( $commenter [ 'comment_author_email' ] ) . '" size="30" maxlength="100" aria-describedby="email-notes"' . $aria_req . $html_req . ' /></p>' ,
2013-04-07 23:57:35 +00:00
'url' => '<p class="comment-form-url"><label for="url">' . __ ( 'Website' ) . '</label> ' .
2016-01-13 01:25:26 +00:00
'<input id="url" name="url" ' . ( $html5 ? 'type="url"' : 'type="text"' ) . ' value="' . esc_attr ( $commenter [ 'comment_author_url' ] ) . '" size="30" maxlength="200" /></p>' ,
2010-04-15 16:25:08 +00:00
);
2010-05-03 18:48:33 +00:00
$required_text = sprintf ( ' ' . __ ( 'Required fields are marked %s' ), '<span class="required">*</span>' );
2013-09-23 21:21:09 +00:00
/**
* Filter the default comment form fields.
*
* @since 3.0.0
*
* @param array $fields The default comment fields.
*/
$fields = apply_filters ( 'comment_form_default_fields' , $fields );
2010-04-15 16:25:08 +00:00
$defaults = array (
2013-09-23 21:21:09 +00:00
'fields' => $fields ,
2016-01-13 01:25:26 +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" maxlength="65525" aria-required="true" required="required"></textarea></p>' ,
2014-04-12 00:01:15 +00:00
/** This filter is documented in wp-includes/link-template.php */
2011-12-13 23:45:31 +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>' ,
2014-04-12 00:01:15 +00:00
/** This filter is documented in wp-includes/link-template.php */
2015-09-24 22:00:28 +00:00
'logged_in_as' => '<p class="logged-in-as">' . sprintf ( __ ( '<a href="%1$s" aria-label="Logged in as %2$s. Edit your profile.">Logged in as %2$s</a>. <a href="%3$s">Log out?</a>' ), get_edit_user_link (), $user_identity , wp_logout_url ( apply_filters ( 'the_permalink' , get_permalink ( $post_id ) ) ) ) . '</p>' ,
2014-10-06 22:11:15 +00:00
'comment_notes_before' => '<p class="comment-notes"><span id="email-notes">' . __ ( 'Your email address will not be published.' ) . '</span>' . ( $req ? $required_text : '' ) . '</p>' ,
2015-06-19 14:15:26 +00:00
'comment_notes_after' => '' ,
2010-04-15 16:25:08 +00:00
'id_form' => 'commentform' ,
'id_submit' => 'submit' ,
2015-10-06 17:17:24 +00:00
'class_form' => 'comment-form' ,
2014-10-02 01:44:15 +00:00
'class_submit' => 'submit' ,
2014-06-24 00:10:15 +00:00
'name_submit' => 'submit' ,
2010-04-15 16:25:08 +00:00
'title_reply' => __ ( 'Leave a Reply' ),
'title_reply_to' => __ ( 'Leave a Reply to %s' ),
2015-09-18 19:18:26 +00:00
'title_reply_before' => '<h3 id="reply-title" class="comment-reply-title">' ,
'title_reply_after' => '</h3>' ,
2015-09-24 21:33:26 +00:00
'cancel_reply_before' => ' <small>' ,
'cancel_reply_after' => '</small>' ,
2010-04-15 16:25:08 +00:00
'cancel_reply_link' => __ ( 'Cancel reply' ),
'label_submit' => __ ( 'Post Comment' ),
2015-03-10 19:08:26 +00:00
'submit_button' => '<input name="%1$s" type="submit" id="%2$s" class="%3$s" value="%4$s" />' ,
'submit_field' => '<p class="form-submit">%1$s %2$s</p>' ,
2013-03-13 20:31:43 +00:00
'format' => 'xhtml' ,
2010-04-15 16:25:08 +00:00
);
2013-09-23 21:21:09 +00:00
/**
* Filter the comment form default arguments.
*
* Use 'comment_form_default_fields' to filter the comment fields.
*
* @since 3.0.0
*
* @param array $defaults The default comment form arguments.
*/
2010-01-23 18:06:37 +00:00
$args = wp_parse_args ( $args , apply_filters ( 'comment_form_defaults' , $defaults ) );
2010-04-28 07:17:20 +00:00
2015-05-19 01:04:25 +00:00
// Ensure that the filtered args contain all required default values.
$args = array_merge ( $defaults , $args );
2015-09-24 22:00:28 +00:00
if ( comments_open ( $post_id ) ) : ?>
<?php
/**
* Fires before the comment form.
*
* @since 3.0.0
*/
do_action( 'comment_form_before' );
?>
<div id="respond" class="comment-respond">
2013-09-23 21:21:09 +00:00
<?php
2015-09-24 22:00:28 +00:00
echo $args['title_reply_before'];
2015-09-18 19:18:26 +00:00
2015-09-24 22:00:28 +00:00
comment_form_title( $args['title_reply'], $args['title_reply_to'] );
2015-09-18 19:18:26 +00:00
2015-09-24 22:00:28 +00:00
echo $args['cancel_reply_before'];
2015-09-18 19:18:26 +00:00
2015-09-24 22:00:28 +00:00
cancel_comment_reply_link( $args['cancel_reply_link'] );
2015-09-18 19:18:26 +00:00
2015-09-24 22:00:28 +00:00
echo $args['cancel_reply_after'];
2015-09-18 19:18:26 +00:00
2015-09-24 22:00:28 +00:00
echo $args['title_reply_after'];
2015-09-18 19:18:26 +00:00
2015-09-24 22:00:28 +00:00
if ( get_option( 'comment_registration' ) && !is_user_logged_in() ) :
echo $args['must_log_in'];
/**
* Fires after the HTML-formatted 'must log in after' message in the comment form.
*
* @since 3.0.0
*/
do_action( 'comment_form_must_log_in_after' );
else : ?>
2015-10-06 17:17:24 +00:00
<form action="<?php echo site_url( '/wp-comments-post.php' ); ?>" method="post" id="<?php echo esc_attr( $args['id_form'] ); ?>" class="<?php echo esc_attr( $args['class_form'] ); ?>"<?php echo $html5 ? ' novalidate' : ''; ?>>
2013-09-23 21:21:09 +00:00
<?php
/**
2015-09-24 22:00:28 +00:00
* Fires at the top of the comment form, inside the form tag.
2013-09-23 21:21:09 +00:00
*
* @since 3.0.0
*/
2015-09-24 22:00:28 +00:00
do_action( 'comment_form_top' );
if ( is_user_logged_in() ) :
2013-09-23 21:21:09 +00:00
/**
2015-09-24 22:00:28 +00:00
* Filter the 'logged in' message for the comment form for display.
2013-09-23 21:21:09 +00:00
*
* @since 3.0.0
*
2015-09-24 22:00:28 +00:00
* @param string $args_logged_in The logged-in-as HTML-formatted message.
* @param array $commenter An array containing the comment author's
* username, email, and URL.
* @param string $user_identity If the commenter is a registered user,
* the display name, blank otherwise.
2013-09-23 21:21:09 +00:00
*/
2015-09-24 22:00:28 +00:00
echo apply_filters( 'comment_form_logged_in', $args['logged_in_as'], $commenter, $user_identity );
2015-03-10 19:08:26 +00:00
/**
2015-09-24 22:00:28 +00:00
* Fires after the is_user_logged_in() check in the comment form.
2015-03-10 19:08:26 +00:00
*
2015-09-24 22:00:28 +00:00
* @since 3.0.0
2015-03-10 19:08:26 +00:00
*
2015-09-24 22:00:28 +00:00
* @param array $commenter An array containing the comment author's
* username, email, and URL.
* @param string $user_identity If the commenter is a registered user,
* the display name, blank otherwise.
2015-03-10 19:08:26 +00:00
*/
2015-09-24 22:00:28 +00:00
do_action( 'comment_form_logged_in_after', $commenter, $user_identity );
else :
2015-03-10 19:08:26 +00:00
2015-09-24 22:00:28 +00:00
echo $args['comment_notes_before'];
2015-03-10 19:08:26 +00:00
2015-09-24 22:00:28 +00:00
endif;
2015-11-20 18:56:27 +00:00
// Prepare an array of all fields, including the textarea
$comment_fields = array( 'comment' => $args['comment_field'] ) + (array) $args['fields'];
2015-09-24 22:00:28 +00:00
/**
2015-12-12 01:07:27 +00:00
* Filter the comment form fields, including the textarea.
2015-09-24 22:00:28 +00:00
*
2015-11-20 18:56:27 +00:00
* @since 4.4.0
2015-09-24 22:00:28 +00:00
*
2015-11-20 18:56:27 +00:00
* @param array $comment_fields The comment fields.
2015-09-24 22:00:28 +00:00
*/
2015-11-20 18:56:27 +00:00
$comment_fields = apply_filters( 'comment_form_fields', $comment_fields );
2015-09-24 22:00:28 +00:00
2015-11-20 18:56:27 +00:00
// Get an array of field names, excluding the textarea
$comment_field_keys = array_diff( array_keys( $comment_fields ), array( 'comment' ) );
// Get the first and the last field name, excluding the textarea
$first_field = reset( $comment_field_keys );
$last_field = end( $comment_field_keys );
foreach ( $comment_fields as $name => $field ) {
if ( 'comment' === $name ) {
/**
* Filter the content of the comment textarea field for display.
*
* @since 3.0.0
*
* @param string $args_comment_field The content of the comment textarea field.
*/
echo apply_filters( 'comment_form_field_comment', $field );
echo $args['comment_notes_after'];
} elseif ( ! is_user_logged_in() ) {
if ( $first_field === $name ) {
/**
* Fires before the comment fields in the comment form, excluding the textarea.
*
* @since 3.0.0
*/
do_action( 'comment_form_before_fields' );
}
2015-09-24 22:00:28 +00:00
/**
* Filter a comment form field for display.
*
* The dynamic portion of the filter hook, `$name`, refers to the name
* of the comment form field. Such as 'author', 'email', or 'url'.
*
* @since 3.0.0
*
* @param string $field The HTML-formatted output of the comment form field.
*/
echo apply_filters( "comment_form_field_{$name}", $field ) . "\n";
2015-11-20 18:56:27 +00:00
if ( $last_field === $name ) {
/**
* Fires after the comment fields in the comment form, excluding the textarea.
*
* @since 3.0.0
*/
do_action( 'comment_form_after_fields' );
}
}
}
2015-09-24 22:00:28 +00:00
$submit_button = sprintf(
$args['submit_button'],
esc_attr( $args['name_submit'] ),
esc_attr( $args['id_submit'] ),
esc_attr( $args['class_submit'] ),
esc_attr( $args['label_submit'] )
);
/**
* Filter the submit button for the comment form to display.
*
* @since 4.2.0
*
* @param string $submit_button HTML markup for the submit button.
* @param array $args Arguments passed to `comment_form()`.
*/
$submit_button = apply_filters( 'comment_form_submit_button', $submit_button, $args );
$submit_field = sprintf(
$args['submit_field'],
$submit_button,
get_comment_id_fields( $post_id )
);
/**
* Filter the submit field for the comment form to display.
*
* The submit field includes the submit button, hidden fields for the
* comment form, and any wrapper markup.
*
* @since 4.2.0
*
* @param string $submit_field HTML markup for the submit field.
* @param array $args Arguments passed to comment_form().
*/
echo apply_filters( 'comment_form_submit_field', $submit_field, $args );
/**
* Fires at the bottom of the comment form, inside the closing </form> tag.
*
* @since 1.5.0
*
* @param int $post_id The post ID.
*/
do_action( 'comment_form', $post_id );
?>
</form>
<?php endif; ?>
</div><!-- #respond -->
<?php
/**
* Fires after the comment form.
*
* @since 3.0.0
*/
do_action( 'comment_form_after' );
else :
/**
* Fires after the comment form if comments are closed.
*
* @since 3.0.0
*/
do_action( 'comment_form_comments_closed' );
endif;
2010-01-23 18:06:37 +00:00
}