Changeset 50165

Timestamp:

02/02/2021 08:40:53 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update documentation for wp_create_user_request() per the documentation standards.

Add a @since note for the $send_confirmation_email parameter.

Follow-up to [50159].

See #43890.

Location:

trunk/src

Files:

• wp-admin/includes/privacy-tools.php (modified) (1 diff)
• wp-includes/user.php (modified) (1 diff)

trunk/src/wp-admin/includes/privacy-tools.php

@@ -115 +115 @@
 
                 if ( ! isset( $_POST['send_confirmation_email'] ) ) {
-                    $send_confirmation_email   = false;
+                    $send_confirmation_email = false;
                 }
 

trunk/src/wp-includes/user.php

@@ -3937 +3937 @@
  *
  * @since 4.9.6
- *
- * @param string $email_address           User email address. This can be the address of a registered or non-registered user.
+ * @since 5.7.0 Added the `$send_confirmation_email` parameter.
+ *
+ * @param string $email_address           User email address. This can be the address of a registered
+ *                                        or non-registered user.
  * @param string $action_name             Name of the action that is being confirmed. Required.
- * @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. True by default, if false is passed the request status is set to Completed directly.
+ * @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.
  * @return int|WP_Error                   Returns the request ID if successful, or a WP_Error object on failure.
  */