* assumed.
*
* @since 1.5.0
- * @uses apply_filters() Calls 'get_comment_author' hook on the comment author
*
+ * @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() {
- global $comment;
- if ( empty($comment->comment_author) ) {
- if (!empty($comment->user_id)){
- $user=get_userdata($comment->user_id);
- $author=$user->user_login;
- } else {
+function get_comment_author( $comment_ID = 0 ) {
+ $comment = get_comment( $comment_ID );
+
+ 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.2
+ *
+ * @param string $author The comment author's username.
+ */
+ return apply_filters( 'get_comment_author', $author );
}
/**
* 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 Optional. The ID of the comment for which to print the author. Default current comment.
*/
-function comment_author() {
- $author = apply_filters('comment_author', get_comment_author() );
+function comment_author( $comment_ID = 0 ) {
+ $author = get_comment_author( $comment_ID );
+ /**
+ * Filter the comment author's name for display.
+ *
+ * @since 1.2.1
+ *
+ * @param string $author The comment author's username.
+ */
+ $author = apply_filters( 'comment_author', $author );
echo $author;
}
* 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 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() {
- global $comment;
- return apply_filters('get_comment_author_email', $comment->comment_author_email);
+function get_comment_author_email( $comment_ID = 0 ) {
+ $comment = get_comment( $comment_ID );
+ /**
+ * Filter the comment author's returned email address.
+ *
+ * @since 1.5.2
+ *
+ * @param string $comment->comment_author_email The comment author's email address.
+ */
+ return apply_filters( 'get_comment_author_email', $comment->comment_author_email );
}
/**
* 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 Optional. The ID of the comment for which to print the author's email. Default current comment.
*/
-function comment_author_email() {
- echo apply_filters('author_email', get_comment_author_email() );
+function comment_author_email( $comment_ID = 0 ) {
+ $author_email = get_comment_author_email( $comment_ID );
+ /**
+ * Filter the comment author's email for display.
+ *
+ * @since 1.2.1
+ *
+ * @param string $author_email The comment author's email address.
+ */
+ echo apply_filters( 'author_email', $author_email );
}
/**
* enable anyone, including those that people don't want to get the email
* address and use it for their own means good and bad.
*
- * @since 0.71
- * @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
+
+ * @since 0.71
*
- * @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. 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.
*/
-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;
}
* enable anyone, including those that people don't want to get the email
* address and use it for their own means good and bad.
*
+ * @global object $comment The current Comment row object.
+ *
* @since 2.7
- * @uses apply_filters() Calls 'comment_email' hook for the display of the comment author's email
- * @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. 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.
*/
-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 commentors' email address.
+ *
+ * @since 1.2.1
+ *
+ * @param string $comment->comment_author_email The comment author's email address.
+ */
+ $email = apply_filters( 'comment_email', $comment->comment_author_email );
if ((!empty($email)) && ($email != '@')) {
$display = ($linktext != '') ? $linktext : $email;
$return = $before;
}
/**
- * 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
*
- * @return string Comment Author name or HTML link for author's URL
+ * @param int $comment_ID Optional. 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() {
- /** @todo Only call these functions when they are needed. Include in if... else blocks */
- $url = get_comment_author_url();
- $author = get_comment_author();
+function get_comment_author_link( $comment_ID = 0 ) {
+ $url = get_comment_author_url( $comment_ID );
+ $author = get_comment_author( $comment_ID );
if ( empty( $url ) || 'http://' == $url )
$return = $author;
else
$return = "<a href='$url' rel='external nofollow' class='url'>$author</a>";
- return apply_filters('get_comment_author_link', $return);
+
+ /**
+ * Filter the comment author's link for display.
+ *
+ * @since 1.5.2
+ *
+ * @param string $return The HTML-formatted comment author link. Empty for an invalid URL.
+ */
+ return apply_filters( 'get_comment_author_link', $return );
}
/**
* Display the html link to the url of the author of the current comment.
*
* @since 0.71
- * @see get_comment_author_link() Echos result
+ * @see get_comment_author_link() Echoes result
+ *
+ * @param int $comment_ID Optional. The ID of the comment for which to print the author's link. Default current comment.
*/
-function comment_author_link() {
- echo get_comment_author_link();
+function comment_author_link( $comment_ID = 0 ) {
+ echo get_comment_author_link( $comment_ID );
}
/**
* Retrieve the IP address of the author of the current comment.
*
* @since 1.5.0
- * @uses $comment
- * @uses apply_filters()
*
- * @return unknown
+ * @param int $comment_ID Optional. The ID of the comment for which to get the author's IP address. Default current comment.
+ * @return string The comment author's IP address.
*/
-function get_comment_author_IP() {
- global $comment;
- return apply_filters('get_comment_author_IP', $comment->comment_author_IP);
+function get_comment_author_IP( $comment_ID = 0 ) {
+ $comment = get_comment( $comment_ID );
+
+ /**
+ * Filter the comment author's returned IP address.
+ *
+ * @since 1.5.2
+ *
+ * @param string $comment->comment_author_IP The comment author's IP address.
+ */
+ return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP );
}
/**
* Display the IP address of the author of the current comment.
*
* @since 0.71
- * @see get_comment_author_IP() Echos Result
+ *
+ * @param int $comment_ID Optional. The ID of the comment for which to print the author's IP address. Default current comment.
*/
-function comment_author_IP() {
- echo get_comment_author_IP();
+function comment_author_IP( $comment_ID = 0 ) {
+ echo 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
*
+ * @param int $comment_ID Optional. The ID of the comment for which to get the author's URL. Default current comment.
* @return string
*/
-function get_comment_author_url() {
- global $comment;
- return apply_filters('get_comment_author_url', $comment->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);
}
/**
* 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 Optional. The ID of the comment for which to print the author's URL. Default current comment.
*/
-function comment_author_url() {
- echo apply_filters('comment_url', get_comment_author_url());
+function comment_author_url( $comment_ID = 0 ) {
+ $author_url = get_comment_author_url( $comment_ID );
+ /**
+ * Filter the comment author's URL for display.
+ *
+ * @since 1.2.1
+ *
+ * @param string $author_url The comment author's URL.
+ */
+ echo apply_filters( 'comment_url', $author_url );
}
/**
* 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();
if ( '/' == substr($display, -1) )
$display = substr($display, 0, -1);
$return = "$before<a href='$url' rel='external'>$display</a>$after";
- return apply_filters('get_comment_author_url_link', $return);
+
+ /**
+ * Filter the comment author's returned URL link.
+ *
+ * @since 1.5.2
+ *
+ * @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() Echos 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. 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.
*/
function comment_author_url_link( $linktext = '', $before = '', $after = '' ) {
echo get_comment_author_url_link( $linktext, $before, $after );
*
* @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 Optional. Comment ID. Default current comment.
+ * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
+ * @param bool $echo Optional. Whether comment_class should echo or return. 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
*
* @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 Optional. Comment ID. Default current comment.
+ * @param int|WP_Post $post_id Optional. 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;
// 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'
- $classes[] = 'byuser comment-author-' . $user->user_nicename;
+ $classes[] = 'byuser';
+ $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 )
$classes = array_merge($classes, $class);
}
- return apply_filters('comment_class', $classes, $class, $comment_id, $post_id);
+ $classes = array_map('esc_attr', $classes);
+
+ /**
+ * 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 int|WP_Post $post_id The post ID or WP_Post object.
+ */
+ return apply_filters( 'comment_class', $classes, $class, $comment_id, $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)
- * @return string The comment's date
+ * @param string $d Optional. The format of the date. Default user's setting.
+ * @param int $comment_ID Optional. The ID of the comment for which to get the date. Default current comment.
+ * @return string The comment's date.
*/
-function get_comment_date( $d = '' ) {
- global $comment;
+function get_comment_date( $d = '', $comment_ID = 0 ) {
+ $comment = get_comment( $comment_ID );
if ( '' == $d )
- $date = mysql2date( get_option('date_format'), $comment->comment_date);
+ $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.2
+ *
+ * @param string|int $date Formatted date string or Unix timestamp.
+ * @param string $d The format of the date.
+ */
+ return apply_filters( 'get_comment_date', $date, $d );
}
/**
*
* @since 0.71
*
- * @param string $d The format of the date (defaults to user's config)
+ * @param string $d Optional. The format of the date. Default user's settings.
+ * @param int $comment_ID Optional. The ID of the comment for which to print the date. Default current comment.
*/
-function comment_date( $d = '' ) {
- echo get_comment_date( $d );
+function comment_date( $d = '', $comment_ID = 0 ) {
+ echo get_comment_date( $d, $comment_ID );
}
/**
* 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
*
- * @return string The maybe truncated comment with 20 words or less
+ * @param int $comment_ID Optional. The 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() {
- global $comment;
+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) {
for ($i=0; $i<$k; $i++) {
$excerpt .= $blah[$i] . ' ';
}
- $excerpt .= ($use_dotdotdot) ? '...' : '';
+ $excerpt .= ($use_dotdotdot) ? '…' : '';
return apply_filters('get_comment_excerpt', $excerpt);
}
* 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 Optional. The ID of the comment for which to print the excerpt. Default current comment.
*/
-function comment_excerpt() {
- echo apply_filters('comment_excerpt', get_comment_excerpt() );
+function comment_excerpt( $comment_ID = 0 ) {
+ $comment_excerpt = get_comment_excerpt($comment_ID);
+ /**
+ * Filter the comment excerpt for display.
+ *
+ * @since 1.2.1
+ *
+ * @param string $comment_excerpt The comment excerpt text.
+ */
+ echo apply_filters( 'comment_excerpt', $comment_excerpt );
}
/**
* 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.2
+ *
+ * @param int $comment->comment_ID The current comment ID.
+ */
+ return apply_filters( 'get_comment_ID', $comment->comment_ID );
}
/**
- * Displays the comment id of the current comment.
+ * Display the comment id of the current comment.
*
* @since 0.71
- * @see get_comment_ID() Echos Result
*/
function comment_ID() {
echo get_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.
- * @return string The permalink to the current comment
+ * @param mixed $comment Optional. Comment to retrieve. Default current comment.
+ * @param array $args Optional. An array of arguments to override the defaults. @see get_page_of_comment()
+ * @return string The permalink to the given comment.
*/
function get_comment_link( $comment = null, $args = array() ) {
global $wp_rewrite, $in_comment_loop;
$args['page'] = ( !empty($in_comment_loop) ) ? get_query_var('cpage') : get_page_of_comment( $comment->comment_ID, $args );
if ( $wp_rewrite->using_permalinks() )
- return user_trailingslashit( trailingslashit( get_permalink( $comment->comment_post_ID ) ) . 'comment-page-' . $args['page'], 'comment' ) . '#comment-' . $comment->comment_ID;
+ $link = user_trailingslashit( trailingslashit( get_permalink( $comment->comment_post_ID ) ) . 'comment-page-' . $args['page'], 'comment' );
else
- return add_query_arg( 'cpage', $args['page'], get_permalink( $comment->comment_post_ID ) ) . '#comment-' . $comment->comment_ID;
+ $link = add_query_arg( 'cpage', $args['page'], get_permalink( $comment->comment_post_ID ) );
} else {
- return get_permalink( $comment->comment_post_ID ) . '#comment-' . $comment->comment_ID;
+ $link = get_permalink( $comment->comment_post_ID );
}
+
+ $link = $link . '#comment-' . $comment->comment_ID;
+ /**
+ * Filter the returned single comment permalink.
+ *
+ * @since 2.8.0
+ *
+ * @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. @see get_page_of_comment()
+ */
+ 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
*
- * @return string The link to the comments
+ * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
+ * @return string The link to the comments.
*/
-function get_comments_link() {
- return get_permalink() . '#comments';
+function get_comments_link( $post_id = 0 ) {
+ $comments_link = get_permalink( $post_id ) . '#comments';
+ /**
+ * Filter the returned post comments permalink.
+ *
+ * @since
+ *
+ * @param string $comments_link The post comments permalink with '#comments' appended.
+ * @param int|WP_Post $post_id The 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 Not Used
+ * @param string $deprecated Not Used.
+ * @param bool $deprecated_2 Not Used.
*/
-function comments_link( $deprecated = '', $deprecated = '' ) {
- echo get_comments_link();
+function comments_link( $deprecated = '', $deprecated_2 = '' ) {
+ if ( !empty( $deprecated ) )
+ _deprecated_argument( __FUNCTION__, '0.72' );
+ if ( !empty( $deprecated_2 ) )
+ _deprecated_argument( __FUNCTION__, '1.3' );
+ 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 current post.
+ * @return int The number of comments a post has.
*/
function get_comments_number( $post_id = 0 ) {
- global $id;
- $post_id = (int) $post_id;
+ $post_id = absint( $post_id );
if ( !$post_id )
- $post_id = (int) $id;
+ $post_id = get_the_ID();
$post = get_post($post_id);
if ( ! isset($post->comment_count) )
else
$count = $post->comment_count;
- return apply_filters('get_comments_number', $count);
+ /**
+ * Filter the returned comment count for a post.
+ *
+ * @since 1.5.2
+ *
+ * @param int $count The number of comments a post has.
+ * @param int|WP_Post $post_id The post ID or WP_Post object.
+ */
+ 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 $id
- * @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 = '' ) {
- global $id;
- $number = get_comments_number($id);
+ if ( !empty( $deprecated ) )
+ _deprecated_argument( __FUNCTION__, '1.3' );
+
+ $number = get_comments_number();
if ( $number > 1 )
$output = str_replace('%', number_format_i18n($number), ( false === $more ) ? __('% Comments') : $more);
else // must be one
$output = ( false === $one ) ? __('1 Comment') : $one;
- echo apply_filters('comments_number', $output, $number);
+ /**
+ * Filter the comments count for display.
+ *
+ * @since 1.5.2
+ *
+ * @param string $output A translatable string formatted based on whether the count is equal to 0, 1, or 1+. @see _n()
+ * @param int $number The number of post comments.
+ */
+ echo apply_filters( 'comments_number', $output, $number );
}
/**
* Retrieve the text of the current comment.
*
* @since 1.5.0
- * @uses $comment
*
- * @return string The comment content
+ * @param int $comment_ID Optional. The ID of the comment for which to get the text. Default current comment.
+ * @param array $args Optional. An array of arguments. @see Walker_Comment::comment()
+ * @return string The comment content.
*/
-function get_comment_text() {
- global $comment;
- return apply_filters('get_comment_text', $comment->comment_content);
+function get_comment_text( $comment_ID = 0, $args = array() ) {
+ $comment = get_comment( $comment_ID );
+
+ /**
+ * Filter the text of a comment.
+ *
+ * @since 1.5.2
+ *
+ * @param string $comment->comment_content The text of the comment.
+ * @param object $comment The comment object.
+ * @param array $args An array of arguments. @see Walker_Comment::comment()
+ */
+ 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 Optional. The ID of the comment for which to print the text.
+ * Default 0.
+ * @param array $args Optional. An array of arguments. @see Walker_Comment::comment()
+ * Default empty array.
*/
-function comment_text() {
- echo apply_filters('comment_text', get_comment_text() );
+function comment_text( $comment_ID = 0, $args = array() ) {
+ $comment = get_comment( $comment_ID );
+
+ $comment_text = get_comment_text( $comment_ID , $args );
+ /**
+ * Filter the text of a comment to be displayed.
+ *
+ * @since 1.2.1
+ *
+ * @param string $comment_text The text of the current comment.
+ * @param object $comment The comment object.
+ * @param array $args An array of arguments. @see Walker_Comment::comment()
+ */
+ 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 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 ) {
+function get_comment_time( $d = '', $gmt = false, $translate = true ) {
global $comment;
- $comment_date = $gmt? $comment->comment_date_gmt : $comment->comment_date;
+ $comment_date = $gmt ? $comment->comment_date_gmt : $comment->comment_date;
if ( '' == $d )
- $date = mysql2date(get_option('time_format'), $comment_date);
+ $date = mysql2date(get_option('time_format'), $comment_date, $translate);
else
- $date = mysql2date($d, $comment_date);
- return apply_filters('get_comment_time', $date, $d, $gmt);
+ $date = mysql2date($d, $comment_date, $translate);
+
+ /**
+ * Filter the returned comment time.
+ *
+ * @since 1.5.2
+ *
+ * @param string|int $date The comment time, formatted as a date string or Unix timestamp.
+ * @param string $d The date format.
+ * @param bool $gmt Whether the GMT date is in use.
+ * @param bool $translate Whether the time is translated.
+ */
+ return apply_filters( 'get_comment_time', $date, $d, $gmt, $translate );
}
/**
*
* @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);
* 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 Optional. The ID of the comment for which to get the type. Default current comment.
* @return string The comment type
*/
-function get_comment_type() {
- global $comment;
-
+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.2
+ *
+ * @param string $comment->comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
+ */
+ return apply_filters( 'get_comment_type', $comment->comment_type );
}
/**
*
* @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. The string to display for comment type. Default false.
+ * @param string $trackbacktxt Optional. The string to display for trackback type. Default false.
+ * @param string $pingbacktxt Optional. The string to display for pingback type. Default false.
*/
-function comment_type($commenttxt = 'Comment', $trackbacktxt = 'Trackback', $pingbacktxt = 'Pingback') {
+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' );
$type = get_comment_type();
switch( $type ) {
case 'trackback' :
* 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
- * @uses $id
*
- * @return string The trackback URL after being filtered
+ * @return string The trackback URL after being filtered.
*/
function get_trackback_url() {
- global $id;
- if ( '' != get_option('permalink_structure') ) {
+ if ( '' != get_option('permalink_structure') )
$tb_url = trailingslashit(get_permalink()) . user_trailingslashit('trackback', 'single_trackback');
- } else {
- $tb_url = get_option('siteurl') . '/wp-trackback.php?p=' . $id;
- }
- return apply_filters('trackback_url', $tb_url);
+ else
+ $tb_url = get_option('siteurl') . '/wp-trackback.php?p=' . get_the_ID();
+
+ /**
+ * 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 Remove backwards compat in 2.5
+ * @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 = true) {
- if ($deprecated) echo get_trackback_url();
- else return get_trackback_url();
+function trackback_url( $deprecated_echo = true ) {
+ if ( $deprecated_echo !== true )
+ _deprecated_argument( __FUNCTION__, '2.5', __('Use <code>get_trackback_url()</code> instead if you do not want the value echoed.') );
+ if ( $deprecated_echo )
+ echo get_trackback_url();
+ 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 (stripos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') === false) {
- echo '<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
- xmlns:dc="http://purl.org/dc/elements/1.1/"
- xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/">
- <rdf:Description rdf:about="';
- the_permalink();
- echo '"'."\n";
- echo ' dc:identifier="';
- the_permalink();
- echo '"'."\n";
- echo ' dc:title="'.str_replace('--', '--', wptexturize(strip_tags(get_the_title()))).'"'."\n";
- echo ' trackback:ping="'.get_trackback_url().'"'." />\n";
- echo '</rdf:RDF>';
- }
+function trackback_rdf( $deprecated = '' ) {
+ if ( !empty( $deprecated ) )
+ _deprecated_argument( __FUNCTION__, '2.5' );
+
+ if ( false !== stripos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') )
+ return;
+
+ echo '<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+ xmlns:dc="http://purl.org/dc/elements/1.1/"
+ xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/">
+ <rdf:Description rdf:about="';
+ the_permalink();
+ echo '"'."\n";
+ echo ' dc:identifier="';
+ the_permalink();
+ echo '"'."\n";
+ echo ' dc:title="'.str_replace('--', '--', wptexturize(strip_tags(get_the_title()))).'"'."\n";
+ echo ' trackback:ping="'.get_trackback_url().'"'." />\n";
+ echo '</rdf:RDF>';
}
/**
* Whether the current post is open for comments.
*
* @since 1.5.0
- * @uses $post
*
- * @param int $post_id An optional post ID to check instead of the current post.
- * @return bool True if the comments are open
+ * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
+ * @return bool True if the comments are open.
*/
-function comments_open( $post_id=NULL ) {
+function comments_open( $post_id = null ) {
$_post = get_post($post_id);
$open = ( 'open' == $_post->comment_status );
+
+ /**
+ * Filter whether the current post is open for comments.
+ *
+ * @since
+ *
+ * @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 );
}
* 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 Optional. 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);
}
/**
- * 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.
* 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 = get_post();
+ $post_id = $post ? $post->ID : 0;
- $post_id = 0;
- if ( !empty($post) )
- $post_id = $post->ID;
-
- 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 "<script>(function(){if(window===window.parent){document.getElementById('_wp_unfiltered_html_comment_disabled').name='_wp_unfiltered_html_comment';}})();</script>\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.
*
* 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 $id
- * @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;
- if ( ! (is_single() || is_page() || $withcomments) )
+ if ( !(is_single() || is_page() || $withcomments) || empty($post) )
return;
if ( empty($file) )
$file = '/comments.php';
$req = get_option('require_name_email');
+
+ /**
+ * Comment author information fetched from the comment cookies.
+ *
+ * @uses wp_get_current_commenter()
+ */
$commenter = wp_get_current_commenter();
- extract($commenter, EXTR_SKIP);
+
+ /**
+ * The name of the current comment author escaped for use in attributes.
+ */
+ $comment_author = $commenter['comment_author']; // Escaped by sanitize_comment_cookies()
+
+ /**
+ * The email address of the current comment author escaped for use in attributes.
+ */
+ $comment_author_email = $commenter['comment_author_email']; // Escaped by sanitize_comment_cookies()
+
+ /**
+ * 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", $post->ID, $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 = $wpdb->get_results($wpdb->prepare("SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_approved = '1' ORDER BY comment_date", $post->ID));
+ $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", $post->ID, $comment_author, $comment_author_email));
+ $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));
}
// keep $comments for legacy's sake
+ /**
+ * Filter the comments array.
+ *
+ * @since 2.1.0
+ *
+ * @param array $comments The array of comments supplied to the comments template.
+ * @param int $post->ID The 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;
}
- define('COMMENTS_TEMPLATE', true);
+ 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.2
+ *
+ * @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 );
- else
- require( get_theme_root() . '/default/comments.php');
+ 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.
* 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 or not. 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)) {
* 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 $id
- * @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. The string to display when no comments. Default false.
+ * @param string $one Optional. The string to display when only one comment is available. Default false.
+ * @param string $more Optional. The string to display when there are more than one comment. Default false.
+ * @param string $css_class Optional. The CSS class to use for comments. Default empty.
+ * @param string $none Optional. The 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 = 'No Comments', $one = '1 Comment', $more = '% Comments', $css_class = '', $none = 'Comments Off' ) {
- global $id, $wpcommentspopupfile, $wpcommentsjavascript, $post;
+function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) {
+ global $wpcommentspopupfile, $wpcommentsjavascript;
- if ( is_single() || is_page() )
- return;
+ $id = get_the_ID();
+
+ if ( false === $zero ) $zero = __( 'No Comments' );
+ if ( false === $one ) $one = __( '1 Comment' );
+ if ( false === $more ) $more = __( '% Comments' );
+ if ( false === $none ) $none = __( 'Comments Off' );
$number = get_comments_number( $id );
- if ( 0 == $number && 'closed' == $post->comment_status && 'closed' == $post->ping_status ) {
- echo '<span' . ((!empty($css_class)) ? ' class="' . $css_class . '"' : '') . '>' . $none . '</span>';
+ if ( 0 == $number && !comments_open() && !pings_open() ) {
+ echo '<span' . ((!empty($css_class)) ? ' class="' . esc_attr( $css_class ) . '"' : '') . '>' . $none . '</span>';
return;
}
if ( post_password_required() ) {
- echo __('Enter your password to view comments');
+ echo __('Enter your password to view comments.');
return;
}
echo '<a href="';
if ( $wpcommentsjavascript ) {
if ( empty( $wpcommentspopupfile ) )
- $home = get_option('home');
+ $home = home_url();
else
$home = get_option('siteurl');
echo $home . '/' . $wpcommentspopupfile . '?comments_popup=' . $id;
if ( !empty( $css_class ) ) {
echo ' class="'.$css_class.'" ';
}
- $title = attribute_escape( get_the_title() );
+ $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="' . sprintf( __('Comment on %s'), $title ) . '">';
- comments_number( $zero, $one, $more, $number );
+ echo ' title="' . esc_attr( sprintf( __('Comment on %s'), $title ) ) . '">';
+ comments_number( $zero, $one, $more );
echo '</a>';
}
/**
* 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 Optional. Comment being replied to. Default current comment.
+ * @param int|WP_Post $post Optional. 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 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' => '');
+ $defaults = array(
+ 'add_below' => 'comment',
+ 'respond_id' => 'respond',
+ 'reply_text' => __('Reply'),
+ 'login_text' => __('Log in to Reply'),
+ 'depth' => 0,
+ 'before' => '',
+ 'after' => ''
+ );
$args = wp_parse_args($args, $defaults);
extract($args, EXTR_SKIP);
$comment = get_comment($comment);
+ if ( empty($post) )
+ $post = $comment->comment_post_ID;
$post = get_post($post);
- if ( 'open' != $post->comment_status )
+ if ( !comments_open($post->ID) )
return false;
$link = '';
- if ( get_option('comment_registration') && !$user_ID )
- $link = '<a rel="nofollow" href="' . site_url('wp-login.php?redirect_to=' . get_permalink()) . '">' . $login_text . '</a>';
+ if ( get_option('comment_registration') && ! is_user_logged_in() )
+ $link = '<a rel="nofollow" class="comment-reply-login" href="' . esc_url( wp_login_url( get_permalink() ) ) . '">' . $login_text . '</a>';
else
- $link = "<a rel='nofollow' class='comment-reply-link' href='" . wp_specialchars( add_query_arg( 'replytocom', $comment->comment_ID ) ) . "#" . $respond_id . "' onclick='return addComment.moveForm(\"$add_below-$comment->comment_ID\", \"$comment->comment_ID\", \"$respond_id\", \"$post->ID\")'>$reply_text</a>";
- return apply_filters('comment_reply_link', $before . $link . $after, $args, $comment, $post);
+ $link = "<a class='comment-reply-link' href='" . esc_url( add_query_arg( 'replytocom', $comment->comment_ID ) ) . "#" . $respond_id . "' onclick='return addComment.moveForm(\"$add_below-$comment->comment_ID\", \"$comment->comment_ID\", \"$respond_id\", \"$post->ID\")'>$reply_text</a>";
+
+ /**
+ * Filter the comment reply link.
+ *
+ * @since 2.7.0
+ *
+ * @param string $before Text or HTML displayed before the reply link.
+ * @param string $link The HTML markup for the comment reply link.
+ * @param string $after Text or HTML displayed after the 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', $before . $link . $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.
+ * @param array $args Optional. Override default options, @see get_comment_reply_link()
+ * @param int $comment Optional. Comment being replied to. Default current comment.
+ * @param int|WP_Post $post Optional. 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);
/**
* 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.
+ * @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 is 'respond'.
+ * @type string 'reply_text' The text of the Reply link. Default is 'Leave a Comment'.
+ * @type string 'login_text' The text of the link to reply if logged out. Default is 'Log in to leave a Comment'.
+ * @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_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post.
* @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
*/
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) )
return false;
- if ( get_option('comment_registration') && !$user_ID ) {
- $link = '<a rel="nofollow" href="' . site_url('wp-login.php?redirect_to=' . get_permalink()) . '">' . $login_text . '</a>';
- } else {
+ if ( get_option('comment_registration') && ! is_user_logged_in() )
+ $link = '<a rel="nofollow" href="' . wp_login_url( get_permalink() ) . '">' . $login_text . '</a>';
+ else
$link = "<a rel='nofollow' class='comment-reply-link' href='" . get_permalink($post->ID) . "#$respond_id' onclick='return addComment.moveForm(\"$add_below-$post->ID\", \"0\", \"$respond_id\", \"$post->ID\")'>$reply_text</a>";
- }
- return apply_filters('post_comments_link', $before . $link . $after, $post);
+
+ $formatted_link = $before . $link . $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, @see get_post_reply_link()
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post.
* @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
*/
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 = wp_specialchars( remove_query_arg('replytocom') ) . '#respond';
- return apply_filters('cancel_comment_reply_link', '<a rel="nofollow" id="cancel-comment-reply-link" href="' . $link . '"' . $style . '>' . $text . '</a>', $link, $text);
+ $link = esc_html( remove_query_arg('replytocom') ) . '#respond';
+
+ $formatted_link = '<a rel="nofollow" id="cancel-comment-reply-link" href="' . $link . '"' . $style . '>' . $text . '</a>';
+ /**
+ * 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 The cancel comment reply link URL.
+ * @param string $text The cancel comment reply link text.
+ */
+ return apply_filters( 'cancel_comment_reply_link', $formatted_link, $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);
}
/**
- * Output hidden input HTML for replying to comments.
+ * Retrieve hidden input HTML for replying to comments.
*
- * @since 2.7.0
+ * @since 3.0.0
+ *
+ * @param int $id Optional. Post ID. Default current post ID.
+ * @return string Hidden input HTML for replying to comments
*/
-function comment_id_fields() {
- global $id;
+function get_comment_id_fields( $id = 0 ) {
+ if ( empty( $id ) )
+ $id = get_the_ID();
$replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
- echo "<input type='hidden' name='comment_post_ID' value='$id' id='comment_post_ID' />\n";
- echo "<input type='hidden' name='comment_parent' id='comment_parent' value='$replytoid' />\n";
+ $result = "<input type='hidden' name='comment_post_ID' value='$id' id='comment_post_ID' />\n";
+ $result .= "<input type='hidden' name='comment_parent' id='comment_parent' value='$replytoid' />\n";
+
+ /**
+ * 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 );
}
/**
- * Display text based on comment reply status. Only affects users with Javascript disabled.
+ * Output hidden input HTML for replying to comments.
*
* @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 int $id Optional. Post ID. Default current post ID.
*/
-function comment_form_title( $noreplytext = 'Leave a Reply', $replytext = 'Leave a Reply to %s', $linktoparent = TRUE ) {
+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.
+ *
+ * @since 2.7.0
+ *
+ * @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;
+ if ( false === $noreplytext ) $noreplytext = __( 'Leave a Reply' );
+ if ( false === $replytext ) $replytext = __( 'Leave a Reply to %s' );
+
$replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
if ( 0 == $replytoid )
*
* @package WordPress
* @uses Walker
- * @since unknown
+ * @since 2.7.0
*/
class Walker_Comment extends Walker {
/**
+ * What the class handles.
+ *
* @see Walker::$tree_type
- * @since unknown
+ *
+ * @since 2.7.0
* @var string
*/
var $tree_type = 'comment';
/**
+ * DB fields to use.
+ *
* @see Walker::$db_fields
- * @since unknown
+ *
+ * @since 2.7.0
* @var array
*/
var $db_fields = array ('parent' => 'comment_parent', 'id' => 'comment_ID');
/**
+ * Start the list before the elements are added.
+ *
* @see Walker::start_lvl()
- * @since unknown
+ *
+ * @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) {
+ function start_lvl( &$output, $depth = 0, $args = array() ) {
$GLOBALS['comment_depth'] = $depth + 1;
switch ( $args['style'] ) {
case 'div':
break;
case 'ol':
- echo "<ol class='children'>\n";
+ echo '<ol class="children">' . "\n";
break;
default:
case 'ul':
- echo "<ul class='children'>\n";
+ echo '<ul class="children">' . "\n";
break;
}
}
/**
+ * End the list of items after the elements are added.
+ *
* @see Walker::end_lvl()
- * @since unknown
+ *
+ * @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) {
+ function end_lvl( &$output, $depth = 0, $args = array() ) {
$GLOBALS['comment_depth'] = $depth + 1;
switch ( $args['style'] ) {
case 'div':
break;
case 'ol':
- echo "</ol>\n";
+ echo "</ol><!-- .children -->\n";
break;
default:
case 'ul':
- echo "</ul>\n";
+ echo "</ul><!-- .children -->\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
+ * 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
+ *
+ * @see Walker::display_element()
+ *
+ * @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. @see wp_list_comments()
+ * @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, $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 ] );
+ }
+
+ }
+
+ /**
+ * Start the element output.
+ *
* @see Walker::start_el()
- * @since unknown
*
- * @param string $output Passed by reference. Used to append additional content.
+ * @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
+ * @param int $depth Depth of comment in reference to parents.
+ * @param array $args An array of arguments. @see wp_list_comments()
*/
- function start_el(&$output, $comment, $depth, $args) {
+ 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'] ) ) {
+ call_user_func( $args['callback'], $comment, $args, $depth );
return;
}
- $GLOBALS['comment'] = $comment;
- extract($args, EXTR_SKIP);
+ if ( ( 'pingback' == $comment->comment_type || 'trackback' == $comment->comment_type ) && $args['short_ping'] ) {
+ $this->ping( $comment, $depth, $args );
+ } elseif ( 'html5' === $args['format'] ) {
+ $this->html5_comment( $comment, $depth, $args );
+ } else {
+ $this->comment( $comment, $depth, $args );
+ }
+ }
+ /**
+ * Ends the element output, if needed.
+ *
+ * @see Walker::end_el()
+ *
+ * @since 2.7.0
+ *
+ * @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. @see wp_list_comments()
+ */
+ function end_el( &$output, $comment, $depth = 0, $args = array() ) {
+ if ( !empty( $args['end-callback'] ) ) {
+ call_user_func( $args['end-callback'], $comment, $args, $depth );
+ return;
+ }
+ if ( 'div' == $args['style'] )
+ echo "</div><!-- #comment-## -->\n";
+ else
+ echo "</li><!-- #comment-## -->\n";
+ }
+
+ /**
+ * Output a pingback comment.
+ *
+ * @access protected
+ * @since 3.6.0
+ *
+ * @param object $comment The comment object.
+ * @param int $depth Depth of comment.
+ * @param array $args An array of arguments. @see wp_list_comments()
+ */
+ protected function ping( $comment, $depth, $args ) {
+ $tag = ( 'div' == $args['style'] ) ? 'div' : 'li';
+?>
+ <<?php echo $tag; ?> id="comment-<?php comment_ID(); ?>" <?php comment_class(); ?>>
+ <div class="comment-body">
+ <?php _e( 'Pingback:' ); ?> <?php comment_author_link(); ?> <?php edit_comment_link( __( 'Edit' ), '<span class="edit-link">', '</span>' ); ?>
+ </div>
+<?php
+ }
+
+ /**
+ * Output a single comment.
+ *
+ * @access protected
+ * @since 3.6.0
+ *
+ * @param object $comment Comment to display.
+ * @param int $depth Depth of comment.
+ * @param array $args An array of arguments. @see wp_list_comments()
+ */
+ protected function comment( $comment, $depth, $args ) {
if ( 'div' == $args['style'] ) {
$tag = 'div';
$add_below = 'comment';
$add_below = 'div-comment';
}
?>
- <<?php echo $tag ?> <?php comment_class(empty( $args['has_children'] ) ? '' : 'parent') ?> id="comment-<?php comment_ID() ?>">
- <?php if ( 'ul' == $args['style'] ) : ?>
- <div id="div-comment-<?php comment_ID() ?>">
+ <<?php echo $tag; ?> <?php comment_class( empty( $args['has_children'] ) ? '' : 'parent' ); ?> id="comment-<?php comment_ID(); ?>">
+ <?php if ( 'div' != $args['style'] ) : ?>
+ <div id="div-comment-<?php comment_ID(); ?>" class="comment-body">
<?php endif; ?>
<div class="comment-author vcard">
- <?php if ($args['avatar_size'] != 0) echo get_avatar( $comment, $args['avatar_size'] ); ?>
- <?php printf(__('<cite class="fn">%s</cite> <span class="says">says:</span>'), get_comment_author_link()) ?>
+ <?php if ( 0 != $args['avatar_size'] ) echo get_avatar( $comment, $args['avatar_size'] ); ?>
+ <?php printf( __( '<cite class="fn">%s</cite> <span class="says">says:</span>' ), get_comment_author_link() ); ?>
</div>
-<?php if ($comment->comment_approved == '0') : ?>
- <em><?php _e('Your comment is awaiting moderation.') ?></em>
+ <?php if ( '0' == $comment->comment_approved ) : ?>
+ <em class="comment-awaiting-moderation"><?php _e( 'Your comment is awaiting moderation.' ) ?></em>
<br />
-<?php endif; ?>
+ <?php endif; ?>
- <div class="comment-meta commentmetadata"><a href="<?php echo htmlspecialchars( get_comment_link( $comment->comment_ID ) ) ?>"><?php printf(__('%1$s at %2$s'), get_comment_date(), get_comment_time()) ?></a><?php edit_comment_link(__('(Edit)'),' ','') ?></div>
+ <div class="comment-meta commentmetadata"><a href="<?php echo esc_url( get_comment_link( $comment->comment_ID ) ); ?>">
+ <?php
+ /* translators: 1: date, 2: time */
+ printf( __( '%1$s at %2$s' ), get_comment_date(), get_comment_time() ); ?></a><?php edit_comment_link( __( '(Edit)' ), ' ', '' );
+ ?>
+ </div>
- <?php comment_text() ?>
+ <?php comment_text( get_comment_id(), array_merge( $args, array( 'add_below' => $add_below, 'depth' => $depth, 'max_depth' => $args['max_depth'] ) ) ); ?>
<div class="reply">
- <?php comment_reply_link(array_merge( $args, array('add_below' => $add_below, 'depth' => $depth, 'max_depth' => $args['max_depth']))) ?>
+ <?php comment_reply_link( array_merge( $args, array( 'add_below' => $add_below, 'depth' => $depth, 'max_depth' => $args['max_depth'] ) ) ); ?>
</div>
- <?php if ( 'ul' == $args['style'] ) : ?>
+ <?php if ( 'div' != $args['style'] ) : ?>
</div>
<?php endif; ?>
<?php
}
/**
- * @see Walker::end_el()
- * @since unknown
+ * Output a comment in the HTML5 format.
*
- * @param string $output Passed by reference. Used to append additional content.
- * @param object $comment
- * @param int $depth Depth of comment.
- * @param array $args
+ * @access protected
+ * @since 3.6.0
+ *
+ * @param object $comment Comment to display.
+ * @param int $depth Depth of comment.
+ * @param array $args An array of arguments. @see wp_list_comments()
*/
- function end_el(&$output, $comment, $depth, $args) {
- if ( !empty($args['end-callback']) ) {
- call_user_func($args['end-callback'], $comment, $args, $depth);
- return;
- }
- if ( 'div' == $args['style'] )
- echo "</div>\n";
- else
- echo "</li>\n";
+ protected function html5_comment( $comment, $depth, $args ) {
+ $tag = ( 'div' === $args['style'] ) ? 'div' : 'li';
+?>
+ <<?php echo $tag; ?> id="comment-<?php comment_ID(); ?>" <?php comment_class( empty( $args['has_children'] ) ? '' : 'parent' ); ?>>
+ <article id="div-comment-<?php comment_ID(); ?>" class="comment-body">
+ <footer class="comment-meta">
+ <div class="comment-author vcard">
+ <?php if ( 0 != $args['avatar_size'] ) echo get_avatar( $comment, $args['avatar_size'] ); ?>
+ <?php printf( __( '%s <span class="says">says:</span>' ), sprintf( '<b class="fn">%s</b>', get_comment_author_link() ) ); ?>
+ </div><!-- .comment-author -->
+
+ <div class="comment-metadata">
+ <a href="<?php echo esc_url( get_comment_link( $comment->comment_ID ) ); ?>">
+ <time datetime="<?php comment_time( 'c' ); ?>">
+ <?php printf( _x( '%1$s at %2$s', '1: date, 2: time' ), get_comment_date(), get_comment_time() ); ?>
+ </time>
+ </a>
+ <?php edit_comment_link( __( 'Edit' ), '<span class="edit-link">', '</span>' ); ?>
+ </div><!-- .comment-metadata -->
+
+ <?php if ( '0' == $comment->comment_approved ) : ?>
+ <p class="comment-awaiting-moderation"><?php _e( 'Your comment is awaiting moderation.' ); ?></p>
+ <?php endif; ?>
+ </footer><!-- .comment-meta -->
+
+ <div class="comment-content">
+ <?php comment_text(); ?>
+ </div><!-- .comment-content -->
+
+ <div class="reply">
+ <?php comment_reply_link( array_merge( $args, array( 'add_below' => 'div-comment', 'depth' => $depth, 'max_depth' => $args['max_depth'] ) ) ); ?>
+ </div><!-- .reply -->
+ </article><!-- .comment-body -->
+<?php
}
-
}
/**
- * List comments
+ * 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
+ * @param string|array $args {
+ * Optional. Formatting options.
+ *
+ * @type string 'walker' The Walker class used 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.
+ * }
+ * @param array $comments Optional. Array of comment objects. @see WP_Query->comments
*/
-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;
$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,
+ );
$r = wp_parse_args( $args, $defaults );
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']];
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']];
if ( empty($overridden_cpage) ) {
$r['page'] = get_query_var('cpage');
} else {
- $threaded = ( -1 == $r['max_depth'] ) ? false : true;
+ $threaded = ( -1 != $r['max_depth'] );
$r['page'] = ( 'newest' == get_option('default_comments_page') ) ? get_comment_pages_count($_comments, $r['per_page'], $threaded) : 1;
set_query_var( 'cpage', $r['page'] );
}
$r['page'] = 1;
if ( null === $r['reverse_top_level'] )
- $r['reverse_top_level'] = ( 'desc' == get_option('comment_order') ) ? TRUE : FALSE;
+ $r['reverse_top_level'] = ( 'desc' == get_option('comment_order') );
extract( $r, EXTR_SKIP );
$in_comment_loop = false;
}
-?>
+/**
+ * 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
+ * one or remove a single field. All fields are also individually passed through
+ * a filter of the form comment_form_field_$name where $name is the key used
+ * in the array of fields.
+ *
+ * @since 3.0.0
+ *
+ * @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' The comment author field HTML.
+ * @type string 'email' The comment author email field HTML.
+ * @type string 'url' The 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 form.
+ * Default 'Your email address will not be published.'.
+ * @type string 'comment_notes_after' HTML element for a message displayed after the comment form.
+ * Default 'You may use these HTML tags and attributes ...'.
+ * @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 '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 '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 'format' The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'.
+ * }
+ * @param int|WP_Post $post_id Optional. Post ID or WP_Post object to generate the form for. Default current post.
+ */
+function comment_form( $args = array(), $post_id = null ) {
+ if ( null === $post_id )
+ $post_id = get_the_ID();
+ else
+ $id = $post_id;
+
+ $commenter = wp_get_current_commenter();
+ $user = wp_get_current_user();
+ $user_identity = $user->exists() ? $user->display_name : '';
+
+ $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'" : '' );
+ $html5 = 'html5' === $args['format'];
+ $fields = array(
+ 'author' => '<p class="comment-form-author">' . '<label for="author">' . __( 'Name' ) . ( $req ? ' <span class="required">*</span>' : '' ) . '</label> ' .
+ '<input id="author" name="author" type="text" value="' . esc_attr( $commenter['comment_author'] ) . '" size="30"' . $aria_req . ' /></p>',
+ 'email' => '<p class="comment-form-email"><label for="email">' . __( 'Email' ) . ( $req ? ' <span class="required">*</span>' : '' ) . '</label> ' .
+ '<input id="email" name="email" ' . ( $html5 ? 'type="email"' : 'type="text"' ) . ' value="' . esc_attr( $commenter['comment_author_email'] ) . '" size="30"' . $aria_req . ' /></p>',
+ 'url' => '<p class="comment-form-url"><label for="url">' . __( 'Website' ) . '</label> ' .
+ '<input id="url" name="url" ' . ( $html5 ? 'type="url"' : 'type="text"' ) . ' value="' . esc_attr( $commenter['comment_author_url'] ) . '" size="30" /></p>',
+ );
+
+ $required_text = sprintf( ' ' . __('Required fields are marked %s'), '<span class="required">*</span>' );
+
+ /**
+ * 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' => $fields,
+ 'comment_field' => '<p class="comment-form-comment"><label for="comment">' . _x( 'Comment', 'noun' ) . '</label> <textarea id="comment" name="comment" cols="45" rows="8" aria-required="true"></textarea></p>',
+ 'must_log_in' => '<p class="must-log-in">' . sprintf( __( 'You must be <a href="%s">logged in</a> to post a comment.' ), wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '</p>',
+ 'logged_in_as' => '<p class="logged-in-as">' . sprintf( __( 'Logged in as <a href="%1$s">%2$s</a>. <a href="%3$s" title="Log out of this account">Log out?</a>' ), get_edit_user_link(), $user_identity, wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '</p>',
+ 'comment_notes_before' => '<p class="comment-notes">' . __( 'Your email address will not be published.' ) . ( $req ? $required_text : '' ) . '</p>',
+ 'comment_notes_after' => '<p class="form-allowed-tags">' . sprintf( __( 'You may use these <abbr title="HyperText Markup Language">HTML</abbr> tags and attributes: %s' ), ' <code>' . allowed_tags() . '</code>' ) . '</p>',
+ 'id_form' => 'commentform',
+ 'id_submit' => 'submit',
+ 'title_reply' => __( 'Leave a Reply' ),
+ 'title_reply_to' => __( 'Leave a Reply to %s' ),
+ 'cancel_reply_link' => __( 'Cancel reply' ),
+ 'label_submit' => __( 'Post Comment' ),
+ '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 ) );
+
+ ?>
+ <?php if ( comments_open( $post_id ) ) : ?>
+ <?php
+ /**
+ * Fires before the comment form.
+ *
+ * @since 3.0.0
+ */
+ do_action( 'comment_form_before' );
+ ?>
+ <div id="respond" class="comment-respond">
+ <h3 id="reply-title" class="comment-reply-title"><?php comment_form_title( $args['title_reply'], $args['title_reply_to'] ); ?> <small><?php cancel_comment_reply_link( $args['cancel_reply_link'] ); ?></small></h3>
+ <?php if ( get_option( 'comment_registration' ) && !is_user_logged_in() ) : ?>
+ <?php echo $args['must_log_in']; ?>
+ <?php
+ /**
+ * Fires after the HTML-formatted 'must log in after' message in the comment form.
+ *
+ * @since 3.0.0
+ */
+ do_action( 'comment_form_must_log_in_after' );
+ ?>
+ <?php else : ?>
+ <form action="<?php echo site_url( '/wp-comments-post.php' ); ?>" method="post" id="<?php echo esc_attr( $args['id_form'] ); ?>" class="comment-form"<?php echo $html5 ? ' novalidate' : ''; ?>>
+ <?php
+ /**
+ * Fires at the top of the comment form, inside the <form> tag.
+ *
+ * @since 3.0.0
+ */
+ do_action( 'comment_form_top' );
+ ?>
+ <?php if ( is_user_logged_in() ) : ?>
+ <?php
+ /**
+ * Filter the 'logged in' message for the comment form for display.
+ *
+ * @since 3.0.0
+ *
+ * @param string $args['logged_in_as'] The logged-in-as HTML-formatted message.
+ * @param array $commenter An array containing the comment author's username, email, and URL.
+ * @param string $user_identity If the commenter is a registered user, the display name, blank otherwise.
+ */
+ echo apply_filters( 'comment_form_logged_in', $args['logged_in_as'], $commenter, $user_identity );
+ ?>
+ <?php
+ /**
+ * Fires after the is_user_logged_in() check in the comment form.
+ *
+ * @since 3.0.0
+ *
+ * @param array $commenter An array containing the comment author's username, email, and URL.
+ * @param string $user_identity If the commenter is a registered user, the display name, blank otherwise.
+ */
+ do_action( 'comment_form_logged_in_after', $commenter, $user_identity );
+ ?>
+ <?php else : ?>
+ <?php echo $args['comment_notes_before']; ?>
+ <?php
+ /**
+ * Fires before the comment fields in the comment form.
+ *
+ * @since 3.0.0
+ */
+ do_action( 'comment_form_before_fields' );
+ foreach ( (array) $args['fields'] as $name => $field ) {
+ /**
+ * 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";
+ }
+ /**
+ * Fires after the comment fields in the comment form.
+ *
+ * @since 3.0.0
+ */
+ do_action( 'comment_form_after_fields' );
+ ?>
+ <?php endif; ?>
+ <?php
+ /**
+ * 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', $args['comment_field'] );
+ ?>
+ <?php echo $args['comment_notes_after']; ?>
+ <p class="form-submit">
+ <input name="submit" type="submit" id="<?php echo esc_attr( $args['id_submit'] ); ?>" value="<?php echo esc_attr( $args['label_submit'] ); ?>" />
+ <?php comment_id_fields( $post_id ); ?>
+ </p>
+ <?php
+ /**
+ * Fires at the bottom of the comment form, inside the closing </form> tag.
+ *
+ * @since 1.5.2
+ *
+ * @param int $post_id The post ID.
+ */
+ do_action( 'comment_form', $post_id );
+ ?>
+ </form>
+ <?php endif; ?>
+ </div><!-- #respond -->
+ <?php
+ /**
+ * Fires after the comment form.
+ *
+ * @since 3.0.0
+ */
+ do_action( 'comment_form_after' );
+ else :
+ /**
+ * Fires after the comment form if comments are closed.
+ *
+ * @since 3.0.0
+ */
+ do_action( 'comment_form_comments_closed' );
+ endif;
+}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff