From e2a5b8684e4693c3114d52481cf38054a1ad4a6f Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Wed, 20 Jul 2022 14:14:09 +0000 Subject: [PATCH] Coding Standards: Standardize on `user_id` when passing data to comment functions. The `wp_new_comment()`, `wp_update_comment()`, and `wp_filter_comment()` functions already normalize the `user_ID` parameter internally to `user_id`, which matches the database field name. This commit aims to bring some consistency when passing the parameter in core. The corresponding `$user_ID` variable is also renamed to `$user_id` to match the other variables when not referring to the `$user_ID` global, which has an exception in the WordPress coding standards. Follow-up to [8543], [8720], [12267], [12300], [26491], [28915], [28922], [34799], [49303]. See #55647, #56244. Built from https://develop.svn.wordpress.org/trunk@53729 git-svn-id: http://core.svn.wordpress.org/trunk@53288 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/includes/ajax-actions.php | 4 ++-- wp-includes/class-wp-xmlrpc-server.php | 4 ++-- wp-includes/comment.php | 22 +++++++++++-------- .../class-wp-rest-comments-controller.php | 4 ++-- wp-includes/version.php | 2 +- 5 files changed, 20 insertions(+), 16 deletions(-) diff --git a/wp-admin/includes/ajax-actions.php b/wp-admin/includes/ajax-actions.php index f810223e08..ffb80e2369 100644 --- a/wp-admin/includes/ajax-actions.php +++ b/wp-admin/includes/ajax-actions.php @@ -1297,7 +1297,7 @@ function wp_ajax_replyto_comment( $action ) { $user = wp_get_current_user(); if ( $user->exists() ) { - $user_ID = $user->ID; + $user_id = $user->ID; $comment_author = wp_slash( $user->display_name ); $comment_author_email = wp_slash( $user->user_email ); $comment_author_url = wp_slash( $user->user_url ); @@ -1343,7 +1343,7 @@ function wp_ajax_replyto_comment( $action ) { 'comment_content', 'comment_type', 'comment_parent', - 'user_ID' + 'user_id' ); // Automatically approve parent comment. diff --git a/wp-includes/class-wp-xmlrpc-server.php b/wp-includes/class-wp-xmlrpc-server.php index f9cd1eed95..7e746ebdd6 100644 --- a/wp-includes/class-wp-xmlrpc-server.php +++ b/wp-includes/class-wp-xmlrpc-server.php @@ -3950,7 +3950,7 @@ class wp_xmlrpc_server extends IXR_Server { $comment['comment_author'] = $this->escape( $display_name ); $comment['comment_author_email'] = $this->escape( $user_email ); $comment['comment_author_url'] = $this->escape( $user_url ); - $comment['user_ID'] = $user->ID; + $comment['user_id'] = $user->ID; } else { $comment['comment_author'] = ''; if ( isset( $content_struct['author'] ) ) { @@ -3967,7 +3967,7 @@ class wp_xmlrpc_server extends IXR_Server { $comment['comment_author_url'] = $content_struct['author_url']; } - $comment['user_ID'] = 0; + $comment['user_id'] = 0; if ( get_option( 'require_name_email' ) ) { if ( strlen( $comment['comment_author_email'] ) < 6 || '' === $comment['comment_author'] ) { diff --git a/wp-includes/comment.php b/wp-includes/comment.php index 887f3af5ae..70d7a488dd 100644 --- a/wp-includes/comment.php +++ b/wp-includes/comment.php @@ -2089,12 +2089,12 @@ function wp_filter_comment( $commentdata ) { /** * Filters the comment author's user ID before it is set. * - * The first time this filter is evaluated, 'user_ID' is checked - * (for back-compat), followed by the standard 'user_id' value. + * The first time this filter is evaluated, `user_ID` is checked + * (for back-compat), followed by the standard `user_id` value. * * @since 1.5.0 * - * @param int $user_ID The comment author's user ID. + * @param int $user_id The comment author's user ID. */ $commentdata['user_id'] = apply_filters( 'pre_user_id', $commentdata['user_ID'] ); } elseif ( isset( $commentdata['user_id'] ) ) { @@ -2132,7 +2132,9 @@ function wp_filter_comment( $commentdata ) { $commentdata['comment_author_url'] = apply_filters( 'pre_comment_author_url', $commentdata['comment_author_url'] ); /** This filter is documented in wp-includes/comment.php */ $commentdata['comment_author_email'] = apply_filters( 'pre_comment_author_email', $commentdata['comment_author_email'] ); - $commentdata['filtered'] = true; + + $commentdata['filtered'] = true; + return $commentdata; } @@ -2265,11 +2267,13 @@ function wp_new_comment( $commentdata, $wp_error = false ) { $commentdata = wp_filter_comment( $commentdata ); $commentdata['comment_approved'] = wp_allow_comment( $commentdata, $wp_error ); + if ( is_wp_error( $commentdata['comment_approved'] ) ) { return $commentdata['comment_approved']; } $comment_ID = wp_insert_comment( $commentdata ); + if ( ! $comment_ID ) { $fields = array( 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_content' ); @@ -2468,6 +2472,7 @@ function wp_update_comment( $commentarr, $wp_error = false ) { // First, get all of the original fields. $comment = get_comment( $commentarr['comment_ID'], ARRAY_A ); + if ( empty( $comment ) ) { if ( $wp_error ) { return new WP_Error( 'invalid_comment_id', __( 'Invalid comment ID.' ) ); @@ -3421,14 +3426,13 @@ function _close_comments_for_old_post( $open, $post_id ) { * @return WP_Comment|WP_Error A WP_Comment object on success, a WP_Error object on failure. */ function wp_handle_comment_submission( $comment_data ) { - $comment_post_id = 0; - $comment_parent = 0; - $user_ID = 0; $comment_author = null; $comment_author_email = null; $comment_author_url = null; $comment_content = null; + $comment_parent = 0; + $user_id = 0; if ( isset( $comment_data['comment_post_ID'] ) ) { $comment_post_id = (int) $comment_data['comment_post_ID']; @@ -3553,7 +3557,7 @@ function wp_handle_comment_submission( $comment_data ) { $comment_author = $user->display_name; $comment_author_email = $user->user_email; $comment_author_url = $user->user_url; - $user_ID = $user->ID; + $user_id = $user->ID; if ( current_user_can( 'unfiltered_html' ) ) { if ( ! isset( $comment_data['_wp_unfiltered_html_comment'] ) @@ -3583,6 +3587,7 @@ function wp_handle_comment_submission( $comment_data ) { $commentdata = array( 'comment_post_ID' => $comment_post_id, + 'user_ID' => $user_id, ); $commentdata += compact( @@ -3592,7 +3597,6 @@ function wp_handle_comment_submission( $comment_data ) { 'comment_content', 'comment_type', 'comment_parent', - 'user_ID' ); /** diff --git a/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php b/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php index 7908257c3e..486e8e6d81 100644 --- a/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php +++ b/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php @@ -1883,11 +1883,11 @@ class WP_REST_Comments_Controller extends WP_REST_Controller { $prepared_comment, array( 'comment_post_ID' => 0, - 'comment_parent' => 0, - 'user_ID' => 0, 'comment_author' => null, 'comment_author_email' => null, 'comment_author_url' => null, + 'comment_parent' => 0, + 'user_id' => 0, ) ); diff --git a/wp-includes/version.php b/wp-includes/version.php index d97614e5e1..68e4a60341 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -16,7 +16,7 @@ * * @global string $wp_version */ -$wp_version = '6.1-alpha-53728'; +$wp_version = '6.1-alpha-53729'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.