wp_privacy_personal_data_email_content filter-hookWP 4.9.6

Filters the text of the email sent with a personal data export file.

The following strings have a special meaning and will get replaced dynamically: ###EXPIRATION### The date when the URL will be automatically deleted.

LINK### URL of the personal data export file for the user.

SITENAME### The name of the site.

SITEURL### The URL to the site.

Usage

add_filter( 'wp_privacy_personal_data_email_content', 'wp_kama_privacy_personal_data_email_content_filter', 10, 3 );

/**
 * Function for `wp_privacy_personal_data_email_content` filter-hook.
 * 
 * @param string $email_text Text in the email.
 * @param int    $request_id The request ID for this personal data export.
 * @param array  $email_data Data relating to the account action email.
 *
 * @return string
 */
function wp_kama_privacy_personal_data_email_content_filter( $email_text, $request_id, $email_data ){

	// filter...
	return $email_text;
}
$email_text(string)
Text in the email.
$request_id(int)
The request ID for this personal data export.
$email_data(array)

Data relating to the account action email.

  • request(WP_User_Request)
    User request object.

  • expiration(int)
    The time in seconds until the export file expires.

  • expiration_date(string)
    The localized date and time when the export file expires.

  • message_recipient(string)
    The address that the email will be sent to.
    Default: value of $request->email, but can be changed by the wp_privacy_personal_data_email_to filter

  • export_file_url(string)
    The export file URL.

  • sitename(string)
    The site name sending the mail.

  • siteurl(string)
    The site URL sending the mail.

Changelog

Since 4.9.6 Introduced.
Since 5.3.0 Introduced the $email_data array.

Where the hook is called

wp_privacy_send_personal_data_export_email()
wp_privacy_personal_data_email_content
wp-admin/includes/privacy-tools.php 704
$content = apply_filters( 'wp_privacy_personal_data_email_content', $email_text, $request_id, $email_data );

Where the hook is used in WordPress

Usage not found.