wp_create_user_request( string $email_address = '', string $action_name = '', array $request_data = array(), string $status = 'pending' ): int|WP_Error

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$email_addressstringoptional

User email address. This can be the address of a registered or non-registered user.Default: ''

$action_namestringoptional

Name of the action that is being confirmed. Required.Default: ''

$request_dataarrayoptional

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

$statusstringoptional

Optional request status (pending or confirmed). Default 'pending'.Default: 'pending'

Return value

int|WP_Error

Returns the request ID if successful, or a WP_Error object on failure.

Performance profile

How much work a call to wp_create_user_request() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_user_by().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

24–74

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 107.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_user_by()called directly
• hookthird-party callbacksapply_filters()one call below wp_create_user_request()
• optionoption read or writeget_option()one call below wp_create_user_request()

Further down the call graph this can also reach cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_create_user_request() can have, taken from its control-flow graph on PHP 8.5.

Uses · 12

• sanitize_email()Strips out all characters that are not allowable in an email.
• sanitize_key()Sanitizes a string key.
• is_email()Verifies that an email is valid.
• __()Retrieves the translation of $text.
• _wp_privacy_action_request_types()Gets all personal data request types.
• get_user_by()Retrieves user info by a given field.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_insert_post()Inserts or update a post.
• wp_json_encode()Encodes a variable into JSON, with some confidence checks.
• current_time()Retrieves the current time based on specified type.
• WP_Error::__construct()Initializes the error.
• WP_Query::__construct()Constructor.

Used by · 1

• _wp_personal_data_handle_actions()Handle list table actions.

Source code

View on Trac ↗View on GitHub ↗

4745function wp_create_user_request( $email_address = '', $action_name = '', $request_data = array(), $status = 'pending' ) {4746	$email_address = sanitize_email( $email_address );4747	$action_name   = sanitize_key( $action_name );4748 4749	if ( ! is_email( $email_address ) ) {4750		return new WP_Error( 'invalid_email', __( 'Invalid email address.' ) );4751	}4752 4753	if ( ! in_array( $action_name, _wp_privacy_action_request_types(), true ) ) {4754		return new WP_Error( 'invalid_action', __( 'Invalid action name.' ) );4755	}4756 4757	if ( ! in_array( $status, array( 'pending', 'confirmed' ), true ) ) {4758		return new WP_Error( 'invalid_status', __( 'Invalid request status.' ) );4759	}4760 4761	$user    = get_user_by( 'email', $email_address );4762	$user_id = $user && ! is_wp_error( $user ) ? $user->ID : 0;4763 4764	// Check for duplicates.4765	$requests_query = new WP_Query(4766		array(4767			'post_type'     => 'user_request',4768			'post_name__in' => array( $action_name ), // Action name stored in post_name column.4769			'title'         => $email_address,        // Email address stored in post_title column.4770			'post_status'   => array(4771				'request-pending',4772				'request-confirmed',4773			),4774			'fields'        => 'ids',4775		)4776	);4777 4778	if ( $requests_query->found_posts ) {4779		return new WP_Error( 'duplicate_request', __( 'An incomplete personal data request for this email address already exists.' ) );4780	}4781 4782	$request_id = wp_insert_post(4783		array(4784			'post_author'   => $user_id,4785			'post_name'     => $action_name,4786			'post_title'    => $email_address,4787			'post_content'  => wp_json_encode( $request_data ),4788			'post_status'   => 'request-' . $status,4789			'post_type'     => 'user_request',4790			'post_date'     => current_time( 'mysql', false ),4791			'post_date_gmt' => current_time( 'mysql', true ),4792		),4793		true4794	);4795 4796	return $request_id;4797}

Changelog

Introduced in 4.9.6. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/user.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.