Changeset 44606 for trunk/src/wp-includes/user.php

Timestamp:

01/15/2019 10:34:39 PM (8 years ago)

Author:

desrosj

Message:

Privacy: Use consistent variable naming when working with privacy requests.

Throughout the core privacy functions, WP_User_Request instances were stored in variables named both $request, and $request_data. This changes all occurrences of $request_data to $request for better consistency.

Props nateallen, bruceallen, garrett-eclipse.
Fixes #44708.

File:

• trunk/src/wp-includes/user.php (modified) (6 diffs)

trunk/src/wp-includes/user.php

@@ -2963 +2963 @@
  */
 function _wp_privacy_account_request_confirmed( $request_id ) {
-        $request_data = wp_get_user_request_data( $request_id );
-
-        if ( ! $request_data ) {
+        $request = wp_get_user_request_data( $request_id );
+
+        if ( ! $request ) {
                 return;
         }
 
-        if ( ! in_array( $request_data->status, array( 'request-pending', 'request-failed' ), true ) ) {
+        if ( ! in_array( $request->status, array( 'request-pending', 'request-failed' ), true ) ) {
                 return;
         }
@@ -2993 +2993 @@
  */
 function _wp_privacy_send_request_confirmation_notification( $request_id ) {
-        $request_data = wp_get_user_request_data( $request_id );
-
-        if ( ! is_a( $request_data, 'WP_User_Request' ) || 'request-confirmed' !== $request_data->status ) {
+        $request = wp_get_user_request_data( $request_id );
+
+        if ( ! is_a( $request, 'WP_User_Request' ) || 'request-confirmed' !== $request->status ) {
                 return;
         }
@@ -3005 +3005 @@
         }
 
-        $manage_url         = add_query_arg( 'page', $request_data->action_name, admin_url( 'tools.php' ) );
-        $action_description = wp_user_request_action_description( $request_data->action_name );
+        $manage_url         = add_query_arg( 'page', $request->action_name, admin_url( 'tools.php' ) );
+        $action_description = wp_user_request_action_description( $request->action_name );
 
         /**
@@ -3019 +3019 @@
          * @since 4.9.6
          *
-         * @param string          $admin_email  The email address of the notification recipient.
-         * @param WP_User_Request $request_data The request that is initiating the notification.
-         */
-        $admin_email = apply_filters( 'user_request_confirmed_email_to', get_site_option( 'admin_email' ), $request_data );
+         * @param string          $admin_email The email address of the notification recipient.
+         * @param WP_User_Request $request     The request that is initiating the notification.
+         */
+        $admin_email = apply_filters( 'user_request_confirmed_email_to', get_site_option( 'admin_email' ), $request );
 
         $email_data = array(
-                'request'     => $request_data,
-                'user_email'  => $request_data->email,
+                'request'     => $request,
+                'user_email'  => $request->email,
                 'description' => $action_description,
                 'manage_url'  => $manage_url,
@@ -3132 +3132 @@
  */
 function _wp_privacy_send_erasure_fulfillment_notification( $request_id ) {
-        $request_data = wp_get_user_request_data( $request_id );
-
-        if ( ! is_a( $request_data, 'WP_User_Request' ) || 'request-completed' !== $request_data->status ) {
+        $request = wp_get_user_request_data( $request_id );
+
+        if ( ! is_a( $request, 'WP_User_Request' ) || 'request-completed' !== $request->status ) {
                 return;
         }
@@ -3149 +3149 @@
          * @since 4.9.6
          *
-         * @param string          $user_email   The email address of the notification recipient.
-         * @param WP_User_Request $request_data The request that is initiating the notification.
-         */
-        $user_email = apply_filters( 'user_erasure_fulfillment_email_to', $request_data->email, $request_data );
+         * @param string          $user_email The email address of the notification recipient.
+         * @param WP_User_Request $request    The request that is initiating the notification.
+         */
+        $user_email = apply_filters( 'user_erasure_fulfillment_email_to', $request->email, $request );
 
         $email_data = array(
-                'request'            => $request_data,
+                'request'            => $request,
                 'message_recipient'  => $user_email,
                 'privacy_policy_url' => get_privacy_policy_url(),