Skip to content

Commit 2dadc00

Browse files
Docs: Correct parameter types for get_comments_number_text().
This updates the `@param` types to correctly reflect the default `false` parameter. Follow-up to [6495], [25567], [28912], [49936]. Props justlevine. See #63268. git-svn-id: https://develop.svn.wordpress.org/trunk@60166 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 4201f12 commit 2dadc00

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/wp-includes/comment-template.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -954,10 +954,10 @@ function comments_number( $zero = false, $one = false, $more = false, $post = 0
954954
* @since 4.0.0
955955
* @since 5.4.0 Added the `$post` parameter to allow using the function outside of the loop.
956956
*
957-
* @param string $zero Optional. Text for no comments. Default false.
958-
* @param string $one Optional. Text for one comment. Default false.
959-
* @param string $more Optional. Text for more than one comment. Default false.
960-
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is the global `$post`.
957+
* @param string|false $zero Optional. Text for no comments. Default false.
958+
* @param string|false $one Optional. Text for one comment. Default false.
959+
* @param string|false $more Optional. Text for more than one comment. Default false.
960+
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is the global `$post`.
961961
* @return string Language string for the number of comments a post has.
962962
*/
963963
function get_comments_number_text( $zero = false, $one = false, $more = false, $post = 0 ) {

0 commit comments

Comments
 (0)