wp_send_user_request( int $request_id ): true|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

$request_idint

ID of the request created via wp_create_user_request().

Return value

true|WP_Error

True on success, WP_Error on failure.

Performance profile

How much work a call to wp_send_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

Expensive

Sends mail via wp_mail().

Scaling

Constant

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

Instructions

18–145

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

Plugin surface

3 hooks

Third-party callbacks on 'user_request_action_email_subject', 'user_request_action_email_content', 'user_request_action_email_headers' run inside this call, and their cost is not bounded by anything here.

Called by

2

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

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• mailsends mailwp_mail()called directly
• querycontent queryget_post()one call below wp_send_user_request()
• cacheobject cachewp_cache_get()one call below wp_send_user_request()
• serializeserialisationmaybe_unserialize()one call below wp_send_user_request()

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

What one call costs · 9 distinct outcomes

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

Hooks and filters fired · 3

3 hooks fire while wp_send_user_request() runs, in this order:

1. 1
   apply_filters( user_request_action_email_subject )filterline 4901 (+59 into the body)

   Filters the subject of the email sent when an account action is attempted.

2. 2
   apply_filters( user_request_action_email_content )filterline 4946 (+104 into the body)

   Filters the text of the email sent when an account action is attempted.

3. 3
   apply_filters( user_request_action_email_headers )filterline 4976 (+134 into the body)

   Filters the headers of the email sent when an account action is attempted.

Uses · 18

• absint()Converts a value to non-negative integer.
• wp_get_user_request()Returns the user request object for the specified request ID.
• __()Retrieves the translation of $text.
• switch_to_user_locale()Switches the translations according to the given user's locale.
• switch_to_locale()Switches the translations according to the given locale.
• get_locale()Retrieves the current locale.
• wp_generate_user_request_key()Returns a confirmation key for a user action and stores the hashed version for future comparison.
• wp_user_request_action_description()Gets action description from the name and return a string.
• add_query_arg()Retrieves a modified URL query string.
• wp_login_url()Retrieves the login URL.
• wp_specialchars_decode()Converts a number of HTML entities into their special characters.
• get_option()Retrieves an option value based on an option name.

Used by · 2

• _wp_personal_data_handle_actions()Handle list table actions.
• _wp_privacy_resend_request()Resend an existing request and return the result.

Source code

View on Trac ↗View on GitHub ↗

4842function wp_send_user_request( $request_id ) {4843	$request_id = absint( $request_id );4844	$request    = wp_get_user_request( $request_id );4845 4846	if ( ! $request ) {4847		return new WP_Error( 'invalid_request', __( 'Invalid personal data request.' ) );4848	}4849 4850	// Localize message content for user; fallback to site default for visitors.4851	if ( ! empty( $request->user_id ) ) {4852		$switched_locale = switch_to_user_locale( $request->user_id );4853	} else {4854		$switched_locale = switch_to_locale( get_locale() );4855	}4856 4857	/*4858	 * Generate the new user request key first, as it is used by both the $request4859	 * object and the confirm_url array.4860	 * See https://core.trac.wordpress.org/ticket/449404861	 */4862	$request->confirm_key = wp_generate_user_request_key( $request_id );4863 4864	$email_data = array(4865		'request'     => $request,4866		'email'       => $request->email,4867		'description' => wp_user_request_action_description( $request->action_name ),4868		'confirm_url' => add_query_arg(4869			array(4870				'action'      => 'confirmaction',4871				'request_id'  => $request_id,4872				'confirm_key' => $request->confirm_key,4873			),4874			wp_login_url()4875		),4876		'sitename'    => wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ),4877		'siteurl'     => home_url(),4878	);4879 4880	/* translators: Confirm privacy data request notification email subject. 1: Site title, 2: Name of the action. */4881	$subject = sprintf( __( '[%1$s] Confirm Action: %2$s' ), $email_data['sitename'], $email_data['description'] );4882 4883	/**4884	 * Filters the subject of the email sent when an account action is attempted.4885	 *4886	 * @since 4.9.64887	 *4888	 * @param string $subject    The email subject.4889	 * @param string $sitename   The name of the site.4890	 * @param array  $email_data {4891	 *     Data relating to the account action email.4892	 *4893	 *     @type WP_User_Request $request     User request object.4894	 *     @type string          $email       The email address this is being sent to.4895	 *     @type string          $description Description of the action being performed so the user knows what the email is for.4896	 *     @type string          $confirm_url The link to click on to confirm the account action.4897	 *     @type string          $sitename    The site name sending the mail.4898	 *     @type string          $siteurl     The site URL sending the mail.4899	 * }4900	 */4901	$subject = apply_filters( 'user_request_action_email_subject', $subject, $email_data['sitename'], $email_data );4902 4903	/* translators: Do not translate DESCRIPTION, CONFIRM_URL, SITENAME, SITEURL: those are placeholders. */4904	$content = __(4905		'Howdy,4906 4907A request has been made to perform the following action on your account:4908 4909     ###DESCRIPTION###4910 4911To confirm this, please click on the following link:4912###CONFIRM_URL###4913 4914You can safely ignore and delete this email if you do not want to4915take this action.4916 4917Regards,4918All at ###SITENAME###4919###SITEURL###'4920	);4921

Changelog

Introduced in 4.9.6. One change between 6.7.7 and 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.