X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/48ab98cb1779cf2088c1351ac3dd3d0da6fb31d3..b22765f41bf0b2021b9beb9120ee0ac91fa89292:/wp-includes/comment-template.php
diff --git a/wp-includes/comment-template.php b/wp-includes/comment-template.php
index 0d44376b..42ebd41e 100644
--- a/wp-includes/comment-template.php
+++ b/wp-includes/comment-template.php
@@ -15,8 +15,10 @@
* assumed.
*
* @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param int $comment_ID Optional. The ID of the comment for which to retrieve the author. Default current comment.
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to retrieve the author.
+ * Default current comment.
* @return string The comment author
*/
function get_comment_author( $comment_ID = 0 ) {
@@ -32,53 +34,67 @@ function get_comment_author( $comment_ID = 0 ) {
}
/**
- * Filter the returned comment author name.
+ * Filters the returned comment author name.
*
* @since 1.5.0
+ * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
- * @param string $author The comment author's username.
+ * @param string $author The comment author's username.
+ * @param int $comment_ID The comment ID.
+ * @param WP_Comment $comment The comment object.
*/
- return apply_filters( 'get_comment_author', $author );
+ return apply_filters( 'get_comment_author', $author, $comment->comment_ID, $comment );
}
/**
* Displays the author of the current comment.
*
* @since 0.71
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param int $comment_ID Optional. The ID of the comment for which to print the author. Default current comment.
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author.
+ * Default current comment.
*/
function comment_author( $comment_ID = 0 ) {
- $author = get_comment_author( $comment_ID );
+ $comment = get_comment( $comment_ID );
+ $author = get_comment_author( $comment );
+
/**
- * Filter the comment author's name for display.
+ * Filters the comment author's name for display.
*
* @since 1.2.0
+ * @since 4.1.0 The `$comment_ID` parameter was added.
*
- * @param string $author The comment author's username.
+ * @param string $author The comment author's username.
+ * @param int $comment_ID The comment ID.
*/
- $author = apply_filters( 'comment_author', $author );
- echo $author;
+ echo apply_filters( 'comment_author', $author, $comment->comment_ID );
}
/**
* Retrieve the email of the author of the current comment.
*
* @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param int $comment_ID Optional. The ID of the comment for which to get the author's email. Default current comment.
+ * @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.
* @return string The current comment author's email
*/
function get_comment_author_email( $comment_ID = 0 ) {
$comment = get_comment( $comment_ID );
+
/**
- * Filter the comment author's returned email address.
+ * Filters the comment author's returned email address.
*
* @since 1.5.0
+ * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
- * @param string $comment_author_email The comment author's email address.
+ * @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.
*/
- return apply_filters( 'get_comment_author_email', $comment->comment_author_email );
+ return apply_filters( 'get_comment_author_email', $comment->comment_author_email, $comment->comment_ID, $comment );
}
/**
@@ -86,24 +102,30 @@ function get_comment_author_email( $comment_ID = 0 ) {
*
* 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
+ * their email address will not appear in raw form on the site. Doing so will
* enable anyone, including those that people don't want to get the email
* address and use it for their own means good and bad.
*
* @since 0.71
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param int $comment_ID Optional. The ID of the comment for which to print the author's email. Default current comment.
+ * @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.
*/
function comment_author_email( $comment_ID = 0 ) {
- $author_email = get_comment_author_email( $comment_ID );
+ $comment = get_comment( $comment_ID );
+ $author_email = get_comment_author_email( $comment );
+
/**
- * Filter the comment author's email for display.
+ * Filters the comment author's email for display.
*
* @since 1.2.0
+ * @since 4.1.0 The `$comment_ID` parameter was added.
*
* @param string $author_email The comment author's email address.
+ * @param int $comment_ID The comment ID.
*/
- echo apply_filters( 'author_email', $author_email );
+ echo apply_filters( 'author_email', $author_email, $comment->comment_ID );
}
/**
@@ -111,20 +133,23 @@ function comment_author_email( $comment_ID = 0 ) {
*
* 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
+ * their email address will not appear in raw form on the site. Doing so will
* enable anyone, including those that people don't want to get the email
* address and use it for their own means good and bad.
*
* @since 0.71
+ * @since 4.6.0 Added the `$comment` parameter.
*
- * @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.
+ * @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.
+ * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment.
*/
-function comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
- if ( $link = get_comment_author_email_link( $linktext, $before, $after ) )
+function comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) {
+ if ( $link = get_comment_author_email_link( $linktext, $before, $after, $comment ) ) {
echo $link;
+ }
}
/**
@@ -132,36 +157,42 @@ function comment_author_email_link( $linktext = '', $before = '', $after = '' )
*
* 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
+ * their email address will not appear in raw form on the site. 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.
*
- * @global object $comment The current Comment row object.
- *
* @since 2.7.0
+ * @since 4.6.0 Added the `$comment` parameter.
*
- * @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.
+ * @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.
+ * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment.
+ * @return string HTML markup for the comment author email link. By default, the email address is obfuscated
+ * via the {@see 'comment_email'} filter with antispambot().
*/
-function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
- global $comment;
+function get_comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) {
+ $comment = get_comment( $comment );
+
/**
- * Filter the comment author's email for display.
+ * Filters the comment author's email for display.
*
* Care should be taken to protect the email address and assure that email
- * harvesters do not capture your commenters' email address.
+ * harvesters do not capture your commenter's email address.
*
* @since 1.2.0
+ * @since 4.1.0 The `$comment` parameter was added.
*
- * @param string $comment_author_email The comment author's email address.
+ * @param string $comment_author_email The comment author's email address.
+ * @param WP_Comment $comment The comment object.
*/
- $email = apply_filters( 'comment_email', $comment->comment_author_email );
+ $email = apply_filters( 'comment_email', $comment->comment_author_email, $comment );
+
if ((!empty($email)) && ($email != '@')) {
$display = ($linktext != '') ? $linktext : $email;
$return = $before;
- $return .= "$display";
+ $return .= sprintf( '%2$s', esc_url( 'mailto:' . $email ), esc_html( $display ) );
$return .= $after;
return $return;
} else {
@@ -176,14 +207,16 @@ function get_comment_author_email_link( $linktext = '', $before = '', $after = '
* which falls back to the global comment variable if the $comment_ID argument is empty.
*
* @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param int $comment_ID ID of the comment for which to get the author's link.
- * Default current comment.
+ * @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.
* @return string The comment author name or HTML link for author's URL.
*/
function get_comment_author_link( $comment_ID = 0 ) {
- $url = get_comment_author_url( $comment_ID );
- $author = get_comment_author( $comment_ID );
+ $comment = get_comment( $comment_ID );
+ $url = get_comment_author_url( $comment );
+ $author = get_comment_author( $comment );
if ( empty( $url ) || 'http://' == $url )
$return = $author;
@@ -191,25 +224,27 @@ function get_comment_author_link( $comment_ID = 0 ) {
$return = "$author";
/**
- * Filter the comment author's link for display.
+ * Filters the comment author's link for display.
*
* @since 1.5.0
+ * @since 4.1.0 The `$author` and `$comment_ID` parameters were added.
*
- * @param string $return The HTML-formatted comment author link.
- * Empty for an invalid URL.
+ * @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.
*/
- return apply_filters( 'get_comment_author_link', $return );
+ return apply_filters( 'get_comment_author_link', $return, $author, $comment->comment_ID );
}
/**
* Display the html link to the url of the author of the current comment.
*
* @since 0.71
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @see get_comment_author_link() Echoes result
- *
- * @param int $comment_ID ID of the comment for which to print the author's
- * link. Default current comment.
+ * @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.
*/
function comment_author_link( $comment_ID = 0 ) {
echo get_comment_author_link( $comment_ID );
@@ -219,77 +254,97 @@ function comment_author_link( $comment_ID = 0 ) {
* Retrieve the IP address of the author of the current comment.
*
* @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param int $comment_ID ID of the comment for which to get the author's IP
- * address. Default current comment.
+ * @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.
* @return string Comment author's IP address.
*/
function get_comment_author_IP( $comment_ID = 0 ) {
$comment = get_comment( $comment_ID );
/**
- * Filter the comment author's returned IP address.
+ * Filters the comment author's returned IP address.
*
* @since 1.5.0
+ * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
- * @param string $comment_author_IP The comment author's IP address.
+ * @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.
*/
- return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP );
+ return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP, $comment->comment_ID, $comment );
}
/**
* Display the IP address of the author of the current comment.
*
* @since 0.71
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param int $comment_ID ID of the comment for which to print the author's IP
- * address. Default current comment.
+ * @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.
*/
function comment_author_IP( $comment_ID = 0 ) {
- echo get_comment_author_IP( $comment_ID );
+ echo esc_html( get_comment_author_IP( $comment_ID ) );
}
/**
* Retrieve the url of the author of the current comment.
*
* @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param int $comment_ID ID of the comment for which to get the author's URL.
- * Default current comment.
- * @return string
+ * @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.
+ * @return string Comment author URL.
*/
function get_comment_author_url( $comment_ID = 0 ) {
$comment = get_comment( $comment_ID );
- $url = ('http://' == $comment->comment_author_url) ? '' : $comment->comment_author_url;
- $url = esc_url( $url, array('http', 'https') );
+ $url = '';
+ $id = 0;
+ if ( ! empty( $comment ) ) {
+ $author_url = ( 'http://' == $comment->comment_author_url ) ? '' : $comment->comment_author_url;
+ $url = esc_url( $author_url, array( 'http', 'https' ) );
+ $id = $comment->ID;
+ }
+
/**
- * Filter the comment author's URL.
+ * Filters the comment author's URL.
*
* @since 1.5.0
+ * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
- * @param string $url The comment author's URL.
+ * @param string $url The comment author's URL.
+ * @param int $comment_ID The comment ID.
+ * @param WP_Comment $comment The comment object.
*/
- return apply_filters( 'get_comment_author_url', $url );
+ return apply_filters( 'get_comment_author_url', $url, $id, $comment );
}
/**
* Display the url of the author of the current comment.
*
* @since 0.71
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param int $comment_ID ID of the comment for which to print the author's URL.
- * Default current comment.
+ * @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.
*/
function comment_author_url( $comment_ID = 0 ) {
- $author_url = get_comment_author_url( $comment_ID );
+ $comment = get_comment( $comment_ID );
+ $author_url = get_comment_author_url( $comment );
+
/**
- * Filter the comment author's URL for display.
+ * Filters the comment author's URL for display.
*
* @since 1.2.0
+ * @since 4.1.0 The `$comment_ID` parameter was added.
*
* @param string $author_url The comment author's URL.
+ * @param int $comment_ID The comment ID.
*/
- echo apply_filters( 'comment_url', $author_url );
+ echo apply_filters( 'comment_url', $author_url, $comment->comment_ID );
}
/**
@@ -303,26 +358,32 @@ function comment_author_url( $comment_ID = 0 ) {
* in the order of $before, link, and finally $after.
*
* @since 1.5.0
+ * @since 4.6.0 Added the `$comment` parameter.
*
- * @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.
+ * @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.
+ * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object.
+ * Default is the current comment.
* @return string The HTML link between the $before and $after parameters.
*/
-function get_comment_author_url_link( $linktext = '', $before = '', $after = '' ) {
- $url = get_comment_author_url();
+function get_comment_author_url_link( $linktext = '', $before = '', $after = '', $comment = 0 ) {
+ $url = get_comment_author_url( $comment );
$display = ($linktext != '') ? $linktext : $url;
$display = str_replace( 'http://www.', '', $display );
$display = str_replace( 'http://', '', $display );
- if ( '/' == substr($display, -1) )
+
+ if ( '/' == substr($display, -1) ) {
$display = substr($display, 0, -1);
+ }
+
$return = "$before$display$after";
/**
- * Filter the comment author's returned URL link.
+ * Filters the comment author's returned URL link.
*
* @since 1.5.0
*
@@ -335,33 +396,38 @@ function get_comment_author_url_link( $linktext = '', $before = '', $after = ''
* Displays the HTML link of the url of the author of the current comment.
*
* @since 0.71
+ * @since 4.6.0 Added the `$comment` parameter.
*
- * @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.
+ * @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.
+ * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object.
+ * Default is the current comment.
*/
-function comment_author_url_link( $linktext = '', $before = '', $after = '' ) {
- echo get_comment_author_url_link( $linktext, $before, $after );
+function comment_author_url_link( $linktext = '', $before = '', $after = '', $comment = 0 ) {
+ echo get_comment_author_url_link( $linktext, $before, $after, $comment );
}
/**
* Generates semantic classes for each comment element.
*
* @since 2.7.0
+ * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object.
*
- * @param string|array $class Optional. One or more classes to add to the class list.
+ * @param string|array $class Optional. One or more classes to add to the class list.
* Default empty.
- * @param int $comment_id Comment ID. 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.
+ * @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.
* Default true.
+ * @return string If `$echo` is false, the class will be returned. Void otherwise.
*/
-function comment_class( $class = '', $comment_id = null, $post_id = null, $echo = true ) {
+function comment_class( $class = '', $comment = null, $post_id = null, $echo = true ) {
// Separates classes with a single space, collates classes for comment DIV
- $class = 'class="' . join( ' ', get_comment_class( $class, $comment_id, $post_id ) ) . '"';
+ $class = 'class="' . join( ' ', get_comment_class( $class, $comment, $post_id ) ) . '"';
if ( $echo)
echo $class;
else
@@ -372,31 +438,39 @@ function comment_class( $class = '', $comment_id = null, $post_id = null, $echo
* Returns the classes for the comment div as an array.
*
* @since 2.7.0
+ * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object.
*
- * @param string|array $class Optional. One or more classes to add to the class list. Default empty.
- * @param int $comment_id Comment ID. Default current comment.
- * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
+ * @global int $comment_alt
+ * @global int $comment_depth
+ * @global int $comment_thread_alt
+ *
+ * @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.
* @return array An array of classes.
*/
function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {
global $comment_alt, $comment_depth, $comment_thread_alt;
- $comment = get_comment($comment_id);
-
$classes = array();
+ $comment = get_comment( $comment_id );
+ if ( ! $comment ) {
+ return $classes;
+ }
+
// Get the comment type (comment, trackback),
$classes[] = ( empty( $comment->comment_type ) ) ? 'comment' : $comment->comment_type;
- // If the comment author has an id (registered), then print the log in name
- if ( $comment->user_id > 0 && $user = get_userdata($comment->user_id) ) {
- // For all registered users, 'byuser'
+ // Add classes for comment authors that are registered users.
+ if ( $comment->user_id > 0 && $user = get_userdata( $comment->user_id ) ) {
$classes[] = 'byuser';
- $classes[] = 'comment-author-' . sanitize_html_class($user->user_nicename, $comment->user_id);
+ $classes[] = 'comment-author-' . sanitize_html_class( $user->user_nicename, $comment->user_id );
// For comment authors who are the author of the post
if ( $post = get_post($post_id) ) {
- if ( $comment->user_id === $post->post_author )
+ if ( $comment->user_id === $post->post_author ) {
$classes[] = 'bypostauthor';
+ }
}
}
@@ -438,25 +512,28 @@ function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {
$classes = array_map('esc_attr', $classes);
/**
- * Filter the returned CSS classes for the current comment.
+ * Filters 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.
+ * @param WP_Comment $comment The comment object.
* @param int|WP_Post $post_id The post ID or WP_Post object.
*/
- return apply_filters( 'comment_class', $classes, $class, $comment_id, $post_id );
+ return apply_filters( 'comment_class', $classes, $class, $comment->comment_ID, $comment, $post_id );
}
/**
* Retrieve the comment date of the current comment.
*
* @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param string $d Optional. The format of the date. Default user's setting.
- * @param int $comment_ID ID of the comment for which to get the date. Default current comment.
+ * @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.
* @return string The comment's date.
*/
function get_comment_date( $d = '', $comment_ID = 0 ) {
@@ -466,13 +543,13 @@ function get_comment_date( $d = '', $comment_ID = 0 ) {
else
$date = mysql2date($d, $comment->comment_date);
/**
- * Filter the returned comment date.
+ * Filters the returned comment date.
*
* @since 1.5.0
*
* @param string|int $date Formatted date string or Unix timestamp.
* @param string $d The format of the date.
- * @param object $comment The comment object.
+ * @param WP_Comment $comment The comment object.
*/
return apply_filters( 'get_comment_date', $date, $d, $comment );
}
@@ -481,9 +558,11 @@ function get_comment_date( $d = '', $comment_ID = 0 ) {
* Display the comment date of the current comment.
*
* @since 0.71
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param string $d Optional. The format of the date. Default user's settings.
- * @param int $comment_ID ID of the comment for which to print the date. Default current comment.
+ * @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.
*/
function comment_date( $d = '', $comment_ID = 0 ) {
echo get_comment_date( $d, $comment_ID );
@@ -497,56 +576,71 @@ function comment_date( $d = '', $comment_ID = 0 ) {
* will appear.
*
* @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param int $comment_ID ID of the comment for which to get the excerpt.
- * Default current comment.
+ * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to get the excerpt.
+ * Default current comment.
* @return string The maybe truncated comment with 20 words or less.
*/
function get_comment_excerpt( $comment_ID = 0 ) {
$comment = get_comment( $comment_ID );
- $comment_text = strip_tags($comment->comment_content);
- $blah = explode(' ', $comment_text);
- if (count($blah) > 20) {
- $k = 20;
- $use_dotdotdot = 1;
- } else {
- $k = count($blah);
- $use_dotdotdot = 0;
- }
- $excerpt = '';
- for ($i=0; $i<$k; $i++) {
- $excerpt .= $blah[$i] . ' ';
+ $comment_text = strip_tags( str_replace( array( "\n", "\r" ), ' ', $comment->comment_content ) );
+ $words = explode( ' ', $comment_text );
+
+ /**
+ * Filters 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 );
+
+ $use_ellipsis = count( $words ) > $comment_excerpt_length;
+ if ( $use_ellipsis ) {
+ $words = array_slice( $words, 0, $comment_excerpt_length );
}
- $excerpt .= ($use_dotdotdot) ? '…' : '';
+ $excerpt = trim( join( ' ', $words ) );
+ if ( $use_ellipsis ) {
+ $excerpt .= '…';
+ }
/**
- * Filter the retrieved comment excerpt.
+ * Filters the retrieved comment excerpt.
*
* @since 1.5.0
+ * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
- * @param string $excerpt The comment excerpt text.
+ * @param string $excerpt The comment excerpt text.
+ * @param int $comment_ID The comment ID.
+ * @param WP_Comment $comment The comment object.
*/
- return apply_filters( 'get_comment_excerpt', $excerpt );
+ return apply_filters( 'get_comment_excerpt', $excerpt, $comment->comment_ID, $comment );
}
/**
* Display the excerpt of the current comment.
*
* @since 1.2.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param int $comment_ID ID of the comment for which to print the excerpt.
- * Default current comment.
+ * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the excerpt.
+ * Default current comment.
*/
function comment_excerpt( $comment_ID = 0 ) {
- $comment_excerpt = get_comment_excerpt($comment_ID);
+ $comment = get_comment( $comment_ID );
+ $comment_excerpt = get_comment_excerpt( $comment );
+
/**
- * Filter the comment excerpt for display.
+ * Filters the comment excerpt for display.
*
* @since 1.2.0
+ * @since 4.1.0 The `$comment_ID` parameter was added.
*
* @param string $comment_excerpt The comment excerpt text.
+ * @param int $comment_ID The comment ID.
*/
- echo apply_filters( 'comment_excerpt', $comment_excerpt );
+ echo apply_filters( 'comment_excerpt', $comment_excerpt, $comment->comment_ID );
}
/**
@@ -557,15 +651,18 @@ function comment_excerpt( $comment_ID = 0 ) {
* @return int The comment ID.
*/
function get_comment_ID() {
- global $comment;
+ $comment = get_comment();
+
/**
- * Filter the returned comment ID.
+ * Filters the returned comment ID.
*
* @since 1.5.0
+ * @since 4.1.0 The `$comment_ID` parameter was added.
*
- * @param int $comment_ID The current comment ID.
+ * @param int $comment_ID The current comment ID.
+ * @param WP_Comment $comment The comment object.
*/
- return apply_filters( 'get_comment_ID', $comment->comment_ID );
+ return apply_filters( 'get_comment_ID', $comment->comment_ID, $comment );
}
/**
@@ -581,11 +678,25 @@ function comment_ID() {
* Retrieve the link to a given comment.
*
* @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object. Added `$cpage` argument.
*
* @see get_page_of_comment()
*
- * @param mixed $comment Comment to retrieve. Default current comment.
- * @param array $args Optional. An array of arguments to override the defaults.
+ * @global WP_Rewrite $wp_rewrite
+ * @global bool $in_comment_loop
+ *
+ * @param WP_Comment|int|null $comment Comment to retrieve. Default current comment.
+ * @param array $args {
+ * An array of optional arguments to override the defaults.
+ *
+ * @type string $type Passed to 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 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`.
+ * }
* @return string The permalink to the given comment.
*/
function get_comment_link( $comment = null, $args = array() ) {
@@ -593,51 +704,94 @@ function get_comment_link( $comment = null, $args = array() ) {
$comment = get_comment($comment);
- // Backwards compat
+ // Back-compat.
if ( ! is_array( $args ) ) {
$args = array( 'page' => $args );
}
- $defaults = array( 'type' => 'all', 'page' => '', 'per_page' => '', 'max_depth' => '' );
+ $defaults = array(
+ 'type' => 'all',
+ 'page' => '',
+ 'per_page' => '',
+ 'max_depth' => '',
+ 'cpage' => null,
+ );
$args = wp_parse_args( $args, $defaults );
- if ( '' === $args['per_page'] && get_option('page_comments') )
- $args['per_page'] = get_option('comments_per_page');
+ $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 {
+ if ( '' === $args['per_page'] && get_option( 'page_comments' ) ) {
+ $args['per_page'] = get_option('comments_per_page');
+ }
+
+ if ( empty( $args['per_page'] ) ) {
+ $args['per_page'] = 0;
+ $args['page'] = 0;
+ }
+
+ $cpage = $args['page'];
+
+ 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 ( empty($args['per_page']) ) {
- $args['per_page'] = 0;
- $args['page'] = 0;
+ /*
+ * If the default page displays the oldest comments, the permalinks for comments on the default page
+ * do not need a 'cpage' query var.
+ */
+ if ( 'oldest' === get_option( 'default_comments_page' ) && 1 === $cpage ) {
+ $cpage = '';
+ }
}
- if ( $args['per_page'] ) {
- if ( '' == $args['page'] )
- $args['page'] = ( !empty($in_comment_loop) ) ? get_query_var('cpage') : get_page_of_comment( $comment->comment_ID, $args );
+ if ( $cpage && get_option( 'page_comments' ) ) {
+ if ( $wp_rewrite->using_permalinks() ) {
+ if ( $cpage ) {
+ $link = trailingslashit( $link ) . $wp_rewrite->comments_pagination_base . '-' . $cpage;
+ }
+
+ $link = user_trailingslashit( $link, 'comment' );
+ } elseif ( $cpage ) {
+ $link = add_query_arg( 'cpage', $cpage, $link );
+ }
- if ( $wp_rewrite->using_permalinks() )
- $link = user_trailingslashit( trailingslashit( get_permalink( $comment->comment_post_ID ) ) . 'comment-page-' . $args['page'], 'comment' );
- else
- $link = add_query_arg( 'cpage', $args['page'], get_permalink( $comment->comment_post_ID ) );
- } else {
- $link = get_permalink( $comment->comment_post_ID );
+ }
+
+ if ( $wp_rewrite->using_permalinks() ) {
+ $link = user_trailingslashit( $link, 'comment' );
}
$link = $link . '#comment-' . $comment->comment_ID;
+
/**
- * Filter the returned single comment permalink.
+ * Filters the returned single comment permalink.
*
* @since 2.8.0
+ * @since 4.4.0 Added the `$cpage` parameter.
*
* @see get_page_of_comment()
*
- * @param string $link The comment permalink with '#comment-$id' appended.
- * @param object $comment The current comment object.
- * @param array $args An array of arguments to override the defaults.
+ * @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.
+ * @param int $cpage The calculated 'cpage' value.
*/
- return apply_filters( 'get_comment_link', $link, $comment, $args );
+ return apply_filters( 'get_comment_link', $link, $comment, $args, $cpage );
}
/**
- * Retrieve the link to the current post comments.
+ * Retrieves the link to the current post comments.
*
* @since 1.5.0
*
@@ -645,9 +799,11 @@ function get_comment_link( $comment = null, $args = array() ) {
* @return string The link to the comments.
*/
function get_comments_link( $post_id = 0 ) {
- $comments_link = get_permalink( $post_id ) . '#comments';
+ $hash = get_comments_number( $post_id ) ? '#comments' : '#respond';
+ $comments_link = get_permalink( $post_id ) . $hash;
+
/**
- * Filter the returned post comments permalink.
+ * Filters the returned post comments permalink.
*
* @since 3.6.0
*
@@ -663,13 +819,13 @@ function get_comments_link( $post_id = 0 ) {
* @since 0.71
*
* @param string $deprecated Not Used.
- * @param bool $deprecated_2 Not Used.
+ * @param string $deprecated_2 Not Used.
*/
function comments_link( $deprecated = '', $deprecated_2 = '' ) {
if ( !empty( $deprecated ) )
_deprecated_argument( __FUNCTION__, '0.72' );
if ( !empty( $deprecated_2 ) )
- _deprecated_argument( __FUNCTION__, '1.3' );
+ _deprecated_argument( __FUNCTION__, '1.3.0' );
echo esc_url( get_comments_link() );
}
@@ -692,7 +848,7 @@ function get_comments_number( $post_id = 0 ) {
}
/**
- * Filter the returned comment count for a post.
+ * Filters the returned comment count for a post.
*
* @since 1.5.0
*
@@ -714,7 +870,7 @@ function get_comments_number( $post_id = 0 ) {
*/
function comments_number( $zero = false, $one = false, $more = false, $deprecated = '' ) {
if ( ! empty( $deprecated ) ) {
- _deprecated_argument( __FUNCTION__, '1.3' );
+ _deprecated_argument( __FUNCTION__, '1.3.0' );
}
echo get_comments_number_text( $zero, $one, $more );
}
@@ -732,14 +888,41 @@ function get_comments_number_text( $zero = false, $one = false, $more = false )
$number = get_comments_number();
if ( $number > 1 ) {
- $output = str_replace( '%', number_format_i18n( $number ), ( false === $more ) ? __( '% Comments' ) : $more );
+ if ( false === $more ) {
+ /* translators: %s: number of comments */
+ $output = sprintf( _n( '%s Comment', '%s Comments', $number ), number_format_i18n( $number ) );
+ } else {
+ // % Comments
+ /* translators: If comment number in your language requires declension,
+ * translate this to 'on'. Do not translate into your own language.
+ */
+ if ( 'on' === _x( 'off', 'Comment number declension: on or off' ) ) {
+ $text = preg_replace( '#.+?#', '', $more );
+ $text = preg_replace( '/&.+?;/', '', $text ); // Kill entities
+ $text = trim( strip_tags( $text ), '% ' );
+
+ // Replace '% Comments' with a proper plural form
+ if ( $text && ! preg_match( '/[0-9]+/', $text ) && false !== strpos( $more, '%' ) ) {
+ /* translators: %s: number of comments */
+ $new_text = _n( '%s Comment', '%s Comments', $number );
+ $new_text = trim( sprintf( $new_text, '' ) );
+
+ $more = str_replace( $text, $new_text, $more );
+ if ( false === strpos( $more, '%' ) ) {
+ $more = '% ' . $more;
+ }
+ }
+ }
+
+ $output = str_replace( '%', number_format_i18n( $number ), $more );
+ }
} elseif ( $number == 0 ) {
$output = ( false === $zero ) ? __( 'No Comments' ) : $zero;
} else { // must be one
$output = ( false === $one ) ? __( '1 Comment' ) : $one;
}
/**
- * Filter the comments count for display.
+ * Filters the comments count for display.
*
* @since 1.5.0
*
@@ -756,26 +939,28 @@ function get_comments_number_text( $zero = false, $one = false, $more = false )
* Retrieve the text of the current comment.
*
* @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
* @see Walker_Comment::comment()
*
- * @param int $comment_ID ID of the comment for which to get the text. Default current comment.
- * @param array $args Optional. An array of arguments. Default empty.
+ * @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.
* @return string The comment content.
*/
function get_comment_text( $comment_ID = 0, $args = array() ) {
$comment = get_comment( $comment_ID );
/**
- * Filter the text of a comment.
+ * Filters the text of a comment.
*
* @since 1.5.0
*
* @see Walker_Comment::comment()
*
- * @param string $comment_content Text of the comment.
- * @param object $comment The comment object.
- * @param array $args An array of arguments.
+ * @param string $comment_content Text of the comment.
+ * @param WP_Comment $comment The comment object.
+ * @param array $args An array of arguments.
*/
return apply_filters( 'get_comment_text', $comment->comment_content, $comment, $args );
}
@@ -784,26 +969,28 @@ function get_comment_text( $comment_ID = 0, $args = array() ) {
* Display the text of the current comment.
*
* @since 0.71
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
* @see Walker_Comment::comment()
*
- * @param int $comment_ID ID of the comment for which to print the text. Default 0.
- * @param array $args Optional. An array of arguments. Default empty array. Default empty.
+ * @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.
*/
function comment_text( $comment_ID = 0, $args = array() ) {
$comment = get_comment( $comment_ID );
- $comment_text = get_comment_text( $comment_ID , $args );
+ $comment_text = get_comment_text( $comment, $args );
/**
- * Filter the text of a comment to be displayed.
+ * Filters the text of a comment to be displayed.
*
* @since 1.2.0
*
* @see Walker_Comment::comment()
*
- * @param string $comment_text Text of the current comment.
- * @param object $comment The comment object.
- * @param array $args An array of arguments.
+ * @param string $comment_text Text of the current comment.
+ * @param WP_Comment $comment The comment object.
+ * @param array $args An array of arguments.
*/
echo apply_filters( 'comment_text', $comment_text, $comment, $args );
}
@@ -820,7 +1007,8 @@ function comment_text( $comment_ID = 0, $args = array() ) {
* @return string The formatted time.
*/
function get_comment_time( $d = '', $gmt = false, $translate = true ) {
- global $comment;
+ $comment = get_comment();
+
$comment_date = $gmt ? $comment->comment_date_gmt : $comment->comment_date;
if ( '' == $d )
$date = mysql2date(get_option('time_format'), $comment_date, $translate);
@@ -828,7 +1016,7 @@ function get_comment_time( $d = '', $gmt = false, $translate = true ) {
$date = mysql2date($d, $comment_date, $translate);
/**
- * Filter the returned comment time.
+ * Filters the returned comment time.
*
* @since 1.5.0
*
@@ -836,7 +1024,7 @@ function get_comment_time( $d = '', $gmt = false, $translate = true ) {
* @param string $d Date format.
* @param bool $gmt Whether the GMT date is in use.
* @param bool $translate Whether the time is translated.
- * @param object $comment The comment object.
+ * @param WP_Comment $comment The comment object.
*/
return apply_filters( 'get_comment_time', $date, $d, $gmt, $translate, $comment );
}
@@ -856,8 +1044,10 @@ function comment_time( $d = '' ) {
* Retrieve the comment type of the current comment.
*
* @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param int $comment_ID ID of the comment for which to get the type. Default current comment.
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to get the type.
+ * Default current comment.
* @return string The comment type.
*/
function get_comment_type( $comment_ID = 0 ) {
@@ -866,13 +1056,16 @@ function get_comment_type( $comment_ID = 0 ) {
$comment->comment_type = 'comment';
/**
- * Filter the returned comment type.
+ * Filters the returned comment type.
*
* @since 1.5.0
+ * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
- * @param string $comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
+ * @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.
*/
- return apply_filters( 'get_comment_type', $comment->comment_type );
+ return apply_filters( 'get_comment_type', $comment->comment_type, $comment->comment_ID, $comment );
}
/**
@@ -919,7 +1112,7 @@ function get_trackback_url() {
$tb_url = get_option('siteurl') . '/wp-trackback.php?p=' . get_the_ID();
/**
- * Filter the returned trackback URL.
+ * Filters the returned trackback URL.
*
* @since 2.2.0
*
@@ -938,12 +1131,20 @@ function get_trackback_url() {
* for the result instead.
*/
function trackback_url( $deprecated_echo = true ) {
- if ( $deprecated_echo !== true )
- _deprecated_argument( __FUNCTION__, '2.5', __('Use get_trackback_url()
instead if you do not want the value echoed.') );
- if ( $deprecated_echo )
+ if ( true !== $deprecated_echo ) {
+ _deprecated_argument( __FUNCTION__, '2.5.0',
+ /* translators: %s: get_trackback_url() */
+ sprintf( __( 'Use %s instead if you do not want the value echoed.' ),
+ 'get_trackback_url()
'
+ )
+ );
+ }
+
+ if ( $deprecated_echo ) {
echo get_trackback_url();
- else
+ } else {
return get_trackback_url();
+ }
}
/**
@@ -957,7 +1158,7 @@ function trackback_url( $deprecated_echo = true ) {
*/
function trackback_rdf( $deprecated = '' ) {
if ( ! empty( $deprecated ) ) {
- _deprecated_argument( __FUNCTION__, '2.5' );
+ _deprecated_argument( __FUNCTION__, '2.5.0' );
}
if ( isset( $_SERVER['HTTP_USER_AGENT'] ) && false !== stripos( $_SERVER['HTTP_USER_AGENT'], 'W3C_Validator' ) ) {
@@ -993,7 +1194,7 @@ function comments_open( $post_id = null ) {
$open = ( 'open' == $_post->comment_status );
/**
- * Filter whether the current post is open for comments.
+ * Filters whether the current post is open for comments.
*
* @since 2.5.0
*
@@ -1018,7 +1219,7 @@ function pings_open( $post_id = null ) {
$open = ( 'open' == $_post->ping_status );
/**
- * Filter whether the current post is open for pings.
+ * Filters whether the current post is open for pings.
*
* @since 2.5.0
*
@@ -1059,24 +1260,33 @@ function wp_comment_form_unfiltered_html_nonce() {
* the post does not have comments.
*
* 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
+ * are passed through the {@see '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'
+ * The `$file` path is passed through a filter hook called {@see 'comments_template'},
* which includes the TEMPLATEPATH and $file combined. Tries the $filtered path
* first and if it fails it will require the default comment template from the
* default theme. If either does not exist, then the WordPress process will be
* halted. It is advised for that reason, that the default theme is not deleted.
*
- * @todo Document globals
- * @uses $withcomments Will not try to get the comments if the post has none.
+ * Will not try to get the comments if the post has none.
*
* @since 1.5.0
*
+ * @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
+ * @global bool $withcomments
+ *
* @param string $file Optional. The file to load. Default '/comments.php'.
* @param bool $separate_comments Optional. Whether to separate the comments by comment type.
* Default false.
- * @return null Returns null if no comments appear.
*/
function comments_template( $file = '/comments.php', $separate_comments = false ) {
global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_ID, $user_identity, $overridden_cpage;
@@ -1091,7 +1301,6 @@ function comments_template( $file = '/comments.php', $separate_comments = false
/*
* Comment author information fetched from the comment cookies.
- * Uuses wp_get_current_commenter().
*/
$commenter = wp_get_current_commenter();
@@ -1112,35 +1321,134 @@ function comments_template( $file = '/comments.php', $separate_comments = false
*/
$comment_author_url = esc_url($commenter['comment_author_url']);
- /** @todo Use API instead of SELECTs. */
- if ( $user_ID) {
- $comments = $wpdb->get_results($wpdb->prepare("SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND (comment_approved = '1' OR ( user_id = %d AND comment_approved = '0' ) ) ORDER BY comment_date_gmt", $post->ID, $user_ID));
- } else if ( empty($comment_author) ) {
- $comments = get_comments( array('post_id' => $post->ID, 'status' => 'approve', 'order' => 'ASC') );
+ $comment_args = array(
+ 'orderby' => 'comment_date_gmt',
+ 'order' => 'ASC',
+ 'status' => 'approve',
+ 'post_id' => $post->ID,
+ 'no_found_rows' => false,
+ 'update_comment_meta_cache' => false, // We lazy-load comment meta for performance.
+ );
+
+ if ( get_option('thread_comments') ) {
+ $comment_args['hierarchical'] = 'threaded';
+ } else {
+ $comment_args['hierarchical'] = false;
+ }
+
+ if ( $user_ID ) {
+ $comment_args['include_unapproved'] = array( $user_ID );
+ } elseif ( ! empty( $comment_author_email ) ) {
+ $comment_args['include_unapproved'] = array( $comment_author_email );
+ }
+
+ $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' );
+ }
+
+ $comment_args['number'] = $per_page;
+ $page = (int) get_query_var( 'cpage' );
+
+ 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();
+ $top_level_args = array(
+ 'count' => true,
+ 'orderby' => false,
+ 'post_id' => $post->ID,
+ 'status' => 'approve',
+ );
+
+ if ( $comment_args['hierarchical'] ) {
+ $top_level_args['parent'] = 0;
+ }
+
+ 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 );
+
+ $comment_args['offset'] = ( ceil( $top_level_count / $per_page ) - 1 ) * $per_page;
+ }
+ }
+
+ /**
+ * Filters the arguments used to query comments in comments_template().
+ *
+ * @since 4.5.0
+ *
+ * @see WP_Comment_Query::__construct()
+ *
+ * @param array $comment_args {
+ * Array of WP_Comment_Query arguments.
+ *
+ * @type string|array $orderby Field(s) to order by.
+ * @type string $order Order of results. Accepts 'ASC' or 'DESC'.
+ * @type string $status Comment status.
+ * @type array $include_unapproved Array of IDs or email addresses whose unapproved comments
+ * will be included in results.
+ * @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 );
+ $comment_query = new WP_Comment_Query( $comment_args );
+ $_comments = $comment_query->comments;
+
+ // Trees must be flattened before they're passed to the walker.
+ 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;
+ }
+ }
} else {
- $comments = $wpdb->get_results($wpdb->prepare("SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND ( comment_approved = '1' OR ( comment_author = %s AND comment_author_email = %s AND comment_approved = '0' ) ) ORDER BY comment_date_gmt", $post->ID, wp_specialchars_decode($comment_author,ENT_QUOTES), $comment_author_email));
+ $comments_flat = $_comments;
}
/**
- * Filter the comments array.
+ * Filters the comments array.
*
* @since 2.1.0
*
* @param array $comments Array of comments supplied to the comments template.
* @param int $post_ID Post ID.
*/
- $wp_query->comments = apply_filters( 'comments_array', $comments, $post->ID );
+ $wp_query->comments = apply_filters( 'comments_array', $comments_flat, $post->ID );
+
$comments = &$wp_query->comments;
$wp_query->comment_count = count($wp_query->comments);
- update_comment_cache($wp_query->comments);
+ $wp_query->max_num_comment_pages = $comment_query->max_num_pages;
if ( $separate_comments ) {
$wp_query->comments_by_type = separate_comments($comments);
$comments_by_type = &$wp_query->comments_by_type;
+ } else {
+ $wp_query->comments_by_type = array();
}
$overridden_cpage = false;
- if ( '' == get_query_var('cpage') && get_option('page_comments') ) {
+ if ( '' == get_query_var( 'cpage' ) && $wp_query->max_num_comment_pages > 1 ) {
set_query_var( 'cpage', 'newest' == get_option('default_comments_page') ? get_comment_pages_count() : 1 );
$overridden_cpage = true;
}
@@ -1150,7 +1458,7 @@ function comments_template( $file = '/comments.php', $separate_comments = false
$theme_template = STYLESHEETPATH . $file;
/**
- * Filter the path to the theme template file used for the comments template.
+ * Filters the path to the theme template file used for the comments template.
*
* @since 1.5.1
*
@@ -1166,45 +1474,7 @@ function comments_template( $file = '/comments.php', $separate_comments = false
}
/**
- * Display the JS popup script to show a comment.
- *
- * If the $file parameter is empty, then the home page is assumed. The defaults
- * for the window are 400px by 400px.
- *
- * For the comment link popup to work, this function has to be called or the
- * normal comment link will be assumed.
- *
- * @global string $wpcommentspopupfile The URL to use for the popup window.
- * @global int $wpcommentsjavascript Whether to use JavaScript. Set when function is called.
- *
- * @since 0.71
- *
- * @param int $width Optional. The width of the popup window. Default 400.
- * @param int $height Optional. The height of the popup window. Default 400.
- * @param string $file Optional. Sets the location of the popup window.
- */
-function comments_popup_script( $width = 400, $height = 400, $file = '' ) {
- global $wpcommentspopupfile, $wpcommentsjavascript;
-
- if (empty ($file)) {
- $wpcommentspopupfile = ''; // Use the index.
- } else {
- $wpcommentspopupfile = $file;
- }
-
- $wpcommentsjavascript = 1;
- $javascript = "\n";
- echo $javascript;
-}
-
-/**
- * Displays the link to the comments popup window for the current post ID.
- *
- * Is not meant to be displayed on single posts and pages. Should be used
- * on the lists of posts
- *
- * @global string $wpcommentspopupfile The URL to use for the popup window.
- * @global int $wpcommentsjavascript Whether to use JavaScript. Set when function is called.
+ * Displays the link to the comments for the current post ID.
*
* @since 0.71
*
@@ -1216,19 +1486,32 @@ function comments_popup_script( $width = 400, $height = 400, $file = '' ) {
* @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.
- * @return null Returns null on single posts and pages.
*/
function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) {
- global $wpcommentspopupfile, $wpcommentsjavascript;
-
$id = get_the_ID();
+ $title = get_the_title();
+ $number = get_comments_number( $id );
- if ( false === $zero ) $zero = __( 'No Comments' );
- if ( false === $one ) $one = __( '1 Comment' );
- if ( false === $more ) $more = __( '% Comments' );
- if ( false === $none ) $none = __( 'Comments Off' );
+ if ( false === $zero ) {
+ /* translators: %s: post title */
+ $zero = sprintf( __( 'No Comments on %s' ), $title );
+ }
- $number = get_comments_number( $id );
+ if ( false === $one ) {
+ /* translators: %s: post title */
+ $one = sprintf( __( '1 Comment on %s' ), $title );
+ }
+
+ if ( false === $more ) {
+ /* translators: 1: Number of comments 2: post title */
+ $more = _n( '%1$s Comment on %2$s', '%1$s Comments on %2$s', $number );
+ $more = sprintf( $more, number_format_i18n( $number ), $title );
+ }
+
+ if ( false === $none ) {
+ /* translators: %s: post title */
+ $none = sprintf( __( 'Comments Off on %s' ), $title );
+ }
if ( 0 == $number && !comments_open() && !pings_open() ) {
echo '' . $none . '';
@@ -1236,42 +1519,42 @@ function comments_popup_link( $zero = false, $one = false, $more = false, $css_c
}
if ( post_password_required() ) {
- echo __('Enter your password to view comments.');
+ _e( 'Enter your password to view comments.' );
return;
}
echo ' 0 ) );
$attributes = '';
/**
- * Filter the comments popup link attributes for display.
+ * Filters the comments link attributes for display.
*
* @since 2.5.0
*
- * @param string $attributes The comments popup link attributes. Default empty.
+ * @param string $attributes The comments link attributes. Default empty.
*/
echo apply_filters( 'comments_popup_link_attributes', $attributes );
- echo ' title="' . esc_attr( sprintf( __('Comment on %s'), $title ) ) . '">';
+ echo '>';
comments_number( $zero, $one, $more );
echo '';
}
@@ -1280,6 +1563,7 @@ function comments_popup_link( $zero = false, $one = false, $more = false, $css_c
* Retrieve HTML content for reply to comment link.
*
* @since 2.7.0
+ * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object.
*
* @param array $args {
* Optional. Override default arguments.
@@ -1297,21 +1581,21 @@ function comments_popup_link( $zero = false, $one = false, $more = false, $css_c
* @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.
* }
- * @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.
- * @return mixed Link to show comment form, if successful. False, if comments are closed.
+ * @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.
+ * @return void|false|string Link to show comment form, if successful. False, if comments are closed.
*/
function get_comment_reply_link( $args = array(), $comment = null, $post = null ) {
-
$defaults = array(
- 'add_below' => 'comment',
- 'respond_id' => 'respond',
- 'reply_text' => __('Reply'),
- 'login_text' => __('Log in to Reply'),
- 'depth' => 0,
- 'before' => '',
- 'after' => ''
+ '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' => ''
);
$args = wp_parse_args( $args, $defaults );
@@ -1320,27 +1604,50 @@ function get_comment_reply_link( $args = array(), $comment = null, $post = null
return;
}
- $add_below = $args['add_below'];
- $respond_id = $args['respond_id'];
- $reply_text = $args['reply_text'];
-
$comment = get_comment( $comment );
+
if ( empty( $post ) ) {
$post = $comment->comment_post_ID;
}
+
$post = get_post( $post );
if ( ! comments_open( $post->ID ) ) {
return false;
}
+ /**
+ * Filters the comment reply link arguments.
+ *
+ * @since 4.1.0
+ *
+ * @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.
+ */
+ $args = apply_filters( 'comment_reply_link_args', $args, $comment, $post );
+
if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) {
- $link = ' ';
+ $link = sprintf( ' ',
+ esc_url( wp_login_url( get_permalink() ) ),
+ $args['login_text']
+ );
} else {
- $link = " ";
+ $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
+ );
+
+ $link = sprintf( " ",
+ esc_url( add_query_arg( 'replytocom', $comment->comment_ID, get_permalink( $post->ID ) ) ) . "#" . $args['respond_id'],
+ $onclick,
+ esc_attr( sprintf( $args['reply_to_text'], $comment->comment_author ) ),
+ $args['reply_text']
+ );
}
+
/**
- * Filter the comment reply link.
+ * Filters the comment reply link.
*
* @since 2.7.0
*
@@ -1390,7 +1697,7 @@ function comment_reply_link($args = array(), $comment = null, $post = null) {
* }
* @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on.
* Default current post.
- * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
+ * @return false|null|string Link to show comment form, if successful. False, if comments are closed.
*/
function get_post_reply_link($args = array(), $post = null) {
$defaults = array(
@@ -1403,9 +1710,7 @@ function get_post_reply_link($args = array(), $post = null) {
);
$args = wp_parse_args($args, $defaults);
- $add_below = $args['add_below'];
- $respond_id = $args['respond_id'];
- $reply_text = $args['reply_text'];
+
$post = get_post($post);
if ( ! comments_open( $post->ID ) ) {
@@ -1413,13 +1718,25 @@ function get_post_reply_link($args = array(), $post = null) {
}
if ( get_option('comment_registration') && ! is_user_logged_in() ) {
- $link = '' . $args['login_text'] . '';
+ $link = sprintf( ' ',
+ wp_login_url( get_permalink() ),
+ $args['login_text']
+ );
} else {
- $link = " ";
+ $onclick = sprintf( 'return addComment.moveForm( "%1$s-%2$s", "0", "%3$s", "%2$s" )',
+ $args['add_below'], $post->ID, $args['respond_id']
+ );
+
+ $link = sprintf( " ",
+ get_permalink( $post->ID ) . '#' . $args['respond_id'],
+ $onclick,
+ $args['reply_text']
+ );
}
$formatted_link = $args['before'] . $link . $args['after'];
+
/**
- * Filter the formatted post comments link HTML.
+ * Filters the formatted post comments link HTML.
*
* @since 2.7.0
*
@@ -1451,6 +1768,7 @@ function post_reply_link($args = array(), $post = null) {
* @since 2.7.0
*
* @param string $text Optional. Text to display for cancel reply link. Default empty.
+ * @return string
*/
function get_cancel_comment_reply_link( $text = '' ) {
if ( empty($text) )
@@ -1460,8 +1778,9 @@ function get_cancel_comment_reply_link( $text = '' ) {
$link = esc_html( remove_query_arg('replytocom') ) . '#respond';
$formatted_link = '' . $text . '';
+
/**
- * Filter the cancel comment reply link HTML.
+ * Filters the cancel comment reply link HTML.
*
* @since 2.7.0
*
@@ -1500,7 +1819,7 @@ function get_comment_id_fields( $id = 0 ) {
$result .= "\n";
/**
- * Filter the returned comment id fields.
+ * Filters the returned comment id fields.
*
* @since 3.0.0
*
@@ -1525,10 +1844,15 @@ function comment_id_fields( $id = 0 ) {
/**
* Display text based on comment reply status.
*
- * Only affects users with Javascript disabled.
+ * Only affects users with JavaScript disabled.
+ *
+ * @internal The $comment global must be present to allow template tags access to the current
+ * comment. See https://core.trac.wordpress.org/changeset/36512.
*
* @since 2.7.0
*
+ * @global WP_Comment $comment Current comment.
+ *
* @param string $noreplytext Optional. Text to display when not replying to a comment.
* Default false.
* @param string $replytext Optional. Text to display when replying to a comment.
@@ -1548,335 +1872,13 @@ function comment_form_title( $noreplytext = false, $replytext = false, $linktopa
if ( 0 == $replytoid )
echo $noreplytext;
else {
+ // Sets the global so that template tags can be used in the comment form.
$comment = get_comment($replytoid);
- $author = ( $linktoparent ) ? '' . get_comment_author() . '' : get_comment_author();
+ $author = ( $linktoparent ) ? '' . get_comment_author( $comment ) . '' : get_comment_author( $comment );
printf( $replytext, $author );
}
}
-/**
- * HTML comment list class.
- *
- * @uses Walker
- * @since 2.7.0
- */
-class Walker_Comment extends Walker {
- /**
- * What the class handles.
- *
- * @see Walker::$tree_type
- *
- * @since 2.7.0
- * @var string
- */
- public $tree_type = 'comment';
-
- /**
- * DB fields to use.
- *
- * @see Walker::$db_fields
- *
- * @since 2.7.0
- * @var array
- */
- public $db_fields = array ('parent' => 'comment_parent', 'id' => 'comment_ID');
-
- /**
- * Start the list before the elements are added.
- *
- * @see Walker::start_lvl()
- *
- * @since 2.7.0
- *
- * @param string $output Passed by reference. Used to append additional content.
- * @param int $depth Depth of comment.
- * @param array $args Uses 'style' argument for type of HTML list.
- */
- public function start_lvl( &$output, $depth = 0, $args = array() ) {
- $GLOBALS['comment_depth'] = $depth + 1;
-
- switch ( $args['style'] ) {
- case 'div':
- break;
- case 'ol':
- $output .= '
%1$s %2$s', where %1$s is the + * submit button markup and %2$s is the comment hidden fields. * @type string $format The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'. * } * @param int|WP_Post $post_id Post ID or WP_Post object to generate the form for. Default current post. @@ -2078,20 +2175,21 @@ function comment_form( $args = array(), $post_id = null ) { $req = get_option( 'require_name_email' ); $aria_req = ( $req ? " aria-required='true'" : '' ); + $html_req = ( $req ? " required='required'" : '' ); $html5 = 'html5' === $args['format']; $fields = array( 'author' => '
', + '', 'email' => '' . - '
', + '', 'url' => '' . - '
', + '', ); $required_text = sprintf( ' ' . __('Required fields are marked %s'), '*' ); /** - * Filter the default comment form fields. + * Filters the default comment form fields. * * @since 3.0.0 * @@ -2100,27 +2198,48 @@ function comment_form( $args = array(), $post_id = null ) { $fields = apply_filters( 'comment_form_default_fields', $fields ); $defaults = array( 'fields' => $fields, - 'comment_field' => '', + 'comment_field' => '
', /** This filter is documented in wp-includes/link-template.php */ - 'must_log_in' => '
' . sprintf( __( 'You must be logged in to post a comment.' ), wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '
', + 'must_log_in' => '' . sprintf( + /* translators: %s: login URL */ + __( 'You must be logged in to post a comment.' ), + wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) + ) . '
', /** This filter is documented in wp-includes/link-template.php */ - 'logged_in_as' => '' . sprintf( __( 'Logged in as %2$s. Log out?' ), get_edit_user_link(), $user_identity, wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '
', - 'comment_notes_before' => '' . __( 'Your email address will not be published.' ) . ( $req ? $required_text : '' ) . '
', - 'comment_notes_after' => ' ', + 'logged_in_as' => '' . sprintf( + /* translators: 1: edit user link, 2: accessibility text, 3: user name, 4: logout URL */ + __( 'Logged in as %3$s. Log out?' ), + get_edit_user_link(), + /* translators: %s: user name */ + esc_attr( sprintf( __( 'Logged in as %s. Edit your profile.' ), $user_identity ) ), + $user_identity, + wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) + ) . '
', + 'comment_notes_before' => '' . __( 'Your email address will not be published.' ) . ''. ( $req ? $required_text : '' ) . '
', + 'comment_notes_after' => '', + 'action' => site_url( '/wp-comments-post.php' ), 'id_form' => 'commentform', 'id_submit' => 'submit', + 'class_form' => 'comment-form', + 'class_submit' => 'submit', 'name_submit' => 'submit', 'title_reply' => __( 'Leave a Reply' ), 'title_reply_to' => __( 'Leave a Reply to %s' ), + 'title_reply_before' => '%1$s %2$s
', 'format' => 'xhtml', ); /** - * Filter the comment form default arguments. + * Filters the comment form default arguments. * - * Use 'comment_form_default_fields' to filter the comment fields. + * Use {@see 'comment_form_default_fields'} to filter the comment fields. * * @since 3.0.0 * @@ -2128,137 +2247,212 @@ function comment_form( $args = array(), $post_id = null ) { */ $args = wp_parse_args( $args, apply_filters( 'comment_form_defaults', $defaults ) ); - ?> - + // Ensure that the filtered args contain all required default values. + $args = array_merge( $defaults, $args ); + + if ( comments_open( $post_id ) ) : ?> + +