sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Clarify that get_comments_number() can return either a numeric string (for compatibility reasons) or 0 if the post doesn't exist.

Browse Source 
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.


git-svn-id: https://develop.svn.wordpress.org/trunk@41285 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2017-08-20 20:12:50 +00:00
parent d8c20f3a5b
commit c3ff721c81
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/wp-includes/comment-template.php
View File

@ -830,12 +830,13 @@ function comments_link( $deprecated = '', $deprecated_2 = '' ) {
} }
/** /**
* Retrieve the amount of comments a post has. * Retrieves the amount of comments a post has.
* *
* @since 1.5.0 * @since 1.5.0
* *
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post. * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is the global `$post`.
* @return int The number of comments a post has. * @return string|int If the post exists, a numeric string representing the number of comments
* the post has, otherwise 0.
*/ */
function get_comments_number( $post_id = 0 ) { function get_comments_number( $post_id = 0 ) {
$post = get_post( $post_id ); $post = get_post( $post_id );
@ -852,8 +853,8 @@ function get_comments_number( $post_id = 0 ) {
* *
* @since 1.5.0 * @since 1.5.0
* *
* @param int $count Number of comments a post has. * @param string|int $count A string representing the number of comments a post has, otherwise 0.
* @param int $post_id Post ID. * @param int $post_id Post ID.
*/ */
return apply_filters( 'get_comments_number', $count, $post_id ); return apply_filters( 'get_comments_number', $count, $post_id );
} }