wp_privacy_personal_data_email_content WordPress Filter Hook

The wp_privacy_personal_data_email_content hook allows you to customize the content of the email that is sent to a user when they request their personal data.

apply_filters( 'wp_privacy_personal_data_email_content', string $email_text, int $request_id, array $email_data ) #

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


Description

The following strings have a special meaning and will get replaced dynamically:

Top ↑

EXPIRATION### The date when the URL will be automatically deleted.

Top ↑

Top ↑

SITENAME### The name of the site.

Top ↑

SITEURL### The URL to the site.


Top ↑

Parameters

$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. Defaults to the 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


Top ↑

Source

File: wp-admin/includes/privacy-tools.php

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
5.3.0Introduced the $email_data array.
4.9.6Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.