X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/fef8173b8c3bad08f495551e43cfdeac1cae6021..46588ee871246a923d972538dbc93b26f4fda932:/wp-includes/comment-template.php
diff --git a/wp-includes/comment-template.php b/wp-includes/comment-template.php
index d00c6599..c5e5c5f2 100644
--- a/wp-includes/comment-template.php
+++ b/wp-includes/comment-template.php
@@ -15,36 +15,55 @@
* assumed.
*
* @since 1.5.0
- * @uses apply_filters() Calls 'get_comment_author' hook on the comment author
*
- * @param int $comment_ID The ID of the comment for which to retrieve the author. Optional.
+ * @param int $comment_ID Optional. 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 object $comment The comment object.
+ */
+ return apply_filters( 'get_comment_author', $author, $comment_ID, $comment );
}
/**
* Displays the author of the current comment.
*
* @since 0.71
- * @uses apply_filters() Calls 'comment_author' on comment author before displaying
*
- * @param int $comment_ID The ID of the comment for which to print the author. Optional.
+ * @param int $comment_ID Optional. 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 ) );
+ $author = get_comment_author( $comment_ID );
+
+ /**
+ * 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.
+ */
+ $author = apply_filters( 'comment_author', $author, $comment_ID );
echo $author;
}
@@ -52,15 +71,24 @@ function comment_author( $comment_ID = 0 ) {
* 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
*
- * @param int $comment_ID The ID of the comment for which to get the author's email. Optional.
+ * @param int $comment_ID Optional. 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 object $comment The comment object.
+ */
+ return apply_filters( 'get_comment_author_email', $comment->comment_author_email, $comment_ID, $comment );
}
/**
@@ -73,12 +101,22 @@ 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
*
- * @param int $comment_ID The ID of the comment for which to print the author's email. Optional.
+ * @param int $comment_ID Optional. 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 ) );
+ $author_email = get_comment_author_email( $comment_ID );
+
+ /**
+ * 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_ID );
}
/**
@@ -91,15 +129,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,17 +149,31 @@ 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
+ * @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.
*/
-function get_comment_author_email_link($linktext='', $before='', $after='') {
+function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
global $comment;
- $email = apply_filters('comment_email', $comment->comment_author_email);
+
+ /**
+ * 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 object $comment The comment object.
+ */
+ $email = apply_filters( 'comment_email', $comment->comment_author_email, $comment );
if ((!empty($email)) && ($email != '@')) {
$display = ($linktext != '') ? $linktext : $email;
$return = $before;
@@ -136,16 +186,18 @@ 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
*
- * @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 $comment_ID 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 );
@@ -153,16 +205,30 @@ function get_comment_author_link( $comment_ID = 0 ) {
$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_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
*
- * @param int $comment_ID The ID of the comment for which to print the author's link. Optional.
+ * @param int $comment_ID 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,24 +238,34 @@ 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()
*
- * @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 $comment_ID 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 object $comment The comment object.
+ */
+ return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP, $comment_ID, $comment );
}
/**
* Display the IP address of the author of the current comment.
*
* @since 0.71
- * @see get_comment_author_IP() Echoes Result
*
- * @param int $comment_ID The ID of the comment for which to print the author's IP address. Optional.
+ * @param int $comment_ID 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 );
@@ -199,29 +275,50 @@ function comment_author_IP( $comment_ID = 0 ) {
* 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
*
- * @param int $comment_ID The ID of the comment for which to get the author's URL. Optional.
+ * @param int $comment_ID ID of the comment for which to get the author's URL.
+ * Default current comment.
* @return string
*/
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 object $comment The comment object.
+ */
+ return apply_filters( 'get_comment_author_url', $url, $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
*
- * @param int $comment_ID The ID of the comment for which to print the author's URL. Optional.
+ * @param int $comment_ID 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 ));
+ $author_url = get_comment_author_url( $comment_ID );
+
+ /**
+ * 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_ID );
}
/**
@@ -235,47 +332,64 @@ 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
+ * @param string|array $class Optional. One or more classes to add to the class list.
+ * Default empty.
+ * @param int $comment_id Comment ID. Default current comment.
+ * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
+ * @param bool $echo Optional. Whether to cho or return the output.
+ * Default true.
*/
function comment_class( $class = '', $comment_id = null, $post_id = null, $echo = true ) {
// Separates classes with a single space, collates classes for comment DIV
@@ -287,14 +401,14 @@ 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
*
- * @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 $comment_id Comment ID. 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;
@@ -306,15 +420,15 @@ function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {
// 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 +469,28 @@ 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 object $comment The comment
+ * @param int|WP_Post $post_id The post ID or WP_Post object.
+ */
+ return apply_filters( 'comment_class', $classes, $class, $comment_id, $comment, $post_id );
}
/**
* Retrieve the comment date of the current comment.
*
* @since 1.5.0
- * @uses apply_filters() Calls 'get_comment_date' hook with the formated date and the $d parameter respectively
- * @uses $comment
*
- * @param string $d The format of the date (defaults to user's config)
- * @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 $comment_ID 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,7 +498,16 @@ 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 object $comment The comment object.
+ */
+ return apply_filters( 'get_comment_date', $date, $d, $comment );
}
/**
@@ -383,8 +515,8 @@ function get_comment_date( $d = '', $comment_ID = 0 ) {
*
* @since 0.71
*
- * @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 $comment_ID 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,21 +525,21 @@ 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
*
- * @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 $comment_ID 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;
@@ -415,45 +547,75 @@ function get_comment_excerpt( $comment_ID = 0 ) {
$k = count($blah);
$use_dotdotdot = 0;
}
+
$excerpt = '';
for ($i=0; $i<$k; $i++) {
$excerpt .= $blah[$i] . ' ';
}
- $excerpt .= ($use_dotdotdot) ? '...' : '';
- return apply_filters('get_comment_excerpt', $excerpt);
+ $excerpt .= ($use_dotdotdot) ? '…' : '';
+
+ /**
+ * Filter the retrieved comment excerpt.
+ *
+ * @since 1.5.0
+ * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
+ *
+ * @param string $excerpt The comment excerpt text.
+ * @param int $comment_ID The comment ID.
+ * @param object $comment The comment object.
+ */
+ return apply_filters( 'get_comment_excerpt', $excerpt, $comment_ID, $comment );
}
/**
* Display the excerpt of the current comment.
*
* @since 1.2.0
- * @uses apply_filters() Calls 'comment_excerpt' hook before displaying excerpt
*
- * @param int $comment_ID The ID of the comment for which to print the excerpt. Optional.
+ * @param int $comment_ID 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_excerpt = get_comment_excerpt($comment_ID);
+
+ /**
+ * 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_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);
+
+ /**
+ * 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 object $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 +625,11 @@ function comment_ID() {
* Retrieve the link to a given comment.
*
* @since 1.5.0
- * @uses $comment
*
- * @param object|string|int $comment Comment to retrieve.
- * @param array $args Optional args.
+ * @see get_page_of_comment()
+ *
+ * @param mixed $comment Comment to retrieve. Default current comment.
+ * @param array $args Optional. An array of arguments to override the defaults.
* @return string The permalink to the given comment.
*/
function get_comment_link( $comment = null, $args = array() ) {
@@ -475,10 +638,8 @@ 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' => '' );
@@ -497,134 +658,210 @@ function get_comment_link( $comment = null, $args = array() ) {
$args['page'] = ( !empty($in_comment_loop) ) ? get_query_var('cpage') : get_page_of_comment( $comment->comment_ID, $args );
if ( $wp_rewrite->using_permalinks() )
- $link = user_trailingslashit( trailingslashit( get_permalink( $comment->comment_post_ID ) ) . 'comment-page-' . $args['page'], 'comment' );
+ $link = user_trailingslashit( trailingslashit( get_permalink( $comment->comment_post_ID ) ) . $wp_rewrite->comments_pagination_base . '-' . $args['page'], 'comment' );
else
$link = add_query_arg( 'cpage', $args['page'], get_permalink( $comment->comment_post_ID ) );
} else {
$link = get_permalink( $comment->comment_post_ID );
}
- return apply_filters( 'get_comment_link', $link . '#comment-' . $comment->comment_ID, $comment, $args );
+ $link = $link . '#comment-' . $comment->comment_ID;
+ /**
+ * Filter the returned single comment permalink.
+ *
+ * @since 2.8.0
+ *
+ * @see get_page_of_comment()
+ *
+ * @param string $link The comment permalink with '#comment-$id' appended.
+ * @param object $comment The current comment object.
+ * @param array $args An array of arguments to override the defaults.
+ */
+ return apply_filters( 'get_comment_link', $link, $comment, $args );
}
/**
- * Retrieves the link to the current post comments.
+ * Retrieve the link to the current post comments.
*
* @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 ) {
+ $comments_link = get_permalink( $post_id ) . '#comments';
+ /**
+ * 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 ) {
+ $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;
+ }
+ /**
+ * 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
*
- * @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 $comment_ID ID of the comment for which to get the text. Default current comment.
+ * @param array $args Optional. An array of arguments. Default empty.
+ * @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 object $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
*
- * @param int $comment_ID The ID of the comment for which to print the text. Optional.
+ * @see Walker_Comment::comment()
+ *
+ * @param int $comment_ID ID of the comment for which to print the text. Default 0.
+ * @param array $args Optional. An array of arguments. Default empty array. Default empty.
*/
-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_ID , $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 object $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;
@@ -633,7 +870,19 @@ function get_comment_time( $d = '', $gmt = false, $translate = true ) {
$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 object $comment The comment object.
+ */
+ return apply_filters( 'get_comment_time', $date, $d, $gmt, $translate, $comment );
}
/**
@@ -641,7 +890,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 +900,26 @@ 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
*
- * @param int $comment_ID The ID of the comment for which to get the type. Optional.
- * @return string The comment type
+ * @param int $comment_ID 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 object $comment The comment object.
+ */
+ return apply_filters( 'get_comment_type', $comment->comment_type, $comment_ID, $comment );
}
/**
@@ -670,11 +927,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,27 +956,33 @@ 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 )
@@ -731,20 +994,22 @@ function trackback_url( $deprecated_echo = true ) {
}
/**
- * 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,21 +1054,29 @@ 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 ) {
+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,21 +1088,19 @@ 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', false);
+ if ( current_user_can( 'unfiltered_html' ) ) {
+ wp_nonce_field( 'unfiltered-html-comment_' . $post_id, '_wp_unfiltered_html_comment_disabled', false );
+ echo "\n";
+ }
}
/**
- * 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.
@@ -832,19 +1111,19 @@ function wp_comment_form_unfiltered_html_nonce() {
*
* The $file path is passed through a filter hook called, 'comments_template'
* which includes the TEMPLATEPATH and $file combined. Tries the $filtered path
- * first and if it fails it will require the default comment themplate from the
+ * first and if it fails it will require the default comment template from the
* default theme. If either does not exist, then the WordPress process will be
* halted. It is advised for that reason, that the default theme is not deleted.
*
- * @since 1.5.0
- * @global array $comment List of comment objects for the current post
- * @uses $wpdb
- * @uses $post
+ * @todo Document globals
* @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
+ *
+ * @param string $file Optional. The file to load. Default '/comments.php'.
+ * @param bool $separate_comments Optional. Whether to separate the comments by comment type.
+ * Default false.
+ * @return null Returns null if no comments appear.
*/
function comments_template( $file = '/comments.php', $separate_comments = false ) {
global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_ID, $user_identity, $overridden_cpage;
@@ -857,68 +1136,89 @@ 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(
+ 'order' => 'ASC',
+ 'orderby' => 'comment_date_gmt',
+ 'status' => 'approve',
+ 'post_id' => $post->ID,
+ );
+
+ 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
+ $comments = get_comments( $comment_args );
+
+ /**
+ * 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, $post->ID );
$comments = &$wp_query->comments;
$wp_query->comment_count = count($wp_query->comments);
update_comment_cache($wp_query->comments);
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;
}
- $overridden_cpage = FALSE;
+ $overridden_cpage = false;
if ( '' == get_query_var('cpage') && get_option('page_comments') ) {
set_query_var( 'cpage', 'newest' == get_option('default_comments_page') ? get_comment_pages_count() : 1 );
- $overridden_cpage = TRUE;
+ $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 ) )
- require( TEMPLATEPATH . $file );
+ require( TEMPLATEPATH . $file );
else // Backward compat code will be removed in a future release
require( ABSPATH . WPINC . '/theme-compat/comments.php');
}
/**
- * 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.
@@ -926,15 +1226,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)) {
@@ -951,32 +1252,51 @@ 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
+ *
+ * @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.
* @return null Returns null on single posts and pages.
*/
function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) {
global $wpcommentspopupfile, $wpcommentsjavascript;
$id = get_the_ID();
+ $title = get_the_title();
+ $number = get_comments_number( $id );
- if ( false === $zero ) $zero = __( 'No Comments' );
- if ( false === $one ) $one = __( '1 Comment' );
- if ( false === $more ) $more = __( '% Comments' );
- if ( false === $none ) $none = __( 'Comments Off' );
+ if ( false === $zero ) {
+ /* translators: %s: post title */
+ $zero = sprintf( __( 'No Comments on %s' ), $title );
+ }
- $number = get_comments_number( $id );
+ if ( false === $one ) {
+ /* translators: %s: post title */
+ $one = sprintf( __( '1 Comment on %s' ), $title );
+ }
+
+ if ( false === $more ) {
+ /* translators: 1: Number of comments 2: post title */
+ $more = _n( '%1$s Comment on %2$s', '%1$s Comments on %2$s', $number );
+ $more = sprintf( $more, number_format_i18n( $number ), $title );
+ }
+
+ if ( false === $none ) {
+ /* translators: %s: post title */
+ $none = sprintf( __( 'Comments Off on %s' ), $title );
+ }
if ( 0 == $number && !comments_open() && !pings_open() ) {
echo '' . $none . '';
@@ -1007,11 +1327,18 @@ function comments_popup_link( $zero = false, $one = false, $more = false, $css_c
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 '';
}
@@ -1019,60 +1346,114 @@ 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.
+ * @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 $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 null|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;
+function get_comment_reply_link( $args = array(), $comment = null, $post = null ) {
- $defaults = array('add_below' => 'comment', 'respond_id' => 'respond', 'reply_text' => __('Reply'),
- 'login_text' => __('Log in to Reply'), 'depth' => 0, 'before' => '', 'after' => '');
+ $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);
+ }
- if ( !comments_open($post->ID) )
+ $post = get_post( $post );
+
+ if ( ! comments_open( $post->ID ) ) {
return false;
+ }
- $link = '';
+ /**
+ * Filter the comment reply link arguments.
+ *
+ * @since 4.1.0
+ *
+ * @param array $args Comment reply link arguments. See {@see get_comment_reply_link()}
+ * for more information on accepted arguments.
+ * @param object $comment The object of the comment being replied to.
+ * @param WP_Post $post The {@see WP_Post} object.
+ */
+ $args = apply_filters( 'comment_reply_link_args', $args, $comment, $post );
- if ( get_option('comment_registration') && !$user_ID )
- $link = '' . $login_text . '';
- 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);
+ if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) {
+ $link = sprintf( '%s',
+ 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 ) ) . "#" . $args['respond_id'],
+ $onclick,
+ esc_attr( sprintf( $args['reply_to_text'], $comment->comment_author ) ),
+ $args['reply_text']
+ );
+ }
+ /**
+ * 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);
@@ -1081,47 +1462,82 @@ 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( '%s',
+ 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) {
@@ -1133,15 +1549,26 @@ 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.
*/
-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 );
}
/**
@@ -1149,9 +1576,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);
}
@@ -1160,37 +1587,56 @@ 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 = get_the_ID();
+function get_comment_id_fields( $id = 0 ) {
+ if ( empty( $id ) )
+ $id = get_the_ID();
$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() {
- echo get_comment_id_fields();
+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 ) {
+function comment_form_title( $noreplytext = false, $replytext = false, $linktoparent = true ) {
global $comment;
if ( false === $noreplytext ) $noreplytext = __( 'Leave a Reply' );
@@ -1210,74 +1656,87 @@ function comment_form_title( $noreplytext = false, $replytext = false, $linktopa
/**
* HTML comment list class.
*
- * @package WordPress
* @uses Walker
* @since 2.7.0
*/
class Walker_Comment extends Walker {
/**
+ * What the class handles.
+ *
* @see Walker::$tree_type
+ *
* @since 2.7.0
* @var string
*/
- var $tree_type = 'comment';
+ public $tree_type = 'comment';
/**
+ * DB fields to use.
+ *
* @see Walker::$db_fields
+ *
* @since 2.7.0
* @var array
*/
- var $db_fields = array ('parent' => 'comment_parent', 'id' => 'comment_ID');
+ public $db_fields = array ('parent' => 'comment_parent', 'id' => 'comment_ID');
/**
+ * Start the list before the elements are added.
+ *
* @see Walker::start_lvl()
+ *
* @since 2.7.0
*
* @param string $output Passed by reference. Used to append additional content.
* @param int $depth Depth of comment.
* @param array $args Uses 'style' argument for type of HTML list.
*/
- function start_lvl(&$output, $depth, $args) {
+ public function start_lvl( &$output, $depth = 0, $args = array() ) {
$GLOBALS['comment_depth'] = $depth + 1;
switch ( $args['style'] ) {
case 'div':
break;
case 'ol':
- echo "\n";
+ $output .= '' . "\n";
break;
- default:
case 'ul':
- echo "
\n";
+ default:
+ $output .= '
' . "\n";
break;
}
}
/**
+ * End the list of items after the elements are added.
+ *
* @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'.
+ * @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, $args) {
+ public function end_lvl( &$output, $depth = 0, $args = array() ) {
$GLOBALS['comment_depth'] = $depth + 1;
switch ( $args['style'] ) {
case 'div':
break;
case 'ol':
- echo "
\n";
+ $output .= "\n";
break;
- default:
case 'ul':
- echo "\n";
+ default:
+ $output .= "\n";
break;
}
}
/**
+ * Traverse elements to create list from elements.
+ *
* 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
@@ -1294,8 +1753,20 @@ class Walker_Comment extends Walker {
* 2
* 2.2
*
+ * @see Walker::display_element()
+ * @see wp_list_comments()
+ *
+ * @since 2.7.0
+ *
+ * @param object $element Data object.
+ * @param array $children_elements List of elements to continue traversing.
+ * @param int $max_depth Max depth to traverse.
+ * @param int $depth Depth of current element.
+ * @param array $args An array of arguments.
+ * @param string $output Passed by reference. Used to append additional content.
+ * @return null Null on failure with no changes to parameters.
*/
- function display_element( $element, &$children_elements, $max_depth, $depth=0, $args, &$output ) {
+ public function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) {
if ( !$element )
return;
@@ -1317,26 +1788,106 @@ class Walker_Comment extends Walker {
}
/**
- * @see Walker::start_el()
+ * Start the element output.
+ *
* @since 2.7.0
*
- * @param string $output Passed by reference. Used to append additional content.
+ * @see Walker::start_el()
+ * @see wp_list_comments()
+ *
+ * @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
+ * @param int $depth Depth of comment in reference to parents.
+ * @param array $args An array of arguments.
*/
- function start_el(&$output, $comment, $depth, $args) {
+ public function start_el( &$output, $comment, $depth = 0, $args = array(), $id = 0 ) {
$depth++;
$GLOBALS['comment_depth'] = $depth;
+ $GLOBALS['comment'] = $comment;
- if ( !empty($args['callback']) ) {
- call_user_func($args['callback'], $comment, $args, $depth);
+ if ( !empty( $args['callback'] ) ) {
+ ob_start();
+ call_user_func( $args['callback'], $comment, $args, $depth );
+ $output .= ob_get_clean();
return;
}
- $GLOBALS['comment'] = $comment;
- extract($args, EXTR_SKIP);
+ if ( ( 'pingback' == $comment->comment_type || 'trackback' == $comment->comment_type ) && $args['short_ping'] ) {
+ ob_start();
+ $this->ping( $comment, $depth, $args );
+ $output .= ob_get_clean();
+ } elseif ( 'html5' === $args['format'] ) {
+ ob_start();
+ $this->html5_comment( $comment, $depth, $args );
+ $output .= ob_get_clean();
+ } else {
+ ob_start();
+ $this->comment( $comment, $depth, $args );
+ $output .= ob_get_clean();
+ }
+ }
+
+ /**
+ * Ends the element output, if needed.
+ *
+ * @since 2.7.0
+ *
+ * @see Walker::end_el()
+ * @see wp_list_comments()
+ *
+ * @param string $output Passed by reference. Used to append additional content.
+ * @param object $comment The comment object. Default current comment.
+ * @param int $depth Depth of comment.
+ * @param array $args An array of arguments.
+ */
+ public function end_el( &$output, $comment, $depth = 0, $args = array() ) {
+ if ( !empty( $args['end-callback'] ) ) {
+ ob_start();
+ call_user_func( $args['end-callback'], $comment, $args, $depth );
+ $output .= ob_get_clean();
+ return;
+ }
+ if ( 'div' == $args['style'] )
+ $output .= "\n";
+ else
+ $output .= "\n";
+ }
+ /**
+ * Output a pingback comment.
+ *
+ * @access protected
+ * @since 3.6.0
+ *
+ * @see wp_list_comments()
+ *
+ * @param object $comment The comment object.
+ * @param int $depth Depth of comment.
+ * @param array $args An array of arguments.
+ */
+ protected function ping( $comment, $depth, $args ) {
+ $tag = ( 'div' == $args['style'] ) ? 'div' : 'li';
+?>
+ < id="comment-" >
+