Changeset 48577

Timestamp:

07/23/2020 01:09:50 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve description for comment_id_fields().

Rename the $id parameter to $post_id for clarity.

Props stevenlinx.
Fixes #50737.

File:

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

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

@@ -308 +308 @@
         $url     = '';
         $id      = 0;
+
         if ( ! empty( $comment ) ) {
                 $author_url = ( 'http://' === $comment->comment_author_url ) ? '' : $comment->comment_author_url;
@@ -1556 +1557 @@
  */
 function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) {
-        $id     = get_the_ID();
-        $title  = get_the_title();
-        $number = get_comments_number( $id );
+        $post_id    = get_the_ID();
+        $post_title = get_the_title();
+        $number     = get_comments_number( $post_id );
 
         if ( false === $zero ) {
                 /* translators: %s: Post title. */
-                $zero = sprintf( __( 'No Comments<span class="screen-reader-text"> on %s</span>' ), $title );
+                $zero = sprintf( __( 'No Comments<span class="screen-reader-text"> on %s</span>' ), $post_title );
         }
 
         if ( false === $one ) {
                 /* translators: %s: Post title. */
-                $one = sprintf( __( '1 Comment<span class="screen-reader-text"> on %s</span>' ), $title );
+                $one = sprintf( __( '1 Comment<span class="screen-reader-text"> on %s</span>' ), $post_title );
         }
 
@@ -1573 +1574 @@
                 /* translators: 1: Number of comments, 2: Post title. */
                 $more = _n( '%1$s Comment<span class="screen-reader-text"> on %2$s</span>', '%1$s Comments<span class="screen-reader-text"> on %2$s</span>', $number );
-                $more = sprintf( $more, number_format_i18n( $number ), $title );
+                $more = sprintf( $more, number_format_i18n( $number ), $post_title );
         }
 
         if ( false === $none ) {
                 /* translators: %s: Post title. */
-                $none = sprintf( __( 'Comments Off<span class="screen-reader-text"> on %s</span>' ), $title );
+                $none = sprintf( __( 'Comments Off<span class="screen-reader-text"> on %s</span>' ), $post_title );
         }
 
@@ -1600 +1601 @@
                  *
                  * @param string $respond_link The default response link.
-                 * @param integer $id The post ID.
+                 * @param int    $post_id      The post ID.
                  */
-                echo apply_filters( 'respond_link', $respond_link, $id );
+                echo apply_filters( 'respond_link', $respond_link, $post_id );
         } else {
                 comments_link();
@@ -1911 +1912 @@
  * @since 3.0.0
  *
- * @param int $id Optional. Post ID. Default current post ID.
- * @return string Hidden input HTML for replying to comments
- */
-function get_comment_id_fields( $id = 0 ) {
-        if ( empty( $id ) ) {
-                $id = get_the_ID();
+ * @param int $post_id Optional. Post ID. Defaults to the current post ID.
+ * @return string Hidden input HTML for replying to comments.
+ */
+function get_comment_id_fields( $post_id = 0 ) {
+        if ( empty( $post_id ) ) {
+                $post_id = get_the_ID();
         }
 
         $replytoid = isset( $_GET['replytocom'] ) ? (int) $_GET['replytocom'] : 0;
-        $result    = "<input type='hidden' name='comment_post_ID' value='$id' id='comment_post_ID' />\n";
+        $result    = "<input type='hidden' name='comment_post_ID' value='$post_id' id='comment_post_ID' />\n";
         $result   .= "<input type='hidden' name='comment_parent' id='comment_parent' value='$replytoid' />\n";
 
@@ -1928 +1929 @@
          * @since 3.0.0
          *
-         * @param string $result    The HTML-formatted hidden id field comment elements.
-         * @param int    $id        The post ID.
-         * @param int    $replytoid The id of the comment being replied to.
-         */
-        return apply_filters( 'comment_id_fields', $result, $id, $replytoid );
+         * @param string $result    The HTML-formatted hidden ID field comment elements.
+         * @param int    $post_id   The post ID.
+         * @param int    $replytoid The ID of the comment being replied to.
+         */
+        return apply_filters( 'comment_id_fields', $result, $post_id, $replytoid );
 }
 
@@ -1938 +1939 @@
  * Outputs hidden input HTML for replying to comments.
  *
+ * Adds two hidden inputs to the comment form to identify the `comment_post_ID`
+ * and `comment_parent` values for threaded comments.
+ *
+ * This tag must be within the `<form>` section of the `comments.php` template.
+ *
  * @since 2.7.0
  *
- * @param int $id Optional. Post ID. Default current post ID.
- */
-function comment_id_fields( $id = 0 ) {
-        echo get_comment_id_fields( $id );
+ * @see get_comment_id_fields()
+ *
+ * @param int $post_id Optional. Post ID. Defaults to the current post ID.
+ */
+function comment_id_fields( $post_id = 0 ) {
+        echo get_comment_id_fields( $post_id );
 }