user_erasure_fulfillment_email_content
Filters the body of the data erasure fulfillment notification.
The email is sent to a user when their data erasure request is fulfilled by an administrator.
The following strings have a special meaning and will get replaced dynamically:
###SITENAME###The name of the site.###PRIVACY_POLICY_URL###Privacy policy page URL.###SITEURL###The URL to the site.
Usage
add_filter( 'user_erasure_fulfillment_email_content', 'wp_kama_user_erasure_fulfillment_email_content_filter', 10, 2 );
/**
* Function for `user_erasure_fulfillment_email_content` filter-hook.
*
* @param string $content The email content.
* @param array $email_data Data relating to the account action email.
*
* @return string
*/
function wp_kama_user_erasure_fulfillment_email_content_filter( $content, $email_data ){
// filter...
return $content;
}
- $content(string)
- The email content.
- $email_data(array)
Data relating to the account action email.
-
request(WP_User_Request)
User request object. -
message_recipient(string)
The address that the email will be sent to.
Default: value of$request->email, but can be changed by theuser_erasure_fulfillment_email_tofilter -
privacy_policy_url(string)
Privacy policy URL. -
sitename(string)
The site name sending the mail. - siteurl(string)
The site URL sending the mail.
-
Changelog
| Since 5.8.0 | Introduced. |
Where the hook is called
user_erasure_fulfillment_email_content
wp-includes/user.php 4609
$content = apply_filters( 'user_erasure_fulfillment_email_content', $content, $email_data );