Add `$comment` parameter to `get_comment_author_email_link()`

[flixos90]

To use this function (also its related output function) for any specific comment, let's add a $comment parameter.

[flixos90]

patch adding the parameter

[flixos90]

improved docs

[SergeyBiryukov]

What about comment_author_url_link() and get_comment_author_url_link()?

[boonebgorges]

I know that the default value of 0 for $comment is intended to trigger the empty() check at the beginning of get_comment(). IMHO it would be more transparent if the default value were null, since this would indicate that no value is being provided (rather than a value of 0, which makes me do a double-take when I read the function signature, since a comment can't have an ID of 0).

[flixos90]

Replying to SergeyBiryukov:

What about comment_author_url_link() and get_comment_author_url_link()?

I created a separate ticket for that in #36573.

[wonderboymusic]

#needs-unit-tests - there currently are none

[DrewAPicture]

36571.3.diff​ removes the spacing changes to other paramter docs – makes for a cleaner, easier to grok commit. We'll follow up and fix the spacing. Also, $comment in both instances is a new parameter in core nomenclature. Arguments are sub-parameter in this context :-)

[DrewAPicture]

Docs

[DrewAPicture]

36571.4.diff​ adds tests.

[DrewAPicture]

Tests

[boonebgorges]

36571.5.diff​ makes the following changes to 36571.4.diff​ :

• Share the same comment fixture across the new tests (using wpSetUpBeforeClass() etc)
• During test teardown, clear the $comment global and readd the antispambot filter, to avoid test pollution
• Use null for a default value of the new param rather than 0
• Only use the @ticket flag for test methods that are directly related to the enhancement being introduced here

Changes are looking good to me.

[DrewAPicture]

In 37348:

Comments: Adjust comment_author_email_link() and get_comment_author_email_link() to each accept a new optional fourth parameter, $comment, which enables overriding the $comment global.

Adds tests.

Props flixos90, boonebgorges, DrewAPicture.
See #36571.

[DrewAPicture]

In 37349:

Comments: Realign parameter documentation in the DocBlocks for comment_author_email_link() and get_comment_author_email_link() following [37348].

Also adds a missing return description for get_comment_author_email_link().

Props flixos90 for the initial patch.
Fixes #36571.