Skip to content

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

Closed
ockham wants to merge 1 commit intotrunkfrom
fix/comments-block-suppress-empty-block-output
Closed

Comments Block (legacy): Don't render empty block wrapper#42737
ockham wants to merge 1 commit intotrunkfrom
fix/comments-block-suppress-empty-block-output

Conversation

@ockham
Copy link
Copy Markdown
Contributor

@ockham ockham commented Jul 27, 2022

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 ockham added [Block] Comments Affects the Comments Block - formerly known as Comments Query Loop [Block] Comments (legacy) The legacy mode of the Comments block (formerly known as Post Comments) labels Jul 27, 2022
@ockham ockham self-assigned this Jul 27, 2022
@ockham ockham mentioned this pull request Jul 28, 2022
Merged
@ockham
Copy link
Copy Markdown
Contributor Author

ockham commented Jul 28, 2022

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
Copy link
Copy Markdown
Contributor

DAreRodz commented Aug 1, 2022

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
Copy link
Copy Markdown
Contributor

jordesign commented Aug 21, 2023

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

@jordesign jordesign closed this Aug 21, 2023
@yaseenaljamal yaseenaljamal mentioned this pull request Jan 31, 2024
Open
@MaxMood96 MaxMood96 mentioned this pull request Jan 31, 2024
Open
@soloinovator soloinovator mentioned this pull request Feb 1, 2024
Open
@yassine4999 yassine4999 mentioned this pull request Feb 1, 2024
Open
@johnbillion johnbillion deleted the fix/comments-block-suppress-empty-block-output branch April 22, 2025 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra will be requested when the pull request is marked ready for review ajitbohra is a code owner

@fabiankaegy fabiankaegy Awaiting requested review from fabiankaegy fabiankaegy will be requested when the pull request is marked ready for review fabiankaegy is a code owner

Assignees

@ockham ockham

Labels

[Block] Comments (legacy) The legacy mode of the Comments block (formerly known as Post Comments) [Block] Comments Affects the Comments Block - formerly known as Comments Query Loop

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ockham @DAreRodz @jordesign