Changeset 58875

Timestamp:

08/09/2024 05:59:41 PM (4 months ago)

Author:

flixos90

Message:

Comments: Add optional $context parameter to get_edit_comment_link() to get the URL without HTML entities.

This brings the function in line with the similar get_edit_post_link() parameter. The 'get_edit_comment_link' filter now additionally receives the $comment_id and $context as parameters.

Additionally, as a minor enhancement, the capability check is now more defensive, as it will no longer cause an error if the given comment ID is invalid.

As part of the changeset, comprehensive test coverage for the get_edit_comment_link() including the new behavior is added.

Props deepakrohilla.
Fixes #61727.

Location:

trunk

Files:

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

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

@@ -1596 +1596 @@
  *
  * @since 2.3.0
+ * @since 6.7.0 The $context parameter was added.
  *
  * @param int|WP_Comment $comment_id Optional. Comment ID or WP_Comment object.
- * @return string|void The edit comment link URL for the given comment.
- */
-function get_edit_comment_link( $comment_id = 0 ) {
+ * @param string         $context    Optional. Context in which the URL should be used. Either 'display',
+ *                                   to include HTML entities, or 'url'. Default 'display'.
+ * @return string|void The edit comment link URL for the given comment, or void if the comment id does not exist or
+ *                     the current user is not allowed to edit it.
+ */
+function get_edit_comment_link( $comment_id = 0, $context = 'display' ) {
     $comment = get_comment( $comment_id );
 
-    if ( ! current_user_can( 'edit_comment', $comment->comment_ID ) ) {
+    if ( ! is_object( $comment ) || ! current_user_can( 'edit_comment', $comment->comment_ID ) ) {
         return;
     }
 
-    $location = admin_url( 'comment.php?action=editcomment&c=' ) . $comment->comment_ID;
+    if ( 'display' === $context ) {
+        $action = 'comment.php?action=editcomment&c=';
+    } else {
+        $action = 'comment.php?action=editcomment&c=';
+    }
+
+    $location = admin_url( $action ) . $comment->comment_ID;
 
     /**
      * Filters the comment edit link.
      *
-     * @since 2.3.0
+     * @since 6.7.0 The $comment_id and $context parameters are now being passed to the filter.
      *
      * @param string $location The edit link.
-     */
-    return apply_filters( 'get_edit_comment_link', $location );
+     * @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'.
+     */
+    return apply_filters( 'get_edit_comment_link', $location, $comment_id, $context );
 }