[wp-trac] [WordPress Trac] #56244: Use a consistent parameter name for functions accepting a comment ID or object

[WordPress Trac]

#56244: Use a consistent parameter name for functions accepting a comment ID or
object
----------------------------+-------------------------------------
 Reporter:  SergeyBiryukov  |       Owner:  SergeyBiryukov
     Type:  enhancement     |      Status:  accepted
 Priority:  normal          |   Milestone:  6.1
Component:  Comments        |     Version:
 Severity:  normal          |  Resolution:
 Keywords:                  |     Focuses:  docs, coding-standards
----------------------------+-------------------------------------

Comment (by SergeyBiryukov):

 In [changeset:"53723" 53723]:
 {{{
 #!CommitTicketReference repository="" revision="53723"
 Coding Standards: Rename `$comment_post_ID` and `$comment_author_IP`
 variables in various files.

 This fixes two WPCS warnings:
 * `Variable "$comment_post_ID" is not in valid snake_case format`
 * `Variable "$comment_author_IP" is not in valid snake_case format`

 While matching the database fields of the same name, these variables did
 not follow the WordPress coding standards, and are now renamed to address
 that.

 Note: The name change only affects internal variables and parameters for a
 few actions receiving a comment post ID:

 * `edit_comment`
 * `comment_id_not_found`
 * `comment_closed`
 * `comment_on_trash`
 * `comment_on_draft`
 * `comment_on_password_protected`
 * `pre_comment_on_post`

 The change does not affect parameters for functions receiving an array of
 comment data:

 * `wp_insert_comment()`
 * `wp_new_comment()`
 * `wp_update_comment()`
 * `wp_handle_comment_submission()`

 The associated array keys still match the database fields:
 `comment_post_ID` and `comment_author_IP`.

 Follow-up to [1706], [2894], [8720], [28427], [28437], [28457], [34799],
 [53720],

 See #55647, #56244.
 }}}

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/56244#comment:7>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform