WordPress.org

Make WordPress Core

Changeset 50165


Ignore:
Timestamp:
02/02/2021 08:40:53 PM (6 months 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:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/privacy-tools.php

    r50159 r50165  
    115115
    116116                if ( ! isset( $_POST['send_confirmation_email'] ) ) {
    117                     $send_confirmation_email   = false;
     117                    $send_confirmation_email = false;
    118118                }
    119119
  • trunk/src/wp-includes/user.php

    r50159 r50165  
    39373937 *
    39383938 * @since 4.9.6
    3939  *
    3940  * @param string $email_address           User email address. This can be the address of a registered or non-registered user.
     3939 * @since 5.7.0 Added the `$send_confirmation_email` parameter.
     3940 *
     3941 * @param string $email_address           User email address. This can be the address of a registered
     3942 *                                        or non-registered user.
    39413943 * @param string $action_name             Name of the action that is being confirmed. Required.
    3942  * @param array  $request_data            Misc data you want to send with the verification request and pass to the actions once the request is confirmed.
    3943  * @param bool   $send_confirmation_email Optional. True by default, if false is passed the request status is set to Completed directly.
     3944 * @param array  $request_data            Misc data you want to send with the verification request and pass
     3945 *                                        to the actions once the request is confirmed.
     3946 * @param bool   $send_confirmation_email Optional. If false, the request status is set to 'Completed' directly.
     3947 *                                        Default true.
    39443948 * @return int|WP_Error                   Returns the request ID if successful, or a WP_Error object on failure.
    39453949 */
Note: See TracChangeset for help on using the changeset viewer.