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

Timestamp:

02/10/2020 07:55:51 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Privacy: Rename wp_get_user_request_data() to wp_get_user_request() for clarity; deprecate the old function.

The function returns an instance of the WP_User_Request object itself, not its $request_data property.

Follow-up to [44606].

Props garrett-eclipse.
Fixes #46302.

File:

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

trunk/src/wp-includes/user.php

@@ -3097 +3097 @@
  */
 function _wp_privacy_account_request_confirmed( $request_id ) {
-    $request = wp_get_user_request_data( $request_id );
+    $request = wp_get_user_request( $request_id );
 
     if ( ! $request ) {
@@ -3127 +3127 @@
  */
 function _wp_privacy_send_request_confirmation_notification( $request_id ) {
-    $request = wp_get_user_request_data( $request_id );
+    $request = wp_get_user_request( $request_id );
 
     if ( ! is_a( $request, 'WP_User_Request' ) || 'request-confirmed' !== $request->status ) {
@@ -3266 +3266 @@
  */
 function _wp_privacy_send_erasure_fulfillment_notification( $request_id ) {
-    $request = wp_get_user_request_data( $request_id );
+    $request = wp_get_user_request( $request_id );
 
     if ( ! is_a( $request, 'WP_User_Request' ) || 'request-completed' !== $request->status ) {
@@ -3416 +3416 @@
  */
 function _wp_privacy_account_request_confirmed_message( $request_id ) {
-    $request = wp_get_user_request_data( $request_id );
+    $request = wp_get_user_request( $request_id );
 
     $message  = '<p class="success">' . __( 'Action has been confirmed.' ) . '</p>';
@@ -3552 +3552 @@
 function wp_send_user_request( $request_id ) {
     $request_id = absint( $request_id );
-    $request    = wp_get_user_request_data( $request_id );
+    $request    = wp_get_user_request( $request_id );
 
     if ( ! $request ) {
@@ -3714 +3714 @@
 
     $request_id = absint( $request_id );
-    $request    = wp_get_user_request_data( $request_id );
+    $request    = wp_get_user_request( $request_id );
 
     if ( ! $request ) {
@@ -3766 +3766 @@
 
 /**
- * Return data about a user request.
+ * Return the user request object for the specified request ID.
  *
  * @since 4.9.6
  *
- * @param int $request_id Request ID to get data about.
+ * @param int $request_id The ID of the user request.
  * @return WP_User_Request|false
  */
-function wp_get_user_request_data( $request_id ) {
+function wp_get_user_request( $request_id ) {
     $request_id = absint( $request_id );
     $post       = get_post( $request_id );