X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/3f5685912e89eb3b0534acd85aa0946b1ca2bbe3..ceb5a929e00123b4e224977c6b5a149f6431b250:/wp-includes/comment-template.php?ds=sidebyside
diff --git a/wp-includes/comment-template.php b/wp-includes/comment-template.php
index 321080af..9e59ce91 100644
--- a/wp-includes/comment-template.php
+++ b/wp-includes/comment-template.php
@@ -15,33 +15,49 @@
* 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.0
+ *
+ * @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.0
+ *
+ * @param string $author The comment author's username.
+ */
+ $author = apply_filters( 'comment_author', $author );
echo $author;
}
@@ -49,14 +65,20 @@ function comment_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.0
+ *
+ * @param string $comment->comment_author_email The comment author's email address.
+ */
+ return apply_filters( 'get_comment_author_email', $comment->comment_author_email );
}
/**
@@ -69,10 +91,19 @@ function get_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.0
+ *
+ * @param string $author_email The comment author's email address.
+ */
+ echo apply_filters( 'author_email', $author_email );
}
/**
@@ -84,16 +115,15 @@ function comment_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;
}
@@ -107,17 +137,27 @@ function comment_author_email_link($linktext='', $before='', $after='') {
* enable anyone, including those that people don't want to get the email
* address and use it for their own means good and bad.
*
+ * @global object $comment The current Comment row object.
+ *
* @since 2.7
- * @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.0
+ *
+ * @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;
@@ -130,83 +170,118 @@ 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
*
- * @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 = "$author";
- return apply_filters('get_comment_author_link', $return);
+
+ /**
+ * Filter the comment author's link for display.
+ *
+ * @since 1.5.0
+ *
+ * @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.0
+ *
+ * @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;
+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
+ *
+ * @param string $url The comment author's URL.
+ */
+ 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.0
+ *
+ * @param string $author_url The comment author's URL.
+ */
+ echo apply_filters( 'comment_url', $author_url );
}
/**
@@ -220,12 +295,11 @@ function comment_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();
@@ -235,18 +309,25 @@ function get_comment_author_url_link( $linktext = '', $before = '', $after = ''
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() 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 );
@@ -257,10 +338,10 @@ function 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
@@ -276,10 +357,10 @@ function comment_class( $class = '', $comment_id = null, $post_id = null, $echo
*
* @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;
@@ -340,26 +421,43 @@ 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 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);
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.
+ */
+ return apply_filters( 'get_comment_date', $date, $d );
}
/**
@@ -367,27 +465,27 @@ function get_comment_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) {
@@ -401,7 +499,7 @@ function get_comment_excerpt() {
for ($i=0; $i<$k; $i++) {
$excerpt .= $blah[$i] . ' ';
}
- $excerpt .= ($use_dotdotdot) ? '...' : '';
+ $excerpt .= ($use_dotdotdot) ? '…' : '';
return apply_filters('get_comment_excerpt', $excerpt);
}
@@ -409,31 +507,44 @@ function get_comment_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.0
+ *
+ * @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.0
+ *
+ * @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();
@@ -443,10 +554,9 @@ 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.
+ * @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() ) {
@@ -484,47 +594,69 @@ function get_comment_link( $comment = null, $args = array() ) {
$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
+ *
+ * @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) )
@@ -532,24 +664,32 @@ function get_comments_number( $post_id = 0 ) {
else
$count = $post->comment_count;
- return apply_filters('get_comments_number', $count, $post_id);
+ /**
+ * Filter the returned comment count for a post.
+ *
+ * @since 1.5.0
+ *
+ * @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);
@@ -558,43 +698,75 @@ function comments_number( $zero = false, $one = false, $more = false, $deprecate
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.0
+ *
+ * @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.0
+ *
+ * @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.0
+ *
+ * @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 bool $translate Whether to translate the time (for use in feeds)
+ * @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 ) {
@@ -604,7 +776,18 @@ 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 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 );
}
/**
@@ -612,7 +795,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);
@@ -622,18 +805,23 @@ 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 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.0
+ *
+ * @param string $comment->comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
+ */
+ return apply_filters( 'get_comment_type', $comment->comment_type );
}
/**
@@ -641,14 +829,14 @@ function get_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 = false, $trackbacktxt = false, $pingbacktxt = false) {
- if ( false === $commenttxt ) $commenttxt = _x( 'Comment', 'noun' );
- if ( false === $trackbacktxt ) $trackbacktxt = __( 'Trackback' );
- if ( false === $pingbacktxt ) $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' :
@@ -670,73 +858,94 @@ 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
- * @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 get_trackback_url()
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 '
' . + '
', + 'url' => '' . + '
', + ); + + $required_text = sprintf( ' ' . __('Required fields are marked %s'), '*' ); + + /** + * Filter the default comment form fields. + * + * @since 3.0.0 + * + * @param array $fields The default comment fields. + */ + $fields = apply_filters( 'comment_form_default_fields', $fields ); + $defaults = array( + 'fields' => $fields, + 'comment_field' => '', + 'must_log_in' => '
' . sprintf( __( 'You must be logged in to post a comment.' ), wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '
', + 'logged_in_as' => '' . sprintf( __( 'Logged in as %2$s. Log out?' ), get_edit_user_link(), $user_identity, wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '
', + 'comment_notes_before' => '' . __( 'Your email address will not be published.' ) . ( $req ? $required_text : '' ) . '
', + 'comment_notes_after' => ' ', + 'id_form' => 'commentform', + 'id_submit' => 'submit', + '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 ) ); + + ?> + + +