Changeset 60397

Timestamp:

06/30/2025 05:39:28 PM (9 months ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Explicitly return null in get_comment_reply_link().

This matches the documented @return type.

Includes correcting documentation for get_post_reply_link(), which can only return string or false.

Follow-up to [8898], [8970], [9406], [25567], [30681], [32568], [45741], [46335].

Props justlevine.
See #63268.

File:

• trunk/src/wp-includes/comment-template.php (modified) (4 diffs)

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

@@ -1755 +1755 @@
  * @param int|WP_Post    $post    Optional. Post ID or WP_Post object the comment is going to be displayed on.
  *                                Default current post.
- * @return string|false|null Link to show comment form, if successful. False, if comments are closed.
+ * @return string|false|null Link to show comment form on success. False if comments are closed. Null on failure.
  */
 function get_comment_reply_link( $args = array(), $comment = null, $post = null ) {
@@ -1778 +1778 @@
 
     if ( 0 === $args['depth'] || $args['max_depth'] <= $args['depth'] ) {
-        return;
+        return null;
     }
 
@@ -1784 +1784 @@
 
     if ( empty( $comment ) ) {
-        return;
+        return null;
     }
 
@@ -1912 +1912 @@
  *     @type string $after      Text or HTML to add after the reply link. Default empty.
  * }
- * @param int|WP_Post $post    Optional. Post ID or WP_Post object the comment is going to be displayed on.
- *                             Default current post.
- * @return string|false|null Link to show comment form, if successful. False, if comments are closed.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on.
+ *                          Default current post.
+ * @return string|false Link to show comment form on success. False if comments are closed.
  */
 function get_post_reply_link( $args = array(), $post = null ) {