Changeset 59012

Timestamp:

09/11/2024 03:38:20 PM (2 years ago)

Author:

flixos90

Message:

Comments: Ensure $comment_id parameter on get_edit_comment_link filter is always a comment ID.

Follow up to [58875].

Props david.binda, peterwilsoncc, mukesh27, davidbaumwald.
Fixes #61727.

Location:

trunk

Files:

• src/wp-includes/link-template.php (modified) (2 diffs)
• tests/phpunit/tests/link/getEditCommentLink.php (modified) (1 diff)

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

@@ -1619 +1619 @@
         $location = admin_url( $action ) . $comment->comment_ID;
 
+        // Ensure the $comment_id variable passed to the filter is always an ID.
+        $comment_id = (int) $comment->comment_ID;
+
         /**
          * Filters the comment edit link.
@@ -1624 +1627 @@
          * @since 6.7.0 The $comment_id and $context parameters are now being passed to the filter.
          *
-         * @param string $location The edit link.
-         * @param int    $comment_id Optional. Unique ID of the comment to generate an edit link.
-         * @param int    $context    Optional. Context to include HTML entities in link. Default 'display'.
+         * @param string $location   The edit link.
+         * @param int    $comment_id Unique ID of the comment to generate an edit link.
+         * @param string $context    Context to include HTML entities in link. Default 'display'.
          */
         return apply_filters( 'get_edit_comment_link', $location, $comment_id, $context );

trunk/tests/phpunit/tests/link/getEditCommentLink.php

@@ -128 +128 @@
                 $this->assertSame( $expected_url, $actual_url );
         }
+
+        /**
+         * Tests that the 'get_edit_comment_link' filter receives the comment ID, even when a comment object is passed.
+         *
+         * @ticket 61727
+         */
+        public function test_get_edit_comment_link_filter_uses_id() {
+                // Add a filter just to catch the $comment_id filter parameter value.
+                $comment_id_filter_param = null;
+                add_filter(
+                        'get_edit_comment_link',
+                        function ( $location, $comment_id ) use ( &$comment_id_filter_param ) {
+                                $comment_id_filter_param = $comment_id;
+                                return $location;
+                        },
+                        10,
+                        2
+                );
+
+                // Pass a comment object to get_edit_comment_link().
+                get_edit_comment_link( get_comment( self::$comment_id ) );
+
+                // The filter should still always receive the comment ID, not the object.
+                $this->assertSame( self::$comment_id, $comment_id_filter_param );
+        }
 }