wp_privacy_personal_data_email_headers
Filters the headers of the email sent with a personal data export file.
Usage
add_filter( 'wp_privacy_personal_data_email_headers', 'wp_kama_privacy_personal_data_email_headers_filter', 10, 5 ); /** * Function for `wp_privacy_personal_data_email_headers` filter-hook. * * @param string|array $headers The email headers. * @param string $subject The email subject. * @param string $content The email content. * @param int $request_id The request ID. * @param array $email_data Data relating to the account action email. * * @return string|array */ function wp_kama_privacy_personal_data_email_headers_filter( $headers, $subject, $content, $request_id, $email_data ){ // filter... return $headers; }
- $headers(string|array)
- The email headers.
- $subject(string)
- The email subject.
- $content(string)
- The email content.
- $request_id(int)
- The request ID.
- $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 5.4.0 | Introduced. |
Where the hook is called
wp_privacy_personal_data_email_headers
wp-admin/includes/privacy-tools.php 737
$headers = apply_filters( 'wp_privacy_personal_data_email_headers', $headers, $subject, $content, $request_id, $email_data );