Don't output a cancel comment reply link if comments aren't threaded

[henry.wright]

cancel_comment_reply_link() is used inside comment_form() to output a cancel comment reply link. If comments aren't threaded, the cancel comment reply link isn't needed. It currently appears in the HTML source regardless of the status of thread_comments.

[rachelbaker]

@henry.wright Thanks for the report. While cancel_comment_reply_link() is always called, if you look at the code in get_cancel_comment_reply_link() the reply link is still output, but hidden unless the replytocom param is set:

$style = isset($_GET['replytocom']) ? '' : ' style="display:none;"';

If threaded comments aren't allowed, I don't see why we need to output anything. Would you be willing to submit a patch?

Introduced in [12810]

[jignesh.nakrani]

@rachelbaker @henry.wright here is a patch to skip rendering cancel comment reply link if comments aren't threaded.

[henry.wright]

Thanks for the patch. Personally, I'd just bail from the function early if comments aren't threaded.

function get_cancel_comment_reply_link( $text = '' ) {
    if ( ! get_option( 'thread_comments' ) ) {
        return '';
    }
    // Rest of code.

[henry.wright]

37267.diff is an alternative to @jignesh.nakrani's patch.

37267.diff won't stop cancel_reply_before and cancel_reply_before output, but it will stop the actual cancel comment reply link output.

[desrosj]

The latest patch no longer applies to trunk.

[jignesh.nakrani]

here is a patch to skip rendering cancel comment reply link if comments aren't threaded.

[jignesh.nakrani]

37267.diff won't stop cancel_reply_before and cancel_reply_before output, but it will stop the actual cancel comment reply link output.

I think if cancel_reply_link is not being added then we don’t have to print cancel_reply_before and cancel_reply_after

@henrywright @desrosj

[audrasjb]

The patch doesn't apply cleanly against trunk anymore. Refreshing and testing right now.

[audrasjb]

Comments: Don’t output the cancel comment link when thread_comments option is not enabled

[audrasjb]

Before patch: the link exists (I removed the display none CSS rule for the example)

[audrasjb]

After patch: the link is not generated at all when threaded_comments option is not enabled

[audrasjb]

37267.2.diff refreshes the previous patch against trunk.
It's tested and it work fine: see screenshots above.

Moving for 5.9 consideration.

[audrasjb]

Marking this for commit as per today's bug scrub

[audrasjb]

Removing commit keyword as it looks like it needs some unit tests

Applies 37267.2.diff patch and adds tests.

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

[hellofromTonya]

37267.2.diff​ works as expected. ​PR 1892 adds unit tests to it.

Marking for commit.

[hellofromTonya]

Preparing commit.

[hellofromTonya]

In 52175:

Comments: Don't output "cancel comment reply link" if comments aren't threaded.

Though hidden via style="display:none;", if the comments aren't threaded, this commit doesn't output the cancel comment reply link (skips over that logic). Change in comment_form().

Adds tests.

Follow-up to [12810], [38959].

Props henrywright, jigneshnakrani, rachelbaker, desrosj, audrasjb, hellofromTonya.
Fixes #37267.

Committed via changeset https://core.trac.wordpress.org/changeset/52175.

[hellofromTonya]

Thank you everyone for contributing! The fix has been committed and will ship with 5.9 Beta 1 tomorrow. Cheers

[hellofromTonya]

Note: Changeset [52176] was incorrectly noted as fixing this ticket when actually it fixes #32315. The changeset has been moved to the right ticket.