Allow filtering of reply text with comment context

[aaroncampbell]

I know you can specify the reply text for comments, but you can't make them specific to each comment such as "Reply to comment #1234 by Joe". This will let you do that by adding a filter called comment_reply_link_text to get_comment_reply_link() that passes along $args, $comment, and $post (just like the existing comment_reply_link filter).

I know you COULD do this with some processing on the link, but it would require pulling comment and post IDs from the URL and/or onclick, then replacing the text in the link itself. This way would be a lot simpler and only adds a single filter.

[azaozz]

Perhaps we can pass $text to the existing filter making it very easy for a plugin to replace it instead of adding another filter. Would save a bit of overhead.

[Elpie]

See also #16433

[chriscct7]

Seems this would go hand in hand with #16433 which is slated for the 4.1 release.

[chriscct7]

Per
WCAG Checkpoint 13.1: Clearly identify the target of each link. [Priority 2]

this should be classified as focus for accessibility like was done in #16433

[joedolson]

So, I'm not seeing how this would add anything to the existing functionality. The existing comment filter passes the entire $args array into the filter, so the $argsreply_text? is already available, and there's really no reason you couldn't recreate the text link as needed.

I might be missing something, but I think that we can already do this with the existing code, and that this ticket is moot.

[chriscct7]

@joedolson that was actually brought up in the initial ticket description. The idea is that it's easier to filter it before assembling the link as opposed to recreating it later (you could do something like an str_replace on the reply text as well from new to old).

[joedolson]

Yes, I guess that's some benefit; but it seems very slight. The str_replace method is what I would probably choose to do, and doesn't require any changes.

[chriscct7]

I agree its probably just as easy to str_replace, but it could be useful for some as its more straightforward.

Patch needs a refresh due to #16433

[markjaquith]

I'm +1 on having this filter.

[joedolson]

Why not add a filter over the args array, so that we can filter any of those elements, instead?

[joedolson]

Add filter over args array

[joedolson]

Patch includes the added reply_to_text parameter in $args, and moves the variable definition after pulling the post and comment object, so those are available to the filter.

[chriscct7]

I've talked to @johnbillion here at WordCamp San Francisco 2014 and we've decided that it would be better to use an updated version of the original patch that just modifies the reply text at that particular spot.

[aaroncampbell]

Talked to @johnbillion about this and we decided to go the direction @joedolson suggested and filter the $args array. The reason is that we actually have three strings that would all be useful to filter. One displays when a user is logged out and needs to be registered, one displays to everyone else, and one is used for the aria-label. It just made more sense than adding individual filters. 10569.diff​ adds the new filter comment_reply_link_args

[chriscct7]

Sounds good!

[DrewAPicture]

docs tweaks

[DrewAPicture]

10569.2.diff​ is ready to go in.

[SergeyBiryukov]

In 10569.2.diff​, seems like "Filter the text for the reply-to comment link" should be changed to "Filter the comment reply link arguments".

[aaroncampbell]

Replying to SergeyBiryukov:

In 10569.2.diff​, seems like "Filter the text for the reply-to comment link" should be changed to "Filter the comment reply link arguments".

Yep, I updated the filter and didn't update the inline docs when I was working on it.

[SergeyBiryukov]

In 30039:

Add 'comment_reply_link_args' filter for get_comment_reply_link() arguments.

props joedolson, aaroncampbell, DrewAPicture.
fixes #10569.