Changeset 48585

Timestamp:

07/23/2020 07:04:38 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Use more appropriate variable names in the inline docs for action and filter parameters.

See #49572

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-comments-list-table.php (modified) (1 diff)
• wp-admin/includes/comment.php (modified) (1 diff)
• wp-includes/class-wp-rewrite.php (modified) (1 diff)
• wp-includes/feed-rss2-comments.php (modified) (1 diff)
• wp-includes/user.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-comments-list-table.php

@@ -1015 +1015 @@
          * @since 2.8.0
          *
-         * @param string $column_name         The custom column's name.
-         * @param int    $comment->comment_ID The custom column's unique ID number.
+         * @param string $column_name The custom column's name.
+         * @param int    $comment_ID  The custom column's unique ID number.
          */
         do_action( 'manage_comments_custom_column', $column_name, $comment->comment_ID );

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

@@ -123 +123 @@
      * @since 2.0.0
      *
-     * @param string $comment->comment_content Comment content.
+     * @param string $comment_content Comment content.
      */
     $comment->comment_content = apply_filters( 'comment_edit_pre', $comment->comment_content );

trunk/src/wp-includes/class-wp-rewrite.php

@@ -1444 +1444 @@
          * @since 1.5.0
          *
-         * @param string[] $this->rules The compiled array of rewrite rules, keyed by their regex pattern.
+         * @param string[] $rules The compiled array of rewrite rules, keyed by their regex pattern.
          */
         $this->rules = apply_filters( 'rewrite_rules_array', $this->rules );

trunk/src/wp-includes/feed-rss2-comments.php

@@ -111 +111 @@
          * @since 2.1.0
          *
-         * @param int $comment->comment_ID The ID of the comment being displayed.
-         * @param int $comment_post->ID    The ID of the post the comment is connected to.
+         * @param int $comment_ID The ID of the comment being displayed.
+         * @param int $ID         The ID of the post the comment is connected to.
          */
         do_action( 'commentrss2_item', $comment->comment_ID, $comment_post->ID );

trunk/src/wp-includes/user.php

@@ -2320 +2320 @@
      * @since 2.7.0
      *
-     * @param bool $allow         Whether to allow the password to be reset. Default true.
-     * @param int  $user_data->ID The ID of the user attempting to reset a password.
+     * @param bool $allow Whether to allow the password to be reset. Default true.
+     * @param int  $ID    The ID of the user attempting to reset a password.
      */
     $allow = apply_filters( 'allow_password_reset', $allow, $user->ID );