_wp_privacy_send_erasure_fulfillment_notification( int $request_id )

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

The privacy request post ID associated with this request.

Performance profile

How much work a call to _wp_privacy_send_erasure_fulfillment_notification() 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

8–167

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

Plugin surface

7 hooks

Third-party callbacks on 'user_erasure_fulfillment_email_to', 'user_erasure_complete_email_subject', 'user_erasure_fulfillment_email_subject' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

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

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 · 18 distinct outcomes

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

Hooks and filters fired · 7

7 hooks fire while _wp_privacy_send_erasure_fulfillment_notification() runs, in this order:

1. 1
   apply_filters( user_erasure_fulfillment_email_to )filterline 4422 (+28 into the body)

   Filters the recipient of the data erasure fulfillment notification.

2. 2
   do_action( user_erasure_complete_email_subject )filter_deprecatedline 4458 (+64 into the body)

   Filters the subject of the email sent when an erasure request is completed.

3. 3
   apply_filters( user_erasure_fulfillment_email_subject )filterline 4484 (+90 into the body)

   Filters the subject of the email sent when an erasure request is completed.

4. 4
   do_action( user_confirmed_action_email_content )filter_deprecatedline 4546 (+152 into the body)

   Filters the body of the user request confirmation email.

5. 5
   apply_filters( user_erasure_fulfillment_email_content )filterline 4585 (+191 into the body)

   Filters the body of the data erasure fulfillment notification.

6. 6
   do_action( user_erasure_complete_email_headers )filter_deprecatedline 4615 (+221 into the body)

   Filters the headers of the data erasure fulfillment notification.

7. 7
   apply_filters( user_erasure_fulfillment_email_headers )filterline 4643 (+249 into the body)

   Filters the headers of the data erasure fulfillment notification.

Uses · 16

• wp_get_user_request()Returns the user request object for the specified request ID.
• get_post_meta()Retrieves a post meta field for the given post ID.
• 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.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_privacy_policy_url()Retrieves the URL to the privacy policy page.
• wp_specialchars_decode()Converts a number of HTML entities into their special characters.
• get_option()Retrieves an option value based on an option name.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• __()Retrieves the translation of $text.
• apply_filters_deprecated()Fires functions attached to a deprecated filter hook.

Source code

View on Trac ↗View on GitHub ↗

4394function _wp_privacy_send_erasure_fulfillment_notification( $request_id ) {4395	$request = wp_get_user_request( $request_id );4396 4397	if ( ! ( $request instanceof WP_User_Request ) || 'request-completed' !== $request->status ) {4398		return;4399	}4400 4401	$already_notified = (bool) get_post_meta( $request_id, '_wp_user_notified', true );4402 4403	if ( $already_notified ) {4404		return;4405	}4406 4407	// Localize message content for user; fallback to site default for visitors.4408	if ( ! empty( $request->user_id ) ) {4409		$switched_locale = switch_to_user_locale( $request->user_id );4410	} else {4411		$switched_locale = switch_to_locale( get_locale() );4412	}4413 4414	/**4415	 * Filters the recipient of the data erasure fulfillment notification.4416	 *4417	 * @since 4.9.64418	 *4419	 * @param string          $user_email The email address of the notification recipient.4420	 * @param WP_User_Request $request    The request that is initiating the notification.4421	 */4422	$user_email = apply_filters( 'user_erasure_fulfillment_email_to', $request->email, $request );4423 4424	$email_data = array(4425		'request'            => $request,4426		'message_recipient'  => $user_email,4427		'privacy_policy_url' => get_privacy_policy_url(),4428		'sitename'           => wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ),4429		'siteurl'            => home_url(),4430	);4431 4432	$subject = sprintf(4433		/* translators: Erasure request fulfilled notification email subject. %s: Site title. */4434		__( '[%s] Erasure Request Fulfilled' ),4435		$email_data['sitename']4436	);4437 4438	/**4439	 * Filters the subject of the email sent when an erasure request is completed.4440	 *4441	 * @since 4.9.84442	 * @deprecated 5.8.0 Use {@see 'user_erasure_fulfillment_email_subject'} instead.4443	 *4444	 * @param string $subject    The email subject.4445	 * @param string $sitename   The name of the site.4446	 * @param array  $email_data {4447	 *     Data relating to the account action email.4448	 *4449	 *     @type WP_User_Request $request            User request object.4450	 *     @type string          $message_recipient  The address that the email will be sent to. Defaults4451	 *                                               to the value of `$request->email`, but can be changed4452	 *                                               by the `user_erasure_fulfillment_email_to` filter.4453	 *     @type string          $privacy_policy_url Privacy policy URL.4454	 *     @type string          $sitename           The site name sending the mail.4455	 *     @type string          $siteurl            The site URL sending the mail.4456	 * }4457	 */4458	$subject = apply_filters_deprecated(4459		'user_erasure_complete_email_subject',4460		array( $subject, $email_data['sitename'], $email_data ),4461		'5.8.0',4462		'user_erasure_fulfillment_email_subject'4463	);4464 4465	/**4466	 * Filters the subject of the email sent when an erasure request is completed.4467	 *4468	 * @since 5.8.04469	 *4470	 * @param string $subject    The email subject.4471	 * @param string $sitename   The name of the site.4472	 * @param array  $email_data {4473	 *     Data relating to the account action email.

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