Changeset 60166

Timestamp:

04/14/2025 10:32:08 PM (2 weeks ago)

Author:

SergeyBiryukov

Message:

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.

File:

• trunk/src/wp-includes/comment-template.php (modified) (1 diff)

trunk/src/wp-includes/comment-template.php

@@ -955 +955 @@
  * @since 5.4.0 Added the `$post` parameter to allow using the function outside of the loop.
  *
- * @param string      $zero Optional. Text for no comments. Default false.
- * @param string      $one  Optional. Text for one comment. Default false.
- * @param string      $more Optional. Text for more than one comment. Default false.
- * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is the global `$post`.
+ * @param string|false $zero Optional. Text for no comments. Default false.
+ * @param string|false $one  Optional. Text for one comment. Default false.
+ * @param string|false $more Optional. Text for more than one comment. Default false.
+ * @param int|WP_Post  $post Optional. Post ID or WP_Post object. Default is the global `$post`.
  * @return string Language string for the number of comments a post has.
  */