Changeset 30092

Timestamp:

10/29/2014 07:07:00 PM (12 years ago)

Author:

westi

Message:

Comment Template Tags: Improve the availability of context information in comment template tag filters.

Fixes #22380 props momo360modena, tareq1988.

File:

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

trunk/src/wp-includes/comment-template.php

@@ -37 +37 @@
          * @since 1.5.0
          *
-         * @param string $author The comment author's username.
-         */
-        return apply_filters( 'get_comment_author', $author );
+         * @param string $author     The comment author's username.
+         * @param int    $comment_ID The comment ID
+         * @param object $comment    The comment
+         */
+        return apply_filters( 'get_comment_author', $author, $comment_ID, $comment );
 }
 
@@ -57 +59 @@
          *
          * @param string $author The comment author's username.
-         */
-        $author = apply_filters( 'comment_author', $author );
+         * @param int    $comment_ID The comment ID
+         */
+        $author = apply_filters( 'comment_author', $author, $comment_ID );
         echo $author;
 }
@@ -78 +81 @@
          *
          * @param string $comment_author_email The comment author's email address.
-         */
-        return apply_filters( 'get_comment_author_email', $comment->comment_author_email );
+         * @param int    $comment_ID           The comment ID
+         * @param object $comment              The comment
+         */
+        return apply_filters( 'get_comment_author_email', $comment->comment_author_email, $comment_ID, $comment );
 }
 
@@ -103 +108 @@
          *
          * @param string $author_email The comment author's email address.
-         */
-        echo apply_filters( 'author_email', $author_email );
+         * @param int    $comment_ID   The comment ID
+         */
+        echo apply_filters( 'author_email', $author_email, $comment_ID );
 }
 
@@ -157 +163 @@
          *
          * @param string $comment_author_email The comment author's email address.
-         */
-        $email = apply_filters( 'comment_email', $comment->comment_author_email );
+         * @param object $comment              The comment
+         */
+        $email = apply_filters( 'comment_email', $comment->comment_author_email, $comment );
         if ((!empty($email)) && ($email != '@')) {
         $display = ($linktext != '') ? $linktext : $email;
@@ -196 +203 @@
          * @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 );
+         * @param string $return      The HTML-formatted comment author link.
+         *                            Empty for an invalid URL.
+         * @param int    $comment_ID  The comment ID
+         */
+        return apply_filters( 'get_comment_author_link', $return, $author, $comment_ID );
 }
 
@@ -234 +242 @@
          *
          * @param string $comment_author_IP The comment author's IP address.
-         */
-        return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP );
+         * @param int    $comment_ID        The comment ID
+         * @param object $comment           The comment
+         */
+        return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP, $comment_ID, $comment );
 }
 
@@ -268 +278 @@
          * @since 1.5.0
          *
-         * @param string $url The comment author's URL.
-         */
-        return apply_filters( 'get_comment_author_url', $url );
+         * @param string $url                   The comment author's URL.
+         * @param int    $comment_ID    The comment ID
+         * @param object $comment               The comment
+         */
+        return apply_filters( 'get_comment_author_url', $url, $comment_ID, $comment );
 }
 
@@ -289 +301 @@
          *
          * @param string $author_url The comment author's URL.
-         */
-        echo apply_filters( 'comment_url', $author_url );
+         * @param int    $comment_ID The comment ID
+         */
+        echo apply_filters( 'comment_url', $author_url, $comment_ID );
 }
 
@@ -318 +331 @@
         $display = str_replace( 'http://www.', '', $display );
         $display = str_replace( 'http://', '', $display );
-        if ( '/' == substr($display, -1) )
+
+        if ( '/' == substr($display, -1) ) {
                 $display = substr($display, 0, -1);
+        }
+
         $return = "$before<a href='$url' rel='external'>$display</a>$after";
 
@@ -446 +462 @@
          * @param string      $class      A comma-separated list of additional classes added to the list.
          * @param int         $comment_id The comment id.
+         * @param object          $comment    The comment
          * @param int|WP_Post $post_id    The post ID or WP_Post object.
          */
-        return apply_filters( 'comment_class', $classes, $class, $comment_id, $post_id );
+        return apply_filters( 'comment_class', $classes, $class, $comment_id, $comment, $post_id );
 }
 
@@ -507 +524 @@
         $comment_text = strip_tags($comment->comment_content);
         $blah = explode(' ', $comment_text);
+
         if (count($blah) > 20) {
                 $k = 20;
@@ -514 +532 @@
                 $use_dotdotdot = 0;
         }
+
         $excerpt = '';
         for ($i=0; $i<$k; $i++) {
@@ -525 +544 @@
          * @since 1.5.0
          *
-         * @param string $excerpt The comment excerpt text.
-         */
-        return apply_filters( 'get_comment_excerpt', $excerpt );
+         * @param string $excerpt               The comment excerpt text.
+         * @param int    $comment_ID    The comment ID
+         * @param object $comment               The comment
+         */
+        return apply_filters( 'get_comment_excerpt', $excerpt, $comment_ID, $comment );
 }
 
@@ -545 +566 @@
          * @since 1.2.0
          *
-         * @param string $comment_excerpt The comment excerpt text.
-         */
-        echo apply_filters( 'comment_excerpt', $comment_excerpt );
+         * @param string $comment_excerpt       The comment excerpt text.
+         * @param int    $comment_ID            The comment ID
+         */
+        echo apply_filters( 'comment_excerpt', $comment_excerpt, $comment_ID );
 }
 
@@ -564 +586 @@
          * @since 1.5.0
          *
-         * @param int $comment_ID The current comment ID.
-         */
-        return apply_filters( 'get_comment_ID', $comment->comment_ID );
+         * @param int           $comment_ID The current comment ID.
+         * @param object    $comment    The comment
+         */
+        return apply_filters( 'get_comment_ID', $comment->comment_ID, $comment );
 }
 
@@ -871 +894 @@
          * @since 1.5.0
          *
-         * @param string $comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
-         */
-        return apply_filters( 'get_comment_type', $comment->comment_type );
+         * @param string  $comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
+         * @param int     $comment_ID   The comment ID
+         * @param object  $comment      The comment
+         */
+        return apply_filters( 'get_comment_type', $comment->comment_type, $comment_ID, $comment );
 }