Make WordPress Core


Ignore:
Timestamp:
07/19/2022 04:17:56 PM (22 months ago)
Author:
SergeyBiryukov
Message:

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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/comment-template.php

    r53719 r53723  
    275275     * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
    276276     *
    277      * @param string     $comment_author_IP The comment author's IP address, or an empty string if it's not available.
     277     * @param string     $comment_author_ip The comment author's IP address, or an empty string if it's not available.
    278278     * @param string     $comment_ID        The comment ID as a numeric string.
    279279     * @param WP_Comment $comment           The comment object.
Note: See TracChangeset for help on using the changeset viewer.