Ticket #38925: 38925.2.patch

src/wp-includes/comment-template.php

@@ -1565 +1565 @@
 /**
  * Retrieve HTML content for reply to comment link.
  *
- * @since 2.7.0
+ * @since 2.7.0 
  * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object.
+ * @since 4.9.0 Added the `$limit_by_depth` argument, whether to hide the link at the max depth and below.
  *
  * @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    $max_depth  The max depth of the comment tree. Default 0.
- *     @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.
+ *     @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    $max_depth      The max depth of the comment tree. Default 0.
+ *     @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.
+ *     @type bool   $limit_by_depth Hide the link at the max depth and below. Default true.
  * }
  * @param int|WP_Comment $comment Comment being replied to. Default current comment.
  * @param int|WP_Post    $post    Post ID or WP_Post object the comment is going to be displayed on.
@@ -1592 +1594 @@
  */
 function get_comment_reply_link( $args = array(), $comment = null, $post = null ) {
         $defaults = array(
-                'add_below'     => 'comment',
-                'respond_id'    => 'respond',
-                'reply_text'    => __( 'Reply' ),
+                'add_below'             => 'comment',
+                'respond_id'            => 'respond',
+                'reply_text'            => __( 'Reply' ),
                 /* translators: Comment reply button text. 1: Comment author name */
-                'reply_to_text' => __( 'Reply to %s' ),
-                'login_text'    => __( 'Log in to Reply' ),
-                'max_depth'     => 0,
-                'depth'         => 0,
-                'before'        => '',
-                'after'         => ''
+                'reply_to_text'         => __( 'Reply to %s' ),
+                'login_text'            => __( 'Log in to Reply' ),
+                'max_depth'             => 0,
+                'depth'                 => 0,
+                'before'                => '',
+                'after'                 => '',
+                'limit_by_depth'        => true,
         );
 
         $args = wp_parse_args( $args, $defaults );
 
-        if ( 0 == $args['depth'] || $args['max_depth'] <= $args['depth'] ) {
+        $depth = $args['depth'];
+
+        if ( 0 == $depth ) {
                 return;
         }
 
+        /**
+         * Filters the comment reply link arguments.
+         *
+         * @since 4.1.0
+         *
+         * @param array      $args    Comment reply link arguments. See get_comment_reply_link()
+         *                            for more information on accepted arguments.
+         * @param WP_Comment $comment The object of the comment being replied to.
+         * @param WP_Post    $post    The WP_Post object.
+         */
+        $args = apply_filters( 'comment_reply_link_args', $args, $comment, $post );
+
+        if ( $args['limit_by_depth'] && ( $args['max_depth'] <= $depth ) ) {
+                return;
+        }
+
         $comment = get_comment( $comment );
 
+        if( empty( $comment ) ) {
+                 return;
+        }
+
         if ( empty( $post ) ) {
                 $post = $comment->comment_post_ID;
         }
@@ -1622 +1647 @@
                 return false;
         }
 
-        /**
-         * Filters the comment reply link arguments.
-         *
-         * @since 4.1.0
-         *
-         * @param array      $args    Comment reply link arguments. See get_comment_reply_link()
-         *                            for more information on accepted arguments.
-         * @param WP_Comment $comment The object of the comment being replied to.
-         * @param WP_Post    $post    The WP_Post object.
-         */
-        $args = apply_filters( 'comment_reply_link_args', $args, $comment, $post );
-
         if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) {
                 $link = sprintf( '<a rel="nofollow" class="comment-reply-login" href="%s">%s</a>',
                         esc_url( wp_login_url( get_permalink() ) ),

tests/phpunit/tests/comment/getCommentReplyLink.php

@@ -26 +26 @@
 
                 $this->assertNull( get_comment_reply_link( $args ) );
         }
+
+        /**
+         * @ticket 38925
+         */
+        public function test_should_return_reply_link_when_limit_by_depth_is_false_and_max_depth_less_than_depth() {
+
+                $post_id    = self::factory()->post->create();
+                $comment_id = self::factory()->comment->create( array( 'comment_post_ID' => $post_id, 'comment_approved' => '1' ) );
+             
+                $args = array(                        
+                        'depth'                 => 5,
+                        'max_depth'             => 4,
+                        'limit_by_depth'        => false,
+                );
+                
+                $this->assertContains( 'replytocom', get_comment_reply_link( $args, $comment_id ) );        
+        }
+
+        /**         
+         * @ticket 38925
+         */        
+        public function test_should_return_reply_link_when_limit_by_depth_is_true_and_depth_less_than_max_depth() {
+                
+                $post_id    = self::factory()->post->create();
+                $comment_id = self::factory()->comment->create( array( 'comment_post_ID' => $post_id, 'comment_approved' => '1' ) );
+                
+                $args = array(
+                        'depth'                 => 4,
+                        'max_depth'             => 5,
+                        'limit_by_depth'        => true,                
+                );
+
+                $this->assertContains( 'replytocom', get_comment_reply_link( $args, $comment_id ) );
+        }
+
+        /**         
+         * @ticket 38925
+         */        
+        public function test_should_return_false_on_post_with_closed_comment_status() {
+                
+                $post_id    = self::factory()->post->create( array( 'comment_status' => 'closed' ) );
+                $comment_id = self::factory()->comment->create( array( 'comment_post_ID' => $post_id, 'comment_approved' => '1' ) );
+
+                $args = array(
+                        'depth'                 => 4,
+                        'max_depth'             => 5,
+                );
+
+                $this->assertFalse( get_comment_reply_link( $args, $comment_id ) );
+        }
+
 }