wp_list_comments ignores $comments parameter

[felser]

Introduced in [36157].

This update does not check if a custom $comments array was provided before determining that a new comment query needs to be made.

If a comment array is provided, wp_list_comments shouldn't make a new query and should always use the provided comments.

[boonebgorges]

@felser Thanks for the ticket. You're correct that this is due to [36157] - it was an oversight on my part. It should just be a matter of moving the added logic inside the else block right below it, but this will need unit tests.

[ivankristianto]

This patch should fix this issue.

[boonebgorges]

Thanks for the patch, @ivankristianto. It's frustrating that the separate_comments() logic has to be reproduced, but like you, I can't see a better way of doing it without rewriting the whole function.

35356.diff​ cleans up the formatting of the patch, and adds a unit test that demonstrates the issue. @felser or someone else having the problem, can you verify that the patch fixes the issue for you?

[ivankristianto]

Replying to boonebgorges:

It's frustrating that the separate_comments() logic has to be reproduced

Totally agree with you. It does repeated 3 times.

[boonebgorges]

In 36276:

Always respect $comments array passed to wp_list_comments().

[36157] fixed a bug whereby wp_list_comments() would not properly recognize
custom pagination arguments. See #35175. However, it inadvertently introduced
a bug that caused any $comments array explicitly passed to the function to be
ignored, when that array was accompanied by pagination arguments that differ
from those in $wp_query. We address this bug by moving the logic introduced
in [36157] inside a block that only fires when no $comments array has been
provided to the function.

Props ivankristianto.
Fixes #35356.

[boonebgorges]

Reopening for 4.4.2.

[dd32]

In 36356:

Comments: Always respect $comments array passed to wp_list_comments().

[36157] fixed a bug whereby wp_list_comments() would not properly recognize
custom pagination arguments. See #35175. However, it inadvertently introduced
a bug that caused any $comments array explicitly passed to the function to be
ignored, when that array was accompanied by pagination arguments that differ
from those in $wp_query. We address this bug by moving the logic introduced
in [36157] inside a block that only fires when no $comments array has been
provided to the function.

Merges [36276] to the 4.4 branch.
Props ivankristianto, boonebgorges.
Fixes #35356.

[boonebgorges]

#35572 was marked as a duplicate.