X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/8f374b7233bc2815ccc387e448d208c5434eb961..refs/tags/wordpress-4.4:/wp-includes/comment-template.php diff --git a/wp-includes/comment-template.php b/wp-includes/comment-template.php index 5bacda18..ada53c89 100644 --- a/wp-includes/comment-template.php +++ b/wp-includes/comment-template.php @@ -15,52 +15,86 @@ * assumed. * * @since 1.5.0 - * @uses apply_filters() Calls 'get_comment_author' hook on the comment author + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to retrieve the author. Optional. + * @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 ) { $comment = get_comment( $comment_ID ); - if ( empty($comment->comment_author) ) { - if (!empty($comment->user_id)){ - $user=get_userdata($comment->user_id); - $author=$user->user_login; - } else { + + if ( empty( $comment->comment_author ) ) { + if ( $comment->user_id && $user = get_userdata( $comment->user_id ) ) + $author = $user->display_name; + else $author = __('Anonymous'); - } } else { $author = $comment->comment_author; } - return apply_filters('get_comment_author', $author); + + /** + * Filter 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 int $comment_ID The comment ID. + * @param WP_Comment $comment The comment object. + */ + return apply_filters( 'get_comment_author', $author, $comment->comment_ID, $comment ); } /** * Displays the author of the current comment. * * @since 0.71 - * @uses apply_filters() Calls 'comment_author' on comment author before displaying + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to print the author. Optional. + * @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 = apply_filters('comment_author', get_comment_author( $comment_ID ) ); - echo $author; + $comment = get_comment( $comment_ID ); + $author = get_comment_author( $comment ); + + /** + * Filter 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 int $comment_ID The 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 - * @uses apply_filters() Calls the 'get_comment_author_email' hook on the comment author email - * @uses $comment + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to get the author's email. Optional. + * @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 ); - return apply_filters('get_comment_author_email', $comment->comment_author_email); + + /** + * Filter 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 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->comment_ID, $comment ); } /** @@ -73,12 +107,25 @@ function get_comment_author_email( $comment_ID = 0 ) { * address and use it for their own means good and bad. * * @since 0.71 - * @uses apply_filters() Calls 'author_email' hook on the author email + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to print the author's email. Optional. + * @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 ) { - echo apply_filters('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. + * + * @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, $comment->comment_ID ); } /** @@ -91,15 +138,13 @@ function comment_author_email( $comment_ID = 0 ) { * address and use it for their own means good and bad. * * @since 0.71 - * @uses apply_filters() Calls 'comment_email' hook for the display of the comment author's email - * @uses get_comment_author_email_link() For generating the link - * @global object $comment The current Comment row object * - * @param string $linktext The text to display instead of the comment author's email address - * @param string $before The text or HTML to display before the email link. - * @param string $after The text or HTML to display after the email link. + * @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. */ -function comment_author_email_link($linktext='', $before='', $after='') { +function comment_author_email_link( $linktext = '', $before = '', $after = '' ) { if ( $link = get_comment_author_email_link( $linktext, $before, $after ) ) echo $link; } @@ -113,21 +158,33 @@ 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. * - * @since 2.7 - * @uses apply_filters() Calls 'comment_email' hook for the display of the comment author's email - * @global object $comment The current Comment row object + * @since 2.7.0 * - * @param string $linktext The text to display instead of the comment author's email address - * @param string $before The text or HTML to display before the email link. - * @param string $after The text or HTML to display after the email link. + * @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. + * @return string */ -function get_comment_author_email_link($linktext='', $before='', $after='') { - global $comment; - $email = apply_filters('comment_email', $comment->comment_author_email); +function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) { + $comment = get_comment(); + /** + * Filter 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 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 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 { @@ -136,33 +193,50 @@ function get_comment_author_email_link($linktext='', $before='', $after='') { } /** - * Retrieve the html link to the url of the author of the current comment. + * Retrieve the HTML link to the URL of the author of the current comment. + * + * Both get_comment_author_url() and get_comment_author() rely on get_comment(), + * which falls back to the global comment variable if the $comment_ID argument is empty. * * @since 1.5.0 - * @uses apply_filters() Calls 'get_comment_author_link' hook on the complete link HTML or author + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to get the author's link. Optional. - * @return string Comment Author name or HTML link for author's URL + * @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 ) { - /** @todo Only call these functions when they are needed. Include in if... else blocks */ - $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; else $return = "$author"; - return apply_filters('get_comment_author_link', $return); + + /** + * Filter 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 $author The comment author's username. + * @param int $comment_ID The 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 - * @see get_comment_author_link() Echoes result + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to print the author's link. Optional. + * @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 ); @@ -172,56 +246,92 @@ function comment_author_link( $comment_ID = 0 ) { * Retrieve the IP address of the author of the current comment. * * @since 1.5.0 - * @uses $comment - * @uses apply_filters() + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to get the author's IP address. Optional. - * @return string The comment author's IP address. + * @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 ); - return apply_filters('get_comment_author_IP', $comment->comment_author_IP); + + /** + * Filter 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 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->comment_ID, $comment ); } /** * Display the IP address of the author of the current comment. * * @since 0.71 - * @see get_comment_author_IP() Echoes Result + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to print the author's IP address. Optional. + * @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 - * @uses apply_filters() Calls 'get_comment_author_url' hook on the comment author's URL + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to get the author's URL. Optional. - * @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') ); - return apply_filters('get_comment_author_url', $url); + + /** + * Filter 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 int $comment_ID The comment ID. + * @param WP_Comment $comment The comment object. + */ + 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 - * @uses apply_filters() - * @uses get_comment_author_url() Retrieves the comment author's URL + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to print the author's URL. Optional. + * @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 ) { - echo apply_filters('comment_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. + * + * @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, $comment->comment_ID ); } /** @@ -235,51 +345,70 @@ function comment_author_url( $comment_ID = 0 ) { * in the order of $before, link, and finally $after. * * @since 1.5.0 - * @uses apply_filters() Calls the 'get_comment_author_url_link' on the complete HTML before returning. * - * @param string $linktext The text to display instead of the comment author's email address - * @param string $before The text or HTML to display before the email link. - * @param string $after The text or HTML to display after the email link. - * @return string The HTML link between the $before and $after parameters + * @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. + * @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(); $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"; - return apply_filters('get_comment_author_url_link', $return); + + /** + * Filter the comment author's returned URL link. + * + * @since 1.5.0 + * + * @param string $return The HTML-formatted comment author URL link. + */ + return apply_filters( 'get_comment_author_url_link', $return ); } /** * Displays the HTML link of the url of the author of the current comment. * * @since 0.71 - * @see get_comment_author_url_link() Echoes result * - * @param string $linktext The text to display instead of the comment author's email address - * @param string $before The text or HTML to display before the email link. - * @param string $after The text or HTML to display after the email link. + * @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. */ function comment_author_url_link( $linktext = '', $before = '', $after = '' ) { echo get_comment_author_url_link( $linktext, $before, $after ); } /** - * Generates semantic classes for each comment element + * Generates semantic classes for each comment element. * * @since 2.7.0 - * - * @param string|array $class One or more classes to add to the class list - * @param int $comment_id An optional comment ID - * @param int $post_id An optional post ID - * @param bool $echo Whether comment_class should echo or return + * @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. + * Default empty. + * @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 @@ -287,34 +416,42 @@ function comment_class( $class = '', $comment_id = null, $post_id = null, $echo } /** - * Returns the classes for the comment div as an array + * 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 One or more classes to add to the class list - * @param int $comment_id An optional comment ID - * @param int $post_id An optional post ID - * @return array Array of classes + * @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'; + } } } @@ -355,19 +492,30 @@ function get_comment_class( $class = '', $comment_id = null, $post_id = null ) { $classes = array_map('esc_attr', $classes); - return apply_filters('comment_class', $classes, $class, $comment_id, $post_id); + /** + * Filter the returned CSS classes for the current comment. + * + * @since 2.7.0 + * + * @param array $classes An array of comment classes. + * @param string $class A comma-separated list of additional classes added to the list. + * @param int $comment_id The comment id. + * @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->comment_ID, $comment, $post_id ); } /** * Retrieve the comment date of the current comment. * * @since 1.5.0 - * @uses apply_filters() Calls 'get_comment_date' hook with the formatted date and the $d parameter respectively - * @uses $comment + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param string $d The format of the date (defaults to user's config) - * @param int $comment_ID The ID of the comment for which to get the date. Optional. - * @return string The comment's date + * @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 ) { $comment = get_comment( $comment_ID ); @@ -375,16 +523,27 @@ function get_comment_date( $d = '', $comment_ID = 0 ) { $date = mysql2date(get_option('date_format'), $comment->comment_date); else $date = mysql2date($d, $comment->comment_date); - return apply_filters('get_comment_date', $date, $d); + /** + * Filter 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 WP_Comment $comment The comment object. + */ + return apply_filters( 'get_comment_date', $date, $d, $comment ); } /** * 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 The format of the date (defaults to user's config) - * @param int $comment_ID The ID of the comment for which to print the date. Optional. + * @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 ); @@ -393,67 +552,104 @@ function comment_date( $d = '', $comment_ID = 0 ) { /** * Retrieve the excerpt of the current comment. * - * Will cut each word and only output the first 20 words with '...' at the end. - * If the word count is less than 20, then no truncating is done and no '...' + * Will cut each word and only output the first 20 words with '…' at the end. + * If the word count is less than 20, then no truncating is done and no '…' * will appear. * * @since 1.5.0 - * @uses $comment - * @uses apply_filters() Calls 'get_comment_excerpt' on truncated comment + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to get the excerpt. Optional. - * @return string The maybe truncated comment with 20 words or less + * @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; + $comment_text = strip_tags( str_replace( array( "\n", "\r" ), ' ', $comment->comment_content ) ); + $words = explode( ' ', $comment_text ); + + /** + * 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 ); + + $use_ellipsis = count( $words ) > $comment_excerpt_length; + if ( $use_ellipsis ) { + $words = array_slice( $words, 0, $comment_excerpt_length ); } - $excerpt = ''; - for ($i=0; $i<$k; $i++) { - $excerpt .= $blah[$i] . ' '; + + $excerpt = trim( join( ' ', $words ) ); + if ( $use_ellipsis ) { + $excerpt .= '…'; } - $excerpt .= ($use_dotdotdot) ? '...' : ''; - return apply_filters('get_comment_excerpt', $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 WP_Comment $comment The comment object. + */ + return apply_filters( 'get_comment_excerpt', $excerpt, $comment->comment_ID, $comment ); } /** * Display the excerpt of the current comment. * * @since 1.2.0 - * @uses apply_filters() Calls 'comment_excerpt' hook before displaying excerpt + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to print the excerpt. Optional. + * @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 ) { - echo apply_filters('comment_excerpt', get_comment_excerpt($comment_ID) ); + $comment = get_comment( $comment_ID ); + $comment_excerpt = get_comment_excerpt( $comment ); + + /** + * Filter 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, $comment->comment_ID ); } /** * Retrieve the comment id of the current comment. * * @since 1.5.0 - * @uses $comment - * @uses apply_filters() Calls the 'get_comment_ID' hook for the comment ID * - * @return int The comment ID + * @return int The comment ID. */ function get_comment_ID() { - global $comment; - return apply_filters('get_comment_ID', $comment->comment_ID); + $comment = get_comment(); + + /** + * Filter 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 WP_Comment $comment The comment object. + */ + return apply_filters( 'get_comment_ID', $comment->comment_ID, $comment ); } /** - * Displays the comment id of the current comment. + * Display the comment id of the current comment. * * @since 0.71 - * @see get_comment_ID() Echoes Result */ function comment_ID() { echo get_comment_ID(); @@ -463,10 +659,24 @@ function comment_ID() { * Retrieve the link to a given comment. * * @since 1.5.0 - * @uses $comment + * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object. Added `$cpage` argument. * - * @param object|string|int $comment Comment to retrieve. - * @param array $args Optional args. + * @see get_page_of_comment() + * + * @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 {@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() ) { @@ -475,36 +685,90 @@ function get_comment_link( $comment = null, $args = array() ) { $comment = get_comment($comment); // Backwards compat - if ( !is_array($args) ) { - $page = $args; - $args = array(); - $args['page'] = $page; + 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']; - if ( empty($args['per_page']) ) { - $args['per_page'] = 0; - $args['page'] = 0; + // 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 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 ) { + 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 ); } - return apply_filters( 'get_comment_link', $link . '#comment-' . $comment->comment_ID, $comment, $args ); + 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 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, $cpage ); } /** @@ -512,128 +776,217 @@ function get_comment_link( $comment = null, $args = array() ) { * * @since 1.5.0 * - * @param int $post_id Optional post id - * @return string The link to the comments + * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post. + * @return string The link to the comments. */ -function get_comments_link($post_id = 0) { - return get_permalink($post_id) . '#comments'; +function get_comments_link( $post_id = 0 ) { + $hash = get_comments_number( $post_id ) ? '#comments' : '#respond'; + $comments_link = get_permalink( $post_id ) . $hash; + + /** + * Filter the returned post comments permalink. + * + * @since 3.6.0 + * + * @param string $comments_link Post comments permalink with '#comments' appended. + * @param int|WP_Post $post_id Post ID or WP_Post object. + */ + return apply_filters( 'get_comments_link', $comments_link, $post_id ); } /** - * Displays the link to the current post comments. + * Display the link to the current post comments. * * @since 0.71 * - * @param string $deprecated Not Used - * @param bool $deprecated_2 Not Used + * @param string $deprecated 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' ); - echo get_comments_link(); + echo esc_url( get_comments_link() ); } /** * Retrieve the amount of comments a post has. * * @since 1.5.0 - * @uses apply_filters() Calls the 'get_comments_number' hook on the number of comments * - * @param int $post_id The Post ID - * @return int The number of comments a post has + * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post. + * @return int The number of comments a post has. */ function get_comments_number( $post_id = 0 ) { - $post_id = absint( $post_id ); + $post = get_post( $post_id ); - if ( !$post_id ) - $post_id = get_the_ID(); - - $post = get_post($post_id); - if ( ! isset($post->comment_count) ) + if ( ! $post ) { $count = 0; - else + } else { $count = $post->comment_count; + $post_id = $post->ID; + } - return apply_filters('get_comments_number', $count, $post_id); + /** + * Filter the returned comment count for a post. + * + * @since 1.5.0 + * + * @param int $count Number of comments a post has. + * @param int $post_id Post ID. + */ + return apply_filters( 'get_comments_number', $count, $post_id ); } /** * Display the language string for the number of comments the current post has. * * @since 0.71 - * @uses apply_filters() Calls the 'comments_number' hook on the output and number of comments respectively. * - * @param string $zero Text for no comments - * @param string $one Text for one comment - * @param string $more Text for more than one comment + * @param string $zero Optional. Text for no comments. Default false. + * @param string $one Optional. Text for one comment. Default false. + * @param string $more Optional. Text for more than one comment. Default false. * @param string $deprecated Not used. */ function comments_number( $zero = false, $one = false, $more = false, $deprecated = '' ) { - if ( !empty( $deprecated ) ) + if ( ! empty( $deprecated ) ) { _deprecated_argument( __FUNCTION__, '1.3' ); + } + echo get_comments_number_text( $zero, $one, $more ); +} +/** + * Display the language string for the number of comments the current post has. + * + * @since 4.0.0 + * + * @param string $zero Optional. Text for no comments. Default false. + * @param string $one Optional. Text for one comment. Default false. + * @param string $more Optional. Text for more than one comment. Default false. + */ +function get_comments_number_text( $zero = false, $one = false, $more = false ) { $number = get_comments_number(); - if ( $number > 1 ) - $output = str_replace('%', number_format_i18n($number), ( false === $more ) ? __('% Comments') : $more); - elseif ( $number == 0 ) - $output = ( false === $zero ) ? __('No Comments') : $zero; - else // must be one - $output = ( false === $one ) ? __('1 Comment') : $one; - - echo apply_filters('comments_number', $output, $number); + if ( $number > 1 ) { + 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 + $output = ( false === $one ) ? __( '1 Comment' ) : $one; + } + /** + * Filter the comments count for display. + * + * @since 1.5.0 + * + * @see _n() + * + * @param string $output A translatable string formatted based on whether the count + * is equal to 0, 1, or 1+. + * @param int $number The number of post comments. + */ + return apply_filters( 'comments_number', $output, $number ); } /** * Retrieve the text of the current comment. * * @since 1.5.0 - * @uses $comment + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to get the text. Optional. - * @return string The comment content + * @see Walker_Comment::comment() + * + * @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 ) { +function get_comment_text( $comment_ID = 0, $args = array() ) { $comment = get_comment( $comment_ID ); - return apply_filters( 'get_comment_text', $comment->comment_content, $comment ); + + /** + * Filter the text of a comment. + * + * @since 1.5.0 + * + * @see Walker_Comment::comment() + * + * @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 ); } /** - * Displays the text of the current comment. + * Display the text of the current comment. * * @since 0.71 - * @uses apply_filters() Passes the comment content through the 'comment_text' hook before display - * @uses get_comment_text() Gets the comment content + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to print the text. Optional. + * @see Walker_Comment::comment() + * + * @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 ) { +function comment_text( $comment_ID = 0, $args = array() ) { $comment = get_comment( $comment_ID ); - echo apply_filters( 'comment_text', get_comment_text( $comment_ID ), $comment ); + + $comment_text = get_comment_text( $comment, $args ); + /** + * Filter 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 WP_Comment $comment The comment object. + * @param array $args An array of arguments. + */ + echo apply_filters( 'comment_text', $comment_text, $comment, $args ); } /** * Retrieve the comment time of the current comment. * * @since 1.5.0 - * @uses $comment - * @uses apply_filter() Calls 'get_comment_time' hook with the formatted time, the $d parameter, and $gmt parameter passed. * - * @param string $d Optional. The format of the time (defaults to user's config) - * @param bool $gmt Whether to use the GMT date - * @param bool $translate Whether to translate the time (for use in feeds) - * @return string The formatted time + * @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). + * Default true. + * @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); else $date = mysql2date($d, $comment_date, $translate); - return apply_filters('get_comment_time', $date, $d, $gmt, $translate); + + /** + * Filter the returned comment time. + * + * @since 1.5.0 + * + * @param string|int $date The comment time, formatted as a date string or Unix timestamp. + * @param string $d Date format. + * @param bool $gmt Whether the GMT date is in use. + * @param bool $translate Whether the time is translated. + * @param WP_Comment $comment The comment object. + */ + return apply_filters( 'get_comment_time', $date, $d, $gmt, $translate, $comment ); } /** @@ -641,7 +994,7 @@ function get_comment_time( $d = '', $gmt = false, $translate = true ) { * * @since 0.71 * - * @param string $d Optional. The format of the time (defaults to user's config) + * @param string $d Optional. The format of the time. Default user's settings. */ function comment_time( $d = '' ) { echo get_comment_time($d); @@ -651,18 +1004,28 @@ function comment_time( $d = '' ) { * Retrieve the comment type of the current comment. * * @since 1.5.0 - * @uses $comment - * @uses apply_filters() Calls the 'get_comment_type' hook on the comment type + * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object. * - * @param int $comment_ID The ID of the comment for which to get the type. Optional. - * @return string The comment type + * @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 ) { $comment = get_comment( $comment_ID ); if ( '' == $comment->comment_type ) $comment->comment_type = 'comment'; - return apply_filters('get_comment_type', $comment->comment_type); + /** + * Filter 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 int $comment_ID The comment ID. + * @param WP_Comment $comment The comment object. + */ + return apply_filters( 'get_comment_type', $comment->comment_type, $comment->comment_ID, $comment ); } /** @@ -670,11 +1033,11 @@ function get_comment_type( $comment_ID = 0 ) { * * @since 0.71 * - * @param string $commenttxt The string to display for comment type - * @param string $trackbacktxt The string to display for trackback type - * @param string $pingbacktxt The string to display for pingback type + * @param string $commenttxt Optional. String to display for comment type. Default false. + * @param string $trackbacktxt Optional. String to display for trackback type. Default false. + * @param string $pingbacktxt Optional. String to display for pingback type. Default false. */ -function comment_type($commenttxt = false, $trackbacktxt = false, $pingbacktxt = false) { +function comment_type( $commenttxt = false, $trackbacktxt = false, $pingbacktxt = false ) { if ( false === $commenttxt ) $commenttxt = _x( 'Comment', 'noun' ); if ( false === $trackbacktxt ) $trackbacktxt = __( 'Trackback' ); if ( false === $pingbacktxt ) $pingbacktxt = __( 'Pingback' ); @@ -699,52 +1062,68 @@ function comment_type($commenttxt = false, $trackbacktxt = false, $pingbacktxt = * current post is used and appended to the correct page to go to. * * @since 1.5.0 - * @uses apply_filters() Calls 'trackback_url' on the resulting trackback URL * - * @return string The trackback URL after being filtered + * @return string The trackback URL after being filtered. */ function get_trackback_url() { - if ( '' != get_option('permalink_structure') ) { + if ( '' != get_option('permalink_structure') ) $tb_url = trailingslashit(get_permalink()) . user_trailingslashit('trackback', 'single_trackback'); - } else { + else $tb_url = get_option('siteurl') . '/wp-trackback.php?p=' . get_the_ID(); - } - return apply_filters('trackback_url', $tb_url); + + /** + * Filter the returned trackback URL. + * + * @since 2.2.0 + * + * @param string $tb_url The trackback URL. + */ + return apply_filters( 'trackback_url', $tb_url ); } /** - * Displays the current post's trackback URL. + * Display the current post's trackback URL. * * @since 0.71 - * @uses get_trackback_url() Gets the trackback url for the current post * - * @param bool $deprecated_echo Remove backwards compat in 2.5 - * @return void|string Should only be used to echo the trackback URL, use get_trackback_url() for the result instead. + * @param bool $deprecated_echo Not used. + * @return void|string Should only be used to echo the trackback URL, use 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(); + } } /** - * Generates and displays the RDF for the trackback information of current post. + * Generate and display the RDF for the trackback information of current post. * * Deprecated in 3.0.0, and restored in 3.0.1. * * @since 0.71 * - * @param int $deprecated Not used (Was $timezone = 0) + * @param int $deprecated Not used (Was $timezone = 0). */ function trackback_rdf( $deprecated = '' ) { - if ( !empty( $deprecated ) ) + if ( ! empty( $deprecated ) ) { _deprecated_argument( __FUNCTION__, '2.5' ); + } - if ( false !== stripos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') ) + if ( isset( $_SERVER['HTTP_USER_AGENT'] ) && false !== stripos( $_SERVER['HTTP_USER_AGENT'], 'W3C_Validator' ) ) { return; + } echo 'comment_status ); + + /** + * Filter whether the current post is open for comments. + * + * @since 2.5.0 + * + * @param bool $open Whether the current post is open for comments. + * @param int|WP_Post $post_id The post ID or WP_Post object. + */ return apply_filters( 'comments_open', $open, $post_id ); } @@ -781,9 +1168,8 @@ function comments_open( $post_id = null ) { * Whether the current post is open for pings. * * @since 1.5.0 - * @uses $post * - * @param int $post_id An optional post ID to check instead of the current post. + * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post. * @return bool True if pings are accepted */ function pings_open( $post_id = null ) { @@ -791,11 +1177,20 @@ function pings_open( $post_id = null ) { $_post = get_post($post_id); $open = ( 'open' == $_post->ping_status ); + + /** + * Filter whether the current post is open for pings. + * + * @since 2.5.0 + * + * @param bool $open Whether the current post is open for pings. + * @param int|WP_Post $post_id The post ID or WP_Post object. + */ return apply_filters( 'pings_open', $open, $post_id ); } /** - * Displays form token for unfiltered comments. + * Display form token for unfiltered comments. * * Will only display nonce token if the current user has permissions for * unfiltered html. Won't display the token for other users. @@ -807,14 +1202,10 @@ function pings_open( $post_id = null ) { * Backported to 2.0.10. * * @since 2.1.3 - * @uses $post Gets the ID of the current post for the token */ function wp_comment_form_unfiltered_html_nonce() { - global $post; - - $post_id = 0; - if ( !empty($post) ) - $post_id = $post->ID; + $post = get_post(); + $post_id = $post ? $post->ID : 0; if ( current_user_can( 'unfiltered_html' ) ) { wp_nonce_field( 'unfiltered-html-comment_' . $post_id, '_wp_unfiltered_html_comment_disabled', false ); @@ -823,7 +1214,7 @@ function wp_comment_form_unfiltered_html_nonce() { } /** - * Loads the comment template specified in $file. + * Load the comment template specified in $file. * * Will not display the comments template if not on single post or page, or if * the post does not have comments. @@ -838,15 +1229,23 @@ function wp_comment_form_unfiltered_html_nonce() { * 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. * - * @since 1.5.0 - * @global array $comment List of comment objects for the current post - * @uses $wpdb - * @uses $post * @uses $withcomments Will not try to get the comments if the post has none. * - * @param string $file Optional, default '/comments.php'. The file to load - * @param bool $separate_comments Optional, whether to separate the comments by comment type. Default is false. - * @return null Returns null if no comments appear + * @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 + * + * @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. */ 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; @@ -859,58 +1258,127 @@ function comments_template( $file = '/comments.php', $separate_comments = false $req = get_option('require_name_email'); - /** + /* * Comment author information fetched from the comment cookies. - * - * @uses wp_get_current_commenter() */ $commenter = wp_get_current_commenter(); - /** + /* * The name of the current comment author escaped for use in attributes. + * Escaped by sanitize_comment_cookies(). */ - $comment_author = $commenter['comment_author']; // Escaped by sanitize_comment_cookies() + $comment_author = $commenter['comment_author']; - /** + /* * The email address of the current comment author escaped for use in attributes. + * Escaped by sanitize_comment_cookies(). */ - $comment_author_email = $commenter['comment_author_email']; // Escaped by sanitize_comment_cookies() + $comment_author_email = $commenter['comment_author_email']; - /** + /* * The url of the current comment author escaped for use in attributes. */ $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') ); - } 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)); + $comment_args = array( + 'orderby' => 'comment_date_gmt', + 'order' => 'ASC', + 'status' => 'approve', + 'post_id' => $post->ID, + 'hierarchical' => 'threaded', + 'no_found_rows' => false, + 'update_comment_meta_cache' => false, // We lazy-load comment meta for performance. + ); + + if ( $user_ID ) { + $comment_args['include_unapproved'] = array( $user_ID ); + } elseif ( ! empty( $comment_author_email ) ) { + $comment_args['include_unapproved'] = array( $comment_author_email ); } - // keep $comments for legacy's sake - $wp_query->comments = apply_filters( 'comments_array', $comments, $post->ID ); + $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_count = $top_level_query->query( array( + 'count' => true, + 'orderby' => false, + 'post_id' => $post->ID, + 'parent' => 0, + ) ); + + $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. + $comments_flat = array(); + foreach ( $_comments as $_comment ) { + $comments_flat = array_merge( $comments_flat, array( $_comment ), $_comment->get_children( array( + 'format' => 'flat', + 'status' => $comment_args['status'], + 'orderby' => $comment_args['orderby'] + ) ) ); + } + + /** + * Filter 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_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); - 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); + $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; } - if ( !defined('COMMENTS_TEMPLATE') || !COMMENTS_TEMPLATE) + if ( !defined('COMMENTS_TEMPLATE') ) define('COMMENTS_TEMPLATE', true); - $include = apply_filters('comments_template', STYLESHEETPATH . $file ); + $theme_template = STYLESHEETPATH . $file; + /** + * Filter the path to the theme template file used for the comments template. + * + * @since 1.5.1 + * + * @param string $theme_template The path to the theme template file. + */ + $include = apply_filters( 'comments_template', $theme_template ); if ( file_exists( $include ) ) require( $include ); elseif ( file_exists( TEMPLATEPATH . $file ) ) @@ -920,7 +1388,7 @@ function comments_template( $file = '/comments.php', $separate_comments = false } /** - * Displays the JS popup script to show a comment. + * 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. @@ -928,15 +1396,16 @@ function comments_template( $file = '/comments.php', $separate_comments = false * 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 - * @global string $wpcommentspopupfile The URL to use for the popup window - * @global int $wpcommentsjavascript Whether to use JavaScript. Set when function is called * - * @param int $width Optional. The width of the popup window - * @param int $height Optional. The height of the popup window - * @param string $file Optional. Sets the location of the popup window + * @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='') { +function comments_popup_script( $width = 400, $height = 400, $file = '' ) { global $wpcommentspopupfile, $wpcommentsjavascript; if (empty ($file)) { @@ -953,32 +1422,50 @@ function comments_popup_script($width=400, $height=400, $file='') { /** * 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 + * 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. * * @since 0.71 - * @uses $wpcommentspopupfile - * @uses $wpcommentsjavascript - * @uses $post - * - * @param string $zero The string to display when no comments - * @param string $one The string to display when only one comment is available - * @param string $more The string to display when there are more than one comment - * @param string $css_class The CSS class to use for comments - * @param string $none The string to display when comments have been turned off - * @return null Returns null on single posts and pages. + * + * @param string $zero Optional. String to display when no comments. Default false. + * @param string $one Optional. String to display when only one comment is available. + * Default false. + * @param string $more Optional. String to display when there are more than one comment. + * Default false. + * @param string $css_class Optional. CSS class to use for comments. Default empty. + * @param string $none Optional. String to display when comments have been turned off. + * Default false. */ 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 . ''; @@ -986,7 +1473,7 @@ 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; } @@ -998,22 +1485,40 @@ 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 '"'; } if ( !empty( $css_class ) ) { echo ' class="'.$css_class.'" '; } - $title = the_title_attribute( array('echo' => 0 ) ); - echo apply_filters( 'comments_popup_link_attributes', '' ); + $attributes = ''; + /** + * Filter the comments popup link attributes for display. + * + * @since 2.5.0 + * + * @param string $attributes The comments popup 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 ''; } @@ -1021,60 +1526,115 @@ function comments_popup_link( $zero = false, $one = false, $more = false, $css_c /** * Retrieve HTML content for reply to comment link. * - * The default arguments that can be override are 'add_below', 'respond_id', - * 'reply_text', 'login_text', and 'depth'. The 'login_text' argument will be - * used, if the user must log in or register first before posting a comment. The - * 'reply_text' will be used, if they can post a reply. The 'add_below' and - * 'respond_id' arguments are for the JavaScript moveAddCommentForm() function - * parameters. - * * @since 2.7.0 - * - * @param array $args Optional. Override default options. - * @param int $comment Optional. Comment being replied to. - * @param int $post Optional. Post that the comment is going to be displayed on. - * @return string|bool|null Link to show comment form, if successful. False, if comments are closed. + * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object. + * + * @param array $args { + * Optional. Override default arguments. + * + * @type string $add_below The first part of the selector used to identify the comment to respond below. + * The resulting value is passed as the first parameter to addComment.moveForm(), + * concatenated as $add_below-$comment->comment_ID. Default 'comment'. + * @type string $respond_id The selector identifying the responding comment. Passed as the third parameter + * to addComment.moveForm(), and appended to the link URL as a hash value. + * Default 'respond'. + * @type string $reply_text The text of the Reply link. Default 'Reply'. + * @type string $login_text The text of the link to reply if logged out. Default 'Log in to Reply'. + * @type int $depth' The depth of the new comment. Must be greater than 0 and less than the value + * of the 'thread_comments_depth' option set in Settings > Discussion. Default 0. + * @type string $before The text or HTML to add before the reply link. Default empty. + * @type string $after The text or HTML to add after the reply link. Default empty. + * } + * @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) { - global $user_ID; - - $defaults = array('add_below' => 'comment', 'respond_id' => 'respond', 'reply_text' => __('Reply'), - 'login_text' => __('Log in to Reply'), 'depth' => 0, 'before' => '', 'after' => ''); +function get_comment_reply_link( $args = array(), $comment = null, $post = null ) { + $defaults = array( + '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); + $args = wp_parse_args( $args, $defaults ); - if ( 0 == $args['depth'] || $args['max_depth'] <= $args['depth'] ) + if ( 0 == $args['depth'] || $args['max_depth'] <= $args['depth'] ) { return; + } - extract($args, EXTR_SKIP); + $comment = get_comment( $comment ); - $comment = get_comment($comment); - if ( empty($post) ) + if ( empty( $post ) ) { $post = $comment->comment_post_ID; - $post = get_post($post); + } + + $post = get_post( $post ); - if ( !comments_open($post->ID) ) + if ( ! comments_open( $post->ID ) ) { return false; + } + + /** + * Filter 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 ); - $link = ''; + if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) { + $link = sprintf( '', + esc_url( wp_login_url( get_permalink() ) ), + $args['login_text'] + ); + } else { + $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( "%s", + 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'] + ); + } - if ( get_option('comment_registration') && !$user_ID ) - $link = ''; - else - $link = "comment_ID ) ) . "#" . $respond_id . "' onclick='return addComment.moveForm(\"$add_below-$comment->comment_ID\", \"$comment->comment_ID\", \"$respond_id\", \"$post->ID\")'>$reply_text"; - return apply_filters('comment_reply_link', $before . $link . $after, $args, $comment, $post); + /** + * Filter the comment reply link. + * + * @since 2.7.0 + * + * @param string $link The HTML markup for the comment reply link. + * @param array $args An array of arguments overriding the defaults. + * @param object $comment The object of the comment being replied. + * @param WP_Post $post The WP_Post object. + */ + return apply_filters( 'comment_reply_link', $args['before'] . $link . $args['after'], $args, $comment, $post ); } /** * Displays the HTML content for reply to comment link. * * @since 2.7.0 - * @see get_comment_reply_link() Echoes result * - * @param array $args Optional. Override default options. - * @param int $comment Optional. Comment being replied to. - * @param int $post Optional. Post that the comment is going to be displayed on. - * @return string|bool|null Link to show comment form, if successful. False, if comments are closed. + * @see get_comment_reply_link() + * + * @param array $args Optional. Override default options. + * @param int $comment Comment being replied to. Default current comment. + * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on. + * Default current post. + * @return mixed Link to show comment form, if successful. False, if comments are closed. */ function comment_reply_link($args = array(), $comment = null, $post = null) { echo get_comment_reply_link($args, $comment, $post); @@ -1083,47 +1643,83 @@ function comment_reply_link($args = array(), $comment = null, $post = null) { /** * Retrieve HTML content for reply to post link. * - * The default arguments that can be override are 'add_below', 'respond_id', - * 'reply_text', 'login_text', and 'depth'. The 'login_text' argument will be - * used, if the user must log in or register first before posting a comment. The - * 'reply_text' will be used, if they can post a reply. The 'add_below' and - * 'respond_id' arguments are for the JavaScript moveAddCommentForm() function - * parameters. - * * @since 2.7.0 * - * @param array $args Optional. Override default options. - * @param int|object $post Optional. Post that the comment is going to be displayed on. Defaults to current post. - * @return string|bool|null Link to show comment form, if successful. False, if comments are closed. + * @param array $args { + * Optional. Override default arguments. + * + * @type string $add_below The first part of the selector used to identify the comment to respond below. + * The resulting value is passed as the first parameter to addComment.moveForm(), + * concatenated as $add_below-$comment->comment_ID. Default is 'post'. + * @type string $respond_id The selector identifying the responding comment. Passed as the third parameter + * to addComment.moveForm(), and appended to the link URL as a hash value. + * Default 'respond'. + * @type string $reply_text Text of the Reply link. Default is 'Leave a Comment'. + * @type string $login_text Text of the link to reply if logged out. Default is 'Log in to leave a Comment'. + * @type string $before Text or HTML to add before the reply link. Default empty. + * @type string $after Text or HTML to add after the reply link. Default empty. + * } + * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. + * Default current post. + * @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) { - global $user_ID; - - $defaults = array('add_below' => 'post', 'respond_id' => 'respond', 'reply_text' => __('Leave a Comment'), - 'login_text' => __('Log in to leave a Comment'), 'before' => '', 'after' => ''); + $defaults = array( + 'add_below' => 'post', + 'respond_id' => 'respond', + 'reply_text' => __('Leave a Comment'), + 'login_text' => __('Log in to leave a Comment'), + 'before' => '', + 'after' => '', + ); $args = wp_parse_args($args, $defaults); - extract($args, EXTR_SKIP); + $post = get_post($post); - if ( !comments_open($post->ID) ) + if ( ! comments_open( $post->ID ) ) { return false; + } - if ( get_option('comment_registration') && !$user_ID ) { - $link = '' . $login_text . ''; + if ( get_option('comment_registration') && ! is_user_logged_in() ) { + $link = sprintf( '', + wp_login_url( get_permalink() ), + $args['login_text'] + ); } else { - $link = "$reply_text"; + $onclick = sprintf( 'return addComment.moveForm( "%1$s-%2$s", "0", "%3$s", "%2$s" )', + $args['add_below'], $post->ID, $args['respond_id'] + ); + + $link = sprintf( "%s", + get_permalink( $post->ID ) . '#' . $args['respond_id'], + $onclick, + $args['reply_text'] + ); } - return apply_filters('post_comments_link', $before . $link . $after, $post); + $formatted_link = $args['before'] . $link . $args['after']; + + /** + * Filter the formatted post comments link HTML. + * + * @since 2.7.0 + * + * @param string $formatted The HTML-formatted post comments link. + * @param int|WP_Post $post The post ID or WP_Post object. + */ + return apply_filters( 'post_comments_link', $formatted_link, $post ); } /** * Displays the HTML content for reply to post link. + * * @since 2.7.0 + * * @see get_post_reply_link() * - * @param array $args Optional. Override default options. - * @param int|object $post Optional. Post that the comment is going to be displayed on. + * @param array $args Optional. Override default options, + * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on. + * Default current post. * @return string|bool|null Link to show comment form, if successful. False, if comments are closed. */ function post_reply_link($args = array(), $post = null) { @@ -1135,15 +1731,28 @@ function post_reply_link($args = array(), $post = null) { * * @since 2.7.0 * - * @param string $text Optional. Text to display for cancel reply link. + * @param string $text Optional. Text to display for cancel reply link. Default empty. + * @return string */ -function get_cancel_comment_reply_link($text = '') { +function get_cancel_comment_reply_link( $text = '' ) { if ( empty($text) ) $text = __('Click here to cancel reply.'); $style = isset($_GET['replytocom']) ? '' : ' style="display:none;"'; $link = esc_html( remove_query_arg('replytocom') ) . '#respond'; - return apply_filters('cancel_comment_reply_link', '' . $text . '', $link, $text); + + $formatted_link = '' . $text . ''; + + /** + * Filter the cancel comment reply link HTML. + * + * @since 2.7.0 + * + * @param string $formatted_link The HTML-formatted cancel comment reply link. + * @param string $link Cancel comment reply link URL. + * @param string $text Cancel comment reply link text. + */ + return apply_filters( 'cancel_comment_reply_link', $formatted_link, $link, $text ); } /** @@ -1151,9 +1760,9 @@ function get_cancel_comment_reply_link($text = '') { * * @since 2.7.0 * - * @param string $text Optional. Text to display for cancel reply link. + * @param string $text Optional. Text to display for cancel reply link. Default empty. */ -function cancel_comment_reply_link($text = '') { +function cancel_comment_reply_link( $text = '' ) { echo get_cancel_comment_reply_link($text); } @@ -1162,6 +1771,7 @@ function cancel_comment_reply_link($text = '') { * * @since 3.0.0 * + * @param int $id Optional. Post ID. Default current post ID. * @return string Hidden input HTML for replying to comments */ function get_comment_id_fields( $id = 0 ) { @@ -1171,30 +1781,47 @@ function get_comment_id_fields( $id = 0 ) { $replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0; $result = "\n"; $result .= "\n"; - return apply_filters('comment_id_fields', $result, $id, $replytoid); + + /** + * Filter the returned comment id fields. + * + * @since 3.0.0 + * + * @param string $result The HTML-formatted hidden id field comment elements. + * @param int $id The post ID. + * @param int $replytoid The id of the comment being replied to. + */ + return apply_filters( 'comment_id_fields', $result, $id, $replytoid ); } /** * Output hidden input HTML for replying to comments. * * @since 2.7.0 - * @see get_comment_id_fields() Echoes result + * + * @param int $id Optional. Post ID. Default current post ID. */ function comment_id_fields( $id = 0 ) { echo get_comment_id_fields( $id ); } /** - * Display text based on comment reply status. Only affects users with Javascript disabled. + * Display text based on comment reply status. + * + * Only affects users with JavaScript disabled. * * @since 2.7.0 * - * @param string $noreplytext Optional. Text to display when not replying to a comment. - * @param string $replytext Optional. Text to display when replying to a comment. Accepts "%s" for the author of the comment being replied to. - * @param string $linktoparent Optional. Boolean to control making the author's name a link to their comment. + * @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. + * Default false. Accepts "%s" for the author of the comment + * being replied to. + * @param string $linktoparent Optional. Boolean to control making the author's name a link + * to their comment. Default true. */ 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' ); @@ -1205,214 +1832,50 @@ 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. + * List comments. * - * @package WordPress - * @uses Walker - * @since 2.7.0 - */ -class Walker_Comment extends Walker { - /** - * @see Walker::$tree_type - * @since 2.7.0 - * @var string - */ - var $tree_type = 'comment'; - - /** - * @see Walker::$db_fields - * @since 2.7.0 - * @var array - */ - var $db_fields = array ('parent' => 'comment_parent', 'id' => 'comment_ID'); - - /** - * @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. - */ - function start_lvl( &$output, $depth = 0, $args = array() ) { - $GLOBALS['comment_depth'] = $depth + 1; - - switch ( $args['style'] ) { - case 'div': - break; - case 'ol': - echo "
    \n"; - break; - default: - case 'ul': - echo "
      \n"; - break; - } - } - - /** - * @see Walker::end_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 Will only append content if style argument value is 'ol' or 'ul'. - */ - function end_lvl( &$output, $depth = 0, $args = array() ) { - $GLOBALS['comment_depth'] = $depth + 1; - - switch ( $args['style'] ) { - case 'div': - break; - case 'ol': - echo "
\n"; - break; - default: - case 'ul': - echo "\n"; - break; - } - } - - /** - * This function is designed to enhance Walker::display_element() to - * display children of higher nesting levels than selected inline on - * the highest depth level displayed. This prevents them being orphaned - * at the end of the comment list. - * - * Example: max_depth = 2, with 5 levels of nested content. - * 1 - * 1.1 - * 1.1.1 - * 1.1.1.1 - * 1.1.1.1.1 - * 1.1.2 - * 1.1.2.1 - * 2 - * 2.2 - * - */ - function display_element( $element, &$children_elements, $max_depth, $depth=0, $args, &$output ) { - - if ( !$element ) - return; - - $id_field = $this->db_fields['id']; - $id = $element->$id_field; - - parent::display_element( $element, $children_elements, $max_depth, $depth, $args, $output ); - - // If we're at the max depth, and the current element still has children, loop over those and display them at this level - // This is to prevent them being orphaned to the end of the list. - if ( $max_depth <= $depth + 1 && isset( $children_elements[$id]) ) { - foreach ( $children_elements[ $id ] as $child ) - $this->display_element( $child, $children_elements, $max_depth, $depth, $args, $output ); - - unset( $children_elements[ $id ] ); - } - - } - - /** - * @see Walker::start_el() - * @since 2.7.0 - * - * @param string $output Passed by reference. Used to append additional content. - * @param object $comment Comment data object. - * @param int $depth Depth of comment in reference to parents. - * @param array $args - */ - function start_el( &$output, $comment, $depth, $args, $id = 0 ) { - $depth++; - $GLOBALS['comment_depth'] = $depth; - - if ( !empty($args['callback']) ) { - call_user_func($args['callback'], $comment, $args, $depth); - return; - } - - $GLOBALS['comment'] = $comment; - extract($args, EXTR_SKIP); - - if ( 'div' == $args['style'] ) { - $tag = 'div'; - $add_below = 'comment'; - } else { - $tag = 'li'; - $add_below = 'div-comment'; - } -?> - < id="comment-"> - -
- -
- - %s says:'), get_comment_author_link()) ?> -
-comment_approved == '0') : ?> - -
- - -
- -
- - - -
- $add_below, 'depth' => $depth, 'max_depth' => $args['max_depth']))) ?> -
- -
- -\n"; - else - echo "\n"; - } - -} - -/** - * List comments - * - * Used in the comments.php template to list comments for a particular post + * Used in the comments.php template to list comments for a particular post. * * @since 2.7.0 - * @uses Walker_Comment * - * @param string|array $args Formatting options - * @param array $comments Optional array of comment objects. Defaults to $wp_query->comments + * @see WP_Query->comments + * + * @global WP_Query $wp_query + * @global int $comment_alt + * @global int $comment_depth + * @global int $comment_thread_alt + * @global bool $overridden_cpage + * @global bool $in_comment_loop + * + * @param string|array $args { + * Optional. Formatting options. + * + * @type object $walker Instance of a Walker class to list comments. Default null. + * @type int $max_depth The maximum comments depth. Default empty. + * @type string $style The style of list ordering. Default 'ul'. Accepts 'ul', 'ol'. + * @type string $callback Callback function to use. Default null. + * @type string $end-callback Callback function to use at the end. Default null. + * @type string $type Type of comments to list. + * Default 'all'. Accepts 'all', 'comment', 'pingback', 'trackback', 'pings'. + * @type int $page Page ID to list comments for. Default empty. + * @type int $per_page Number of comments to list per page. Default empty. + * @type int $avatar_size Height and width dimensions of the avatar size. Default 32. + * @type string $reverse_top_level Ordering of the listed comments. Default null. Accepts 'desc', 'asc'. + * @type bool $reverse_children Whether to reverse child comments in the list. Default null. + * @type string $format How to format the comments list. + * Default 'html5' if the theme supports it. Accepts 'html5', 'xhtml'. + * @type bool $short_ping Whether to output short pings. Default false. + * @type bool $echo Whether to echo the output or return it. Default true. + * } + * @param array $comments Optional. Array of WP_Comment objects. */ -function wp_list_comments($args = array(), $comments = null ) { +function wp_list_comments( $args = array(), $comments = null ) { global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop; $in_comment_loop = true; @@ -1420,18 +1883,43 @@ function wp_list_comments($args = array(), $comments = null ) { $comment_alt = $comment_thread_alt = 0; $comment_depth = 1; - $defaults = array('walker' => null, 'max_depth' => '', 'style' => 'ul', 'callback' => null, 'end-callback' => null, 'type' => 'all', - 'page' => '', 'per_page' => '', 'avatar_size' => 32, 'reverse_top_level' => null, 'reverse_children' => ''); + $defaults = array( + 'walker' => null, + 'max_depth' => '', + 'style' => 'ul', + 'callback' => null, + 'end-callback' => null, + 'type' => 'all', + 'page' => '', + 'per_page' => '', + 'avatar_size' => 32, + 'reverse_top_level' => null, + 'reverse_children' => '', + 'format' => current_theme_supports( 'html5', 'comment-list' ) ? 'html5' : 'xhtml', + 'short_ping' => false, + 'echo' => true, + ); $r = wp_parse_args( $args, $defaults ); + /** + * Filter the arguments used in retrieving the comment list. + * + * @since 4.0.0 + * + * @see wp_list_comments() + * + * @param array $r An array of arguments for displaying comments. + */ + $r = apply_filters( 'wp_list_comments_args', $r ); + // Figure out what comments we'll be looping through ($_comments) if ( null !== $comments ) { $comments = (array) $comments; if ( empty($comments) ) return; if ( 'all' != $r['type'] ) { - $comments_by_type = &separate_comments($comments); + $comments_by_type = separate_comments($comments); if ( empty($comments_by_type[$r['type']]) ) return; $_comments = $comments_by_type[$r['type']]; @@ -1443,17 +1931,36 @@ function wp_list_comments($args = array(), $comments = null ) { return; if ( 'all' != $r['type'] ) { if ( empty($wp_query->comments_by_type) ) - $wp_query->comments_by_type = &separate_comments($wp_query->comments); + $wp_query->comments_by_type = separate_comments($wp_query->comments); if ( empty($wp_query->comments_by_type[$r['type']]) ) return; $_comments = $wp_query->comments_by_type[$r['type']]; } else { $_comments = $wp_query->comments; } + + // Pagination is already handled by `WP_Comment_Query`, so we tell Walker not to bother. + if ( $wp_query->max_num_comment_pages ) { + $default_comments_page = get_option( 'default_comments_page' ); + $cpage = get_query_var( 'cpage' ); + if ( 'newest' === $default_comments_page ) { + $r['cpage'] = $cpage; + + // When first page shows oldest comments, post permalink is the same as the comment permalink. + } elseif ( $cpage == 1 ) { + $r['cpage'] = ''; + } else { + $r['cpage'] = $cpage; + } + + $r['page'] = 0; + $r['per_page'] = 0; + } } - if ( '' === $r['per_page'] && get_option('page_comments') ) + if ( '' === $r['per_page'] && get_option( 'page_comments' ) ) { $r['per_page'] = get_query_var('comments_per_page'); + } if ( empty($r['per_page']) ) { $r['per_page'] = 0; @@ -1484,19 +1991,26 @@ function wp_list_comments($args = array(), $comments = null ) { if ( null === $r['reverse_top_level'] ) $r['reverse_top_level'] = ( 'desc' == get_option('comment_order') ); - extract( $r, EXTR_SKIP ); - - if ( empty($walker) ) + if ( empty( $r['walker'] ) ) { $walker = new Walker_Comment; + } else { + $walker = $r['walker']; + } - $walker->paged_walk($_comments, $max_depth, $page, $per_page, $r); - $wp_query->max_num_comment_pages = $walker->max_pages; + $output = $walker->paged_walk( $_comments, $r['max_depth'], $r['page'], $r['per_page'], $r ); $in_comment_loop = false; + + if ( $r['echo'] ) { + echo $output; + } else { + return $output; + } } /** - * Outputs a complete commenting form for use within a template. + * Output a complete commenting form for use within a template. + * * Most strings and form fields may be controlled through the $args array passed * into the function, while you may also choose to use the comment_form_default_fields * filter to modify the array of default fields if you'd just like to add a new @@ -1505,88 +2019,332 @@ function wp_list_comments($args = array(), $comments = null ) { * in the array of fields. * * @since 3.0.0 - * @param array $args Options for strings, fields etc in the form - * @param mixed $post_id Post ID to generate the form for, uses the current post if null - * @return void + * @since 4.1.0 Introduced the 'class_submit' argument. + * @since 4.2.0 Introduced the 'submit_button' and 'submit_fields' arguments. + * @since 4.4.0 Introduced the 'class_form', 'title_reply_before', 'title_reply_after', + * 'cancel_reply_before', and 'cancel_reply_after' arguments. + * + * @param array $args { + * Optional. Default arguments and form fields to override. + * + * @type array $fields { + * Default comment fields, filterable by default via the 'comment_form_default_fields' hook. + * + * @type string $author Comment author field HTML. + * @type string $email Comment author email field HTML. + * @type string $url Comment author URL field HTML. + * } + * @type string $comment_field The comment textarea field HTML. + * @type string $must_log_in HTML element for a 'must be logged in to comment' message. + * @type string $logged_in_as HTML element for a 'logged in as [user]' message. + * @type string $comment_notes_before HTML element for a message displayed before the comment fields + * if the user is not logged in. + * Default 'Your email address will not be published.'. + * @type string $comment_notes_after HTML element for a message displayed after the textarea field. + * @type string $id_form The comment form element id attribute. Default 'commentform'. + * @type string $id_submit The comment submit element id attribute. Default 'submit'. + * @type string $class_form The comment form element class attribute. Default 'comment-form'. + * @type string $class_submit The comment submit element class attribute. Default 'submit'. + * @type string $name_submit The comment submit element name attribute. Default 'submit'. + * @type string $title_reply The translatable 'reply' button label. Default 'Leave a Reply'. + * @type string $title_reply_to The translatable 'reply-to' button label. Default 'Leave a Reply to %s', + * where %s is the author of the comment being replied to. + * @type string $title_reply_before HTML displayed before the comment form title. + * Default: '

'. + * @type string $title_reply_after HTML displayed after the comment form title. + * Default: '

'. + * @type string $cancel_reply_before HTML displayed before the cancel reply link. + * @type string $cancel_reply_after HTML displayed after the cancel reply link. + * @type string $cancel_reply_link The translatable 'cancel reply' button label. Default 'Cancel reply'. + * @type string $label_submit The translatable 'submit' button label. Default 'Post a comment'. + * @type string $submit_button HTML format for the Submit button. + * Default: ''. + * @type string $submit_field HTML format for the markup surrounding the Submit button and comment hidden + * fields. Default: '

%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. */ function comment_form( $args = array(), $post_id = null ) { - global $id; - if ( null === $post_id ) - $post_id = $id; - else - $id = $post_id; + $post_id = get_the_ID(); $commenter = wp_get_current_commenter(); $user = wp_get_current_user(); $user_identity = $user->exists() ? $user->display_name : ''; - $req = get_option( 'require_name_email' ); + $args = wp_parse_args( $args ); + if ( ! isset( $args['format'] ) ) + $args['format'] = current_theme_supports( 'html5', 'comment-form' ) ? 'html5' : 'xhtml'; + + $req = get_option( 'require_name_email' ); $aria_req = ( $req ? " aria-required='true'" : '' ); - $fields = array( - 'author' => '

' . ' ' . ( $req ? '*' : '' ) . - '

', - 'email' => '', - 'url' => '

' . - '

', + $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. + * + * @since 3.0.0 + * + * @param array $fields The default comment fields. + */ + $fields = apply_filters( 'comment_form_default_fields', $fields ); $defaults = array( - 'fields' => apply_filters( 'comment_form_default_fields', $fields ), - 'comment_field' => '

', + 'fields' => $fields, + 'comment_field' => '

', + /** This filter is documented in wp-includes/link-template.php */ 'must_log_in' => '', - 'logged_in_as' => '

' . sprintf( __( 'Logged in as %2$s. Log out?' ), admin_url( 'profile.php' ), $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' => '

' . sprintf( __( 'You may use these HTML tags and attributes: %s' ), ' ' . allowed_tags() . '' ) . '

', + /** 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' => '', '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' => '

', + 'title_reply_after' => '

', + 'cancel_reply_before' => ' ', + 'cancel_reply_after' => '', 'cancel_reply_link' => __( 'Cancel reply' ), 'label_submit' => __( 'Post Comment' ), + 'submit_button' => '', + 'submit_field' => '

%1$s %2$s

', + 'format' => 'xhtml', ); + /** + * Filter the comment form default arguments. + * + * Use 'comment_form_default_fields' to filter the comment fields. + * + * @since 3.0.0 + * + * @param array $defaults The default comment form arguments. + */ $args = wp_parse_args( $args, apply_filters( 'comment_form_defaults', $defaults ) ); - ?> - - -
-

- - - - -
- - - - - - - $field ) { - echo apply_filters( "comment_form_field_{$name}", $field ) . "\n"; + // Ensure that the filtered args contain all required default values. + $args = array_merge( $defaults, $args ); + + if ( comments_open( $post_id ) ) : ?> + +
+ + > + $args['comment_field'] ) + (array) $args['fields']; + + /** + * Filter the comment form fields. + * + * @since 4.4.0 + * + * @param array $comment_fields The comment fields. + */ + $comment_fields = apply_filters( 'comment_form_fields', $comment_fields ); + + // Get an array of field names, excluding the textarea + $comment_field_keys = array_diff( array_keys( $comment_fields ), array( 'comment' ) ); + + // Get the first and the last field name, excluding the textarea + $first_field = reset( $comment_field_keys ); + $last_field = end( $comment_field_keys ); + + foreach ( $comment_fields as $name => $field ) { + + if ( 'comment' === $name ) { + + /** + * Filter the content of the comment textarea field for display. + * + * @since 3.0.0 + * + * @param string $args_comment_field The content of the comment textarea field. + */ + echo apply_filters( 'comment_form_field_comment', $field ); + + echo $args['comment_notes_after']; + + } elseif ( ! is_user_logged_in() ) { + + if ( $first_field === $name ) { + /** + * Fires before the comment fields in the comment form, excluding the textarea. + * + * @since 3.0.0 + */ + do_action( 'comment_form_before_fields' ); + } + + /** + * Filter a comment form field for display. + * + * The dynamic portion of the filter hook, `$name`, refers to the name + * of the comment form field. Such as 'author', 'email', or 'url'. + * + * @since 3.0.0 + * + * @param string $field The HTML-formatted output of the comment form field. + */ + echo apply_filters( "comment_form_field_{$name}", $field ) . "\n"; + + if ( $last_field === $name ) { + /** + * Fires after the comment fields in the comment form, excluding the textarea. + * + * @since 3.0.0 + */ + do_action( 'comment_form_after_fields' ); } - do_action( 'comment_form_after_fields' ); - ?> - - - -

- - -

- - - -
- - - - - tag. + * + * @since 1.5.0 + * + * @param int $post_id The post ID. + */ + do_action( 'comment_form', $post_id ); + ?> + + +
+