Changeset 12821

Timestamp:

01/25/2010 05:34:13 PM (15 years ago)

Author:

ryan

Message:

Add optional comment ID argument to comment template functions. Props filosofo. fixes #12006

File:

• trunk/wp-includes/comment-template.php (modified) (17 diffs)

trunk/wp-includes/comment-template.php

@@ -18 +18 @@
  * @uses apply_filters() Calls 'get_comment_author' hook on the comment author
  *
+ * @param int $comment_ID The ID of the comment for which to retrieve the author. Optional.
  * @return string The comment author
  */
-function get_comment_author() {
-    global $comment;
+function get_comment_author( $comment_ID = 0 ) {
+    $comment = get_comment( $comment_ID );
     if ( empty($comment->comment_author) ) {
         if (!empty($comment->user_id)){
@@ -40 +41 @@
  * @since 0.71
  * @uses apply_filters() Calls 'comment_author' on comment author before displaying
- */
-function comment_author() {
-    $author = apply_filters('comment_author', get_comment_author() );
+ * 
+ * @param int $comment_ID The ID of the comment for which to print the author. Optional.
+ */
+function comment_author( $comment_ID = 0 ) {
+    $author = apply_filters('comment_author', get_comment_author( $comment_ID ) );
     echo $author;
 }
@@ -53 +56 @@
  * @uses $comment
  *
+ * @param int $comment_ID The ID of the comment for which to get the author's email.  Optional.
  * @return string The current comment author's email
  */
-function get_comment_author_email() {
-    global $comment;
+function get_comment_author_email( $comment_ID = 0 ) {
+    $comment = get_comment( $comment_ID );
     return apply_filters('get_comment_author_email', $comment->comment_author_email);
 }
@@ -71 +75 @@
  * @since 0.71
  * @uses apply_filters() Calls 'author_email' hook on the author email
- */
-function comment_author_email() {
-    echo apply_filters('author_email', get_comment_author_email() );
+ *
+ * @param int $comment_ID The ID of the comment for which to print the author's email. Optional.
+ */
+function comment_author_email( $comment_ID = 0 ) {
+    echo apply_filters('author_email', get_comment_author_email( $comment_ID ) );
 }
 
@@ -136 +142 @@
  * @uses apply_filters() Calls 'get_comment_author_link' hook on the complete link HTML or author
  *
+ * @param int $comment_ID The ID of the comment for which to get the author's link.  Optional.
  * @return string Comment Author name or HTML link for author's URL
  */
-function get_comment_author_link() {
+function get_comment_author_link( $comment_ID = 0 ) {
     /** @todo Only call these functions when they are needed. Include in if... else blocks */
-    $url    = get_comment_author_url();
-    $author = get_comment_author();
+    $url    = get_comment_author_url( $comment_ID );
+    $author = get_comment_author( $comment_ID );
 
     if ( empty( $url ) || 'http://' == $url )
@@ -155 +162 @@
  * @since 0.71
  * @see get_comment_author_link() Echos result
- */
-function comment_author_link() {
-    echo get_comment_author_link();
+ *
+ * @param int The ID of the comment for which to print the author's link. Optional.
+ */
+function comment_author_link( $comment_ID = 0 ) {
+    echo get_comment_author_link( $comment_ID );
 }
 
@@ -167 +176 @@
  * @uses apply_filters()
  *
- * @return unknown
- */
-function get_comment_author_IP() {
-    global $comment;
+ * @param int $comment_ID The ID of the comment for which to get the author's IP address. Optional.
+ * @return string The comment author's IP address.
+ */
+function get_comment_author_IP( $comment_ID = 0 ) {
+    $comment = get_comment( $comment_ID );
     return apply_filters('get_comment_author_IP', $comment->comment_author_IP);
 }
@@ -179 +189 @@
  * @since 0.71
  * @see get_comment_author_IP() Echos Result
- */
-function comment_author_IP() {
-    echo get_comment_author_IP();
+ *
+ * @param int $comment_ID The ID of the comment for which to print the author's IP address.  Optional.
+ */
+function comment_author_IP( $comment_ID = 0 ) {
+    echo get_comment_author_IP( $comment_ID );
 }
 
@@ -190 +202 @@
  * @uses apply_filters() Calls 'get_comment_author_url' hook on the comment author's URL
  *
+ * @param int $comment_ID The ID of the comment for which to get the author's URL.  Optional.
  * @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') );
@@ -205 +218 @@
  * @uses apply_filters()
  * @uses get_comment_author_url() Retrieves the comment author's URL
- */
-function comment_author_url() {
-    echo apply_filters('comment_url', get_comment_author_url());
+ *
+ * @param int $comment_ID The ID of the comment for which to print the author's URL. Optional.
+ */
+function comment_author_url( $comment_ID = 0 ) {
+    echo apply_filters('comment_url', get_comment_author_url( $comment_ID ));
 }
 
@@ -352 +367 @@
  *
  * @param string $d The format of the date (defaults to user's config)
+ * @param int $comment_ID The ID of the comment for which to get the date. Optional.
  * @return string The comment's date
  */
-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);
@@ -369 +385 @@
  *
  * @param string $d The format of the date (defaults to user's config)
- */
-function comment_date( $d = '' ) {
-    echo get_comment_date( $d );
+ * @param int $comment_ID The ID of the comment for which to print the date.  Optional.
+ */
+function comment_date( $d = '', $comment_ID = 0 ) {
+    echo get_comment_date( $d, $comment_ID );
 }
 
@@ -385 +402 @@
  * @uses apply_filters() Calls 'get_comment_excerpt' on truncated comment
  *
+ * @param int $comment_ID The ID of the comment for which to get the excerpt. Optional.
  * @return string The maybe truncated comment with 20 words or less
  */
-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);
@@ -411 +429 @@
  * @since 1.2.0
  * @uses apply_filters() Calls 'comment_excerpt' hook before displaying excerpt
- */
-function comment_excerpt() {
+ *
+ * @param int $comment_ID The ID of the comment for which to print the excerpt. Optional.
+ */
+function comment_excerpt( $comment_ID = 0 ) {
     echo apply_filters('comment_excerpt', get_comment_excerpt() );
 }
@@ -576 +596 @@
  * @uses $comment
  *
+ * @param int $comment_ID The ID of the comment for which to get the text. Optional.
  * @return string The comment content
  */
-function get_comment_text() {
-    global $comment;
+function get_comment_text( $comment_ID = 0 ) {
+    $comment = get_comment( $comment_ID );
     return apply_filters('get_comment_text', $comment->comment_content);
 }
@@ -589 +610 @@
  * @uses apply_filters() Passes the comment content through the 'comment_text' hook before display
  * @uses get_comment_text() Gets the comment content
- */
-function comment_text() {
+ *
+ * @param int $comment_ID The ID of the comment for which to print the text. Optional.
+ */
+function comment_text( $comment_ID = 0 ) {
     echo apply_filters('comment_text', get_comment_text() );
 }
@@ -634 +657 @@
  * @uses apply_filters() Calls the 'get_comment_type' hook on the comment type
  *
+ * @param int $comment_ID The ID of the comment for which to get the type. Optional.
  * @return string The comment type
  */
-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';