wp_privacy_personal_data_export_page
Filters a page of personal data exporter data. Used to build the export report.
Allows the export response to be consumed by destinations in addition to Ajax.
Usage
add_filter( 'wp_privacy_personal_data_export_page', 'wp_kama_privacy_personal_data_export_page_filter', 10, 7 ); /** * Function for `wp_privacy_personal_data_export_page` filter-hook. * * @param array $response The personal data for the given exporter and page number. * @param int $exporter_index The index of the exporter that provided this data. * @param string $email_address The email address associated with this personal data. * @param int $page The page number for this response. * @param int $request_id The privacy request post ID associated with this request. * @param bool $send_as_email Whether the final results of the export should be emailed to the user. * @param string $exporter_key The key (slug) of the exporter that provided this data. * * @return array */ function wp_kama_privacy_personal_data_export_page_filter( $response, $exporter_index, $email_address, $page, $request_id, $send_as_email, $exporter_key ){ // filter... return $response; }
- $response(array)
- The personal data for the given exporter and page number.
- $exporter_index(int)
- The index of the exporter that provided this data.
- $email_address(string)
- The email address associated with this personal data.
- $page(int)
- The page number for this response.
- $request_id(int)
- The privacy request post ID associated with this request.
- $send_as_email(true|false)
- Whether the final results of the export should be emailed to the user.
- $exporter_key(string)
- The key (slug) of the exporter that provided this data.
Changelog
Since 4.9.6 | Introduced. |
Where the hook is called
wp_privacy_personal_data_export_page
wp-admin/includes/ajax-actions.php 5096
$response = apply_filters( 'wp_privacy_personal_data_export_page', $response, $exporter_index, $email_address, $page, $request_id, $send_as_email, $exporter_key );
Where the hook is used in WordPress
wp-admin/includes/admin-filters.php 154
add_filter( 'wp_privacy_personal_data_export_page', 'wp_privacy_process_personal_data_export_page', 10, 7 );