get_comment_count() should return an integer for all counts of all statuses

[johnbillion]

get_comment_count() returns a mixture of integers and numeric strings depending on the comment status and count.

Any status with zero comments is represented by integer 0.
Any status with more than zero comments is represented by a numeric string.
The total_comments and all elements are always integers.

Example:

array(7) {
  ["approved"]            => string(1) "221"
  ["awaiting_moderation"] => int(0)
  ["spam"]                => string(1) "10"
  ["trash"]               => int(0)
  ["post-trashed"]        => int(0)
  ["total_comments"]      => int(221)
  ["all"]                 => int(211)
}

It should return integers for all statuses for consistency.

The tests in Tests_Get_Comment_Count() should be switched to using assertSame().

[johnbillion]

In 46223:

Docs: Improve the docs for comment counting related functions.

See #47110, #48093

[progremzion]

Hi @johnbillion

I have fixed the issue. Can you please review? I am new to core contribution, so please do let me know if something is missing.

We don't need to update the Tests_Get_Comment_Count() class as by updating the get_comment_count function's return value will resolve that.

Thanks!

[m.usama.masood]

Hi @davidakennedy,

I have applied patch and update docs of functions. I also updated the Tests_Get_Comment_Count() class & Tests_Import_Import() class for phpunit test.

Thanks!

[knutsp]

A valid bug ticket is first closed after committed, then as "fixed".

[sncoker]

At #WCUS Contributor Day. Patch still applies cleanly. Unit tests are passing.

[yingling017]

At #WCUSContributorDay patch applies cleanly and unit tests are passing.

[desrosj]

This could be a good thing to call out in the Miscellaneos Developer Changes dev note just in case someone is performing strict comparisons.

[johnbillion]

In 47526:

Comments: Ensure all elements in the array returned by get_comment_count() are integers.

Previously elements would be a mixture of strings and integers depending on their numeric value.

Props progremzion, m.usama.masood

Fixes #48093

[desrosj]

This received a call out in the Miscellaneous Developer Changes in 5.5 dev note: ​https://make.wordpress.org/core/2020/07/29/miscellaneous-developer-focused-changes-in-wordpress-5-5/.

[desrosj]

Actually, I am mistaken. Confused this with another ticket.

[justinahinon]

Mentionned in 5.5 Field Guide: ​https://make.wordpress.org/core/2020/07/30/wordpress-5-5-field-guide/