wp_create_user_request() WordPress Function

The wp_create_user_request function is used to create a user request. A user request is a request made by a user to change their user information. This function is typically used when a user wants to change their password or email address.

wp_create_user_request( string $email_address = '', string $action_name = '', array $request_data = array(), string $status = 'pending' ) #

Creates and logs a user request to perform a specific action.


Description

Requests are stored inside a post type named user_request since they can apply to both users on the site, or guests without a user account.


Top ↑

Parameters

$email_address

(string)(Optional)User email address. This can be the address of a registered or non-registered user.

Default value: ''

$action_name

(string)(Optional)Name of the action that is being confirmed. Required.

Default value: ''

$request_data

(array)(Optional)Misc data you want to send with the verification request and pass to the actions once the request is confirmed.

Default value: array()

$status

(string)(Optional)request status (pending or confirmed).

Default value: 'pending'


Top ↑

Return

(int|WP_Error) Returns the request ID if successful, or a WP_Error object on failure.


Top ↑

Source

File: wp-includes/user.php

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 );

	if ( ! is_email( $email_address ) ) {
		return new WP_Error( 'invalid_email', __( 'Invalid email address.' ) );
	}

	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.' ) );
	}

	$user    = get_user_by( 'email', $email_address );
	$user_id = $user && ! is_wp_error( $user ) ? $user->ID : 0;

	// Check for duplicates.
	$requests_query = new WP_Query(
		array(
			'post_type'     => 'user_request',
			'post_name__in' => array( $action_name ), // Action name stored in post_name column.
			'title'         => $email_address,        // Email address stored in post_title column.
			'post_status'   => array(
				'request-pending',
				'request-confirmed',
			),
			'fields'        => 'ids',
		)
	);

	if ( $requests_query->found_posts ) {
		return new WP_Error( 'duplicate_request', __( 'An incomplete personal data request for this email address already exists.' ) );
	}

	$request_id = wp_insert_post(
		array(
			'post_author'   => $user_id,
			'post_name'     => $action_name,
			'post_title'    => $email_address,
			'post_content'  => wp_json_encode( $request_data ),
			'post_status'   => 'request-' . $status,
			'post_type'     => 'user_request',
			'post_date'     => current_time( 'mysql', false ),
			'post_date_gmt' => current_time( 'mysql', true ),
		),
		true
	);

	return $request_id;
}


Top ↑

Changelog

Changelog
VersionDescription
5.7.0Added the $status parameter.
4.9.6Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More