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.
Built from https://develop.svn.wordpress.org/trunk@50165


git-svn-id: http://core.svn.wordpress.org/trunk@49844 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2021-02-02 20:42:03 +00:00
parent 4773bc5699
commit 8984e4ef8c
3 changed files with 9 additions and 5 deletions

View File

@ -114,7 +114,7 @@ function _wp_personal_data_handle_actions() {
$send_confirmation_email = true;
if ( ! isset( $_POST['send_confirmation_email'] ) ) {
$send_confirmation_email = false;
$send_confirmation_email = false;
}
if ( ! in_array( $action_type, _wp_privacy_action_request_types(), true ) ) {

View File

@ -3936,11 +3936,15 @@ function _wp_privacy_account_request_confirmed_message( $request_id ) {
* users on the site, or guests without a user account.
*
* @since 4.9.6
* @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 $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.
*/
function wp_create_user_request( $email_address = '', $action_name = '', $request_data = array(), $send_confirmation_email = true ) {

View File

@ -13,7 +13,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.7-alpha-50164';
$wp_version = '5.7-alpha-50165';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.