Comments Block (legacy): Don't render empty block wrapper

[ockham]

What?

Follow-up to @DAreRodz #41807 (comment):

Another thing I've noticed is that the block renders in those cases where the comments_template()'s output is empty. This should be a quick fix. 🙂

Why?

To avoid an empty block wrapper for no content.

How?

By adding a check if comments_template()'s return value is empty(), and returning an empty string if it is.

Testing Instructions

TDB

Screenshots or screencast

[ockham]

From #41807 (comment):

[I] but was struggling to reproduce in what cases comments_template()'s output would be empty. (I tried a post with no comments and disabled comments for it to also hide the comments form, but we already have code in trunk to bail early in that case.) Maybe you can help me fill in the testing instructions there? 🙌

[DAreRodz]

Maybe you can help me fill in the testing instructions there? 🙌

IIRC I saw the problem when I added the Comments block inside a Query Loop block (e.g., in the Home template). The block renders empty because comments_template() doesn't return anything.

Could it be a good idea also to show a warning message if you place this block in an invalid template? Just for the legacy version, I mean (not sure if this is worth the effort). 🤔

[jordesign]

Closing this issue as the Legacy Comments block has been deprecated.