wp_send_user_request( string $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_idstring

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–142

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

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 4795 (+52 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 4840 (+97 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 4870 (+127 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_user_request_action_description()Gets action description from the name and return a string.
• add_query_arg()Retrieves a modified URL query string.
• wp_generate_user_request_key()Returns a confirmation key for a user action and stores the hashed version for future comparison.
• 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 ↗

4743function wp_send_user_request( $request_id ) {4744	$request_id = absint( $request_id );4745	$request    = wp_get_user_request( $request_id );4746 4747	if ( ! $request ) {4748		return new WP_Error( 'invalid_request', __( 'Invalid personal data request.' ) );4749	}4750 4751	// Localize message content for user; fallback to site default for visitors.4752	if ( ! empty( $request->user_id ) ) {4753		$switched_locale = switch_to_user_locale( $request->user_id );4754	} else {4755		$switched_locale = switch_to_locale( get_locale() );4756	}4757 4758	$email_data = array(4759		'request'     => $request,4760		'email'       => $request->email,4761		'description' => wp_user_request_action_description( $request->action_name ),4762		'confirm_url' => add_query_arg(4763			array(4764				'action'      => 'confirmaction',4765				'request_id'  => $request_id,4766				'confirm_key' => wp_generate_user_request_key( $request_id ),4767			),4768			wp_login_url()4769		),4770		'sitename'    => wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ),4771		'siteurl'     => home_url(),4772	);4773 4774	/* translators: Confirm privacy data request notification email subject. 1: Site title, 2: Name of the action. */4775	$subject = sprintf( __( '[%1$s] Confirm Action: %2$s' ), $email_data['sitename'], $email_data['description'] );4776 4777	/**4778	 * Filters the subject of the email sent when an account action is attempted.4779	 *4780	 * @since 4.9.64781	 *4782	 * @param string $subject    The email subject.4783	 * @param string $sitename   The name of the site.4784	 * @param array  $email_data {4785	 *     Data relating to the account action email.4786	 *4787	 *     @type WP_User_Request $request     User request object.4788	 *     @type string          $email       The email address this is being sent to.4789	 *     @type string          $description Description of the action being performed so the user knows what the email is for.4790	 *     @type string          $confirm_url The link to click on to confirm the account action.4791	 *     @type string          $sitename    The site name sending the mail.4792	 *     @type string          $siteurl     The site URL sending the mail.4793	 * }4794	 */4795	$subject = apply_filters( 'user_request_action_email_subject', $subject, $email_data['sitename'], $email_data );4796 4797	/* translators: Do not translate DESCRIPTION, CONFIRM_URL, SITENAME, SITEURL: those are placeholders. */4798	$content = __(4799		'Howdy,4800 4801A request has been made to perform the following action on your account:4802 4803     ###DESCRIPTION###4804 4805To confirm this, please click on the following link:4806###CONFIRM_URL###4807 4808You can safely ignore and delete this email if you do not want to4809take this action.4810 4811Regards,4812All at ###SITENAME###4813###SITEURL###'4814	);4815 4816	/**4817	 * Filters the text of the email sent when an account action is attempted.4818	 *4819	 * The following strings have a special meaning and will get replaced dynamically:4820	 *4821	 * ###DESCRIPTION### Description of the action being performed so the user knows what the email is for.4822	 * ###CONFIRM_URL### The link to click on to confirm the account action.

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.7.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.