[wp-trac] [WordPress Trac] #38369: Docs: Incorrect return type for get_comments_number()

[WordPress Trac]

#38369: Docs: Incorrect return type for get_comments_number()
--------------------------------------+----------------------------
 Reporter:  ocean90                   |       Owner:  kiranpotphode
     Type:  defect (bug)              |      Status:  closed
 Priority:  normal                    |   Milestone:  4.9
Component:  Comments                  |     Version:
 Severity:  normal                    |  Resolution:  fixed
 Keywords:  good-first-bug has-patch  |     Focuses:  docs
--------------------------------------+----------------------------
Changes (by DrewAPicture):

 * status:  assigned => closed
 * resolution:   => fixed


Comment:

 In [changeset:"41285"]:
 {{{
 #!CommitTicketReference repository="" revision="41285"
 Docs: Clarify that `get_comments_number()` can return either a numeric
 string (for compatibility reasons) or 0 if the post doesn't exist.

 Also update the hook doc for the `get_comments_number` filter to reflect
 the mixed type for `$count`.

 Props kiranpotphode for the initial patch.
 Fixes #38369.
 }}}

--
Ticket URL: <https://core.trac.wordpress.org/ticket/38369#comment:5>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform