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

Timestamp:

02/05/2021 03:48:59 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Privacy: Rename the $send_confirmation_email parameter of wp_create_user_request() to $status, for clarity.

Follow-up to [50159], [50165].

Props xkon, TimothyBlynJacobs.
Fixes #52430. See #43890.

File:

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

trunk/src/wp-includes/user.php

@@ -3937 +3937 @@
  *
  * @since 4.9.6
- * @since 5.7.0 Added the `$send_confirmation_email` parameter.
+ * @since 5.7.0 Added the `$status` parameter.
  *
  * @param string $email_address           User email address. This can be the address of a registered
@@ -3944 +3944 @@
  * @param array  $request_data            Misc data you want to send with the verification request and pass
  *                                        to the actions once the request is confirmed.
- * @param bool   $send_confirmation_email Optional. If false, the request status is set to 'Completed' directly.
- *                                        Default true.
+ * @param string $status                  Optional request status (pending or confirmed). Default 'pending'.
  * @return int|WP_Error                   Returns the request ID if successful, or a WP_Error object on failure.
  */
-function wp_create_user_request( $email_address = '', $action_name = '', $request_data = array(), $send_confirmation_email = true ) {
+function wp_create_user_request( $email_address = '', $action_name = '', $request_data = array(), $status = 'pending' ) {
     $email_address = sanitize_email( $email_address );
     $action_name   = sanitize_key( $action_name );
@@ -3958 +3957 @@
     if ( ! in_array( $action_name, _wp_privacy_action_request_types(), true ) ) {
         return new WP_Error( 'invalid_action', __( 'Invalid action name.' ) );
+    }
+
+    if ( ! in_array( $status, array( 'pending', 'confirmed' ), true ) ) {
+        return new WP_Error( 'invalid_status', __( 'Invalid request status.' ) );
     }
 
@@ -3981 +3984 @@
     }
 
-    if ( false !== $send_confirmation_email ) {
-        $status = 'request-pending';
-    } else {
-        $status = 'request-completed';
-    }
-
     $request_id = wp_insert_post(
         array(
@@ -3993 +3990 @@
             'post_title'    => $email_address,
             'post_content'  => wp_json_encode( $request_data ),
-            'post_status'   => $status,
+            'post_status'   => 'request-' . $status,
             'post_type'     => 'user_request',
             'post_date'     => current_time( 'mysql', false ),