Add `$context` parameter to `get_edit_comment_link()` to get the URL without HTML entities

[flixos90]

The get_edit_comment_link() function currently always returns its URL with HTML entities included, specifically & (&). This makes sense when including the URL in HTML content, but this may not be the only context where such a link is used.

For exactly the same purpose, the get_edit_post_link() function already has a $context parameter with a default value of "display". Alternatively, "raw" can be provided to not include the HTML entity &, but the regular &.

It would make sense to introduce the same optional $context parameter to get_edit_comment_link(). If "raw" is provided, the function could return the URL to edit the comment without the HTML entity.

Add $context parameter to get_edit_comment_link() to get the URL without HTML entities

@felixarntz Thanks for the suggestion , i will update you today EOD for test case. Thanks again!.

@felixarntz : test case also added please review.

@mukeshpanchal27 : Suggested changes performed , please check Thanks!.

@felixarntz Please check it now

[flixos90]

In 58875:

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.

Committed in https://core.trac.wordpress.org/changeset/58875

[david.binda]

Sorry for reopening the ticket, but I've run into an issue where the $comment_id passed as an optional argument to the get_edit_comment_link filter callback is not an int but an object of the WP_Comment class.

This happens in case the object is passed as an argument to the get_edit_comment_link function. The docblock of the get_edit_comment_link function and it's implementation actually allows the WP_Commnet object to be passed in instead of an int.

IMHO, either the documentation of the get_edit_comment_link filter needs to be updated the way it matches such behaviour, or the code needs to be updated the way it ensures the $comment_id param is always an int.

This is a follow-up fix that addresses the bug in https://core.trac.wordpress.org/ticket/61727#comment:10.

Trac ticket: https://core.trac.wordpress.org/ticket/61727

[flixos90]

Thanks @davidbinda, this is a great catch. I implemented a fix in ​https://github.com/WordPress/wordpress-develop/pull/7322 that ensures the parameter is always the comment ID, which makes more sense for consistent filter behavior.

@felixarntz This looks good to me but are you able to do a force push of just the test, wait for the actions to complete and then push the fix?

@peterwilsoncc Done, please see e.g. ​https://github.com/WordPress/wordpress-develop/actions/runs/10802717139/job/29965357479?pr=7322 for showing the failing test prior to the fix being re-added.

[mukesh27]

Great catch @davidbinda

The PR got enough approval for commit.

[deepakrohilla]

Thank you, @davidbinda, for catching that, and thanks to @felixarntz for implementing it further.

[flixos90]

In 59012:

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.

Committed in https://core.trac.wordpress.org/changeset/59012

[flixos90]

In 59013:

Comments: Reinstate original since annotation on get_edit_comment_link filter.

This was accidentally removed in [58875].

See #61727.