X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/53f4633144ed68c8b8fb5861f992b5489894a940..refs/tags/wordpress-4.4.2:/wp-includes/comment-template.php?ds=sidebyside
diff --git a/wp-includes/comment-template.php b/wp-includes/comment-template.php
index 78635778..ad5b9caf 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 ) {
@@ -37,22 +39,25 @@ function get_comment_author( $comment_ID = 0 ) {
* @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 int $comment_ID The comment ID.
- * @param object $comment The comment object.
+ * @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, $comment_ID, $comment );
+ 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.
@@ -63,15 +68,17 @@ function comment_author( $comment_ID = 0 ) {
* @param string $author The comment author's username.
* @param int $comment_ID The comment ID.
*/
- echo apply_filters( 'comment_author', $author, $comment_ID );
+ 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 ) {
@@ -83,11 +90,11 @@ function get_comment_author_email( $comment_ID = 0 ) {
* @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 int $comment_ID The comment ID.
- * @param object $comment The comment object.
+ * @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, $comment_ID, $comment );
+ return apply_filters( 'get_comment_author_email', $comment->comment_author_email, $comment->comment_ID, $comment );
}
/**
@@ -100,11 +107,14 @@ function get_comment_author_email( $comment_ID = 0 ) {
* 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.
@@ -115,7 +125,7 @@ function comment_author_email( $comment_ID = 0 ) {
* @param string $author_email The comment author's email address.
* @param int $comment_ID The comment ID.
*/
- echo apply_filters( 'author_email', $author_email, $comment_ID );
+ echo apply_filters( 'author_email', $author_email, $comment->comment_ID );
}
/**
@@ -148,8 +158,6 @@ function comment_author_email_link( $linktext = '', $before = '', $after = '' )
* 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
*
* @param string $linktext Optional. Text to display instead of the comment author's email address.
@@ -159,8 +167,7 @@ function comment_author_email_link( $linktext = '', $before = '', $after = '' )
* @return string
*/
function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
- global $comment;
-
+ $comment = get_comment();
/**
* Filter the comment author's email for display.
*
@@ -170,14 +177,14 @@ function get_comment_author_email_link( $linktext = '', $before = '', $after = '
* @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 object $comment The comment object.
+ * @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, $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 {
@@ -192,14 +199,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;
@@ -217,16 +226,17 @@ function get_comment_author_link( $comment_ID = 0 ) {
* @param string $author The comment author's username.
* @param int $comment_ID The comment ID.
*/
- return apply_filters( 'get_comment_author_link', $return, $author, $comment_ID );
+ 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.
*
- * @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 );
@@ -236,9 +246,10 @@ 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 ) {
@@ -250,33 +261,35 @@ function get_comment_author_IP( $comment_ID = 0 ) {
* @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 int $comment_ID The comment ID.
- * @param object $comment The comment object.
+ * @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, $comment_ID, $comment );
+ 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 );
@@ -289,23 +302,25 @@ function get_comment_author_url( $comment_ID = 0 ) {
* @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 int $comment_ID The comment ID.
- * @param object $comment The comment object.
+ * @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, $comment_ID, $comment );
+ return apply_filters( 'get_comment_author_url', $url, $comment->comment_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.
@@ -316,7 +331,7 @@ function comment_author_url( $comment_ID = 0 ) {
* @param string $author_url The comment author's URL.
* @param int $comment_ID The comment ID.
*/
- echo apply_filters( 'comment_url', $author_url, $comment_ID );
+ echo apply_filters( 'comment_url', $author_url, $comment->comment_ID );
}
/**
@@ -381,18 +396,19 @@ function comment_author_url_link( $linktext = '', $before = '', $after = '' ) {
* 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|void
+ * @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
@@ -403,23 +419,27 @@ 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.
*
* @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 $comment_id Comment ID. Default current comment.
- * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
+ * @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;
@@ -480,19 +500,21 @@ function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {
* @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 object $comment The comment
+ * @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, $comment, $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 ) {
@@ -508,7 +530,7 @@ function get_comment_date( $d = '', $comment_ID = 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 );
}
@@ -517,9 +539,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 );
@@ -533,53 +557,60 @@ 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);
+ $comment_text = strip_tags( str_replace( array( "\n", "\r" ), ' ', $comment->comment_content ) );
+ $words = explode( ' ', $comment_text );
- if (count($blah) > 20) {
- $k = 20;
- $use_dotdotdot = 1;
- } else {
- $k = count($blah);
- $use_dotdotdot = 0;
- }
+ /**
+ * 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 );
- $excerpt = '';
- for ($i=0; $i<$k; $i++) {
- $excerpt .= $blah[$i] . ' ';
+ $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.
*
* @since 1.5.0
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
- * @param string $excerpt The comment excerpt text.
- * @param int $comment_ID The comment ID.
- * @param object $comment The comment object.
+ * @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, $comment_ID, $comment );
+ 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.
@@ -590,7 +621,7 @@ function comment_excerpt( $comment_ID = 0 ) {
* @param string $comment_excerpt The comment excerpt text.
* @param int $comment_ID The comment ID.
*/
- echo apply_filters( 'comment_excerpt', $comment_excerpt, $comment_ID );
+ echo apply_filters( 'comment_excerpt', $comment_excerpt, $comment->comment_ID );
}
/**
@@ -598,12 +629,10 @@ function comment_excerpt( $comment_ID = 0 ) {
*
* @since 1.5.0
*
- * @global object $comment
- *
* @return int The comment ID.
*/
function get_comment_ID() {
- global $comment;
+ $comment = get_comment();
/**
* Filter the returned comment ID.
@@ -611,8 +640,8 @@ function get_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 object $comment The comment object.
+ * @param int $comment_ID The current comment ID.
+ * @param WP_Comment $comment The comment object.
*/
return apply_filters( 'get_comment_ID', $comment->comment_ID, $comment );
}
@@ -630,14 +659,24 @@ 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()
*
* @global WP_Rewrite $wp_rewrite
* @global bool $in_comment_loop
*
- * @param mixed $comment Comment to retrieve. Default current comment.
- * @param array $args Optional. An array of arguments to override the defaults.
+ * @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 {@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`.
+ * }
* @return string The permalink to the given comment.
*/
function get_comment_link( $comment = null, $args = array() ) {
@@ -650,46 +689,90 @@ function get_comment_link( $comment = null, $args = array() ) {
$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 ( empty($args['per_page']) ) {
- $args['per_page'] = 0;
- $args['page'] = 0;
+ 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 = '';
+ }
}
- 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 ) ) . $wp_rewrite->comments_pagination_base . '-' . $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.
*
* @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
*
@@ -697,7 +780,9 @@ 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.
*
@@ -784,7 +869,13 @@ 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
+ $output = str_replace( '%', number_format_i18n( $number ), $more );
+ }
} elseif ( $number == 0 ) {
$output = ( false === $zero ) ? __( 'No Comments' ) : $zero;
} else { // must be one
@@ -808,11 +899,13 @@ 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() ) {
@@ -825,9 +918,9 @@ function get_comment_text( $comment_ID = 0, $args = array() ) {
*
* @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 );
}
@@ -836,16 +929,18 @@ 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.
*
@@ -853,9 +948,9 @@ function comment_text( $comment_ID = 0, $args = array() ) {
*
* @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 );
}
@@ -865,8 +960,6 @@ function comment_text( $comment_ID = 0, $args = array() ) {
*
* @since 1.5.0
*
- * @global object $comment
- *
* @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.
* @param bool $translate Optional. Whether to translate the time (for use in feeds).
@@ -874,7 +967,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);
@@ -890,7 +984,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 );
}
@@ -910,8 +1004,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 ) {
@@ -925,11 +1021,11 @@ function get_comment_type( $comment_ID = 0 ) {
* @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 int $comment_ID The comment ID.
- * @param object $comment The comment object.
+ * @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, $comment_ID, $comment );
+ return apply_filters( 'get_comment_type', $comment->comment_type, $comment->comment_ID, $comment );
}
/**
@@ -995,12 +1091,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',
+ /* 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();
+ }
}
/**
@@ -1129,15 +1233,15 @@ function wp_comment_form_unfiltered_html_nonce() {
*
* @since 1.5.0
*
- * @global WP_Query $wp_query
- * @global WP_Post $post
- * @global wpdb $wpdb
- * @global int $id
- * @global object $comment
- * @global string $user_login
- * @global int $user_ID
- * @global string $user_identity
- * @global bool $overridden_cpage
+ * @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
*
* @param string $file Optional. The file to load. Default '/comments.php'.
* @param bool $separate_comments Optional. Whether to separate the comments by comment type.
@@ -1177,19 +1281,85 @@ function comments_template( $file = '/comments.php', $separate_comments = false
$comment_author_url = esc_url($commenter['comment_author_url']);
$comment_args = array(
- 'order' => 'ASC',
'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 );
}
- $comments = get_comments( $comment_args );
+ $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;
+ }
+ }
+
+ $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_flat = $_comments;
+ }
/**
* Filter the comments array.
@@ -1199,17 +1369,24 @@ function comments_template( $file = '/comments.php', $separate_comments = false
* @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 );
+
+ // Set up lazy-loading for comment metadata.
+ add_action( 'get_comment_metadata', array( $wp_query, 'lazyload_comment_meta' ), 10, 2 );
+
$comments = &$wp_query->comments;
$wp_query->comment_count = count($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;
}
@@ -1332,11 +1509,22 @@ function comments_popup_link( $zero = false, $one = false, $more = false, $css_c
$home = get_option('siteurl');
echo $home . '/' . $wpcommentspopupfile . '?comments_popup=' . $id;
echo '" onclick="wpopen(this.href); return false"';
- } else { // if comments_popup_script() is not in the template, display simple comment link
- if ( 0 == $number )
- echo get_permalink() . '#respond';
- else
+ } else {
+ // if comments_popup_script() is not in the template, display simple comment link
+ 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 );
+ } else {
comments_link();
+ }
echo '"';
}
@@ -1363,6 +1551,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.
@@ -1380,9 +1569,9 @@ 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.
+ * @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 ) {
@@ -1420,10 +1609,10 @@ function get_comment_reply_link( $args = array(), $comment = null, $post = null
*
* @since 4.1.0
*
- * @param array $args Comment reply link arguments. See {@see get_comment_reply_link()}
- * for more information on accepted arguments.
- * @param object $comment The object of the comment being replied to.
- * @param WP_Post $post The {@see WP_Post} object.
+ * @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 );
@@ -1444,6 +1633,7 @@ function get_comment_reply_link( $args = array(), $comment = null, $post = null
$args['reply_text']
);
}
+
/**
* Filter the comment reply link.
*
@@ -1532,6 +1722,7 @@ function get_post_reply_link($args = array(), $post = null) {
);
}
$formatted_link = $args['before'] . $link . $args['after'];
+
/**
* Filter the formatted post comments link HTML.
*
@@ -1575,6 +1766,7 @@ 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.
*
@@ -1644,8 +1836,6 @@ function comment_id_fields( $id = 0 ) {
*
* @since 2.7.0
*
- * @global object $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.
@@ -1655,7 +1845,7 @@ function comment_id_fields( $id = 0 ) {
* to their comment. Default true.
*/
function comment_form_title( $noreplytext = false, $replytext = false, $linktoparent = true ) {
- global $comment;
+ $comment = get_comment();
if ( false === $noreplytext ) $noreplytext = __( 'Leave a Reply' );
if ( false === $replytext ) $replytext = __( 'Leave a Reply to %s' );
@@ -1666,352 +1856,11 @@ function comment_form_title( $noreplytext = false, $replytext = false, $linktopa
echo $noreplytext;
else {
$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
- *
- * @global int $comment_depth
- *
- * @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 .= '
' . sprintf( __( '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 ) ) ) ) . '
', + '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' => '', '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' => '