Filter hook 'wp_privacy_personal_data_erasure_page'

in WP Core File wp-admin/includes/ajax-actions.php at line 5337

View Source

wp_privacy_personal_data_erasure_page

Filter Hook
Description
Filters a page of personal data eraser data. Allows the erasure response to be consumed by destinations in addition to Ajax. }

Hook Information

File Location wp-admin/includes/ajax-actions.php View on GitHub
Hook Type Filter
Line Number 5337

Hook Parameters

Type Name Description
array $response { The personal data for the given exporter and page number.
int $eraser_index The index of the eraser that provided this data.
string $email_address The email address associated with this personal data.
int $page The page number for this response.
int $request_id The privacy request post ID associated with this request.
string $eraser_key The key (slug) of the eraser that provided this data.

Usage Examples

Basic Usage
<?php
// Hook into wp_privacy_personal_data_erasure_page
add_filter('wp_privacy_personal_data_erasure_page', 'my_custom_filter', 10, 6);

function my_custom_filter($response, $eraser_index, $email_address, $page, $request_id, $eraser_key) {
    // Your custom filtering logic here
    return $response;
}

Source Code Context

wp-admin/includes/ajax-actions.php:5337 - How this hook is used in WordPress core
<?php
5332  	 * @param string $email_address   The email address associated with this personal data.
5333  	 * @param int    $page            The page number for this response.
5334  	 * @param int    $request_id      The privacy request post ID associated with this request.
5335  	 * @param string $eraser_key      The key (slug) of the eraser that provided this data.
5336  	 */
5337  	$response = apply_filters( 'wp_privacy_personal_data_erasure_page', $response, $eraser_index, $email_address, $page, $request_id, $eraser_key );
5338  
5339  	if ( is_wp_error( $response ) ) {
5340  		wp_send_json_error( $response );
5341  	}
5342  

PHP Documentation

<?php
/**
	 * Filters a page of personal data eraser data.
	 *
	 * Allows the erasure response to be consumed by destinations in addition to Ajax.
	 *
	 * @since 4.9.6
	 *
	 * @param array  $response        {
	 *     The personal data for the given exporter and page number.
	 *
	 *     @type bool     $items_removed  Whether items were actually removed or not.
	 *     @type bool     $items_retained Whether items were retained or not.
	 *     @type string[] $messages       An array of messages to add to the personal data export file.
	 *     @type bool     $done           Whether the eraser is finished or not.
	 * }
	 * @param int    $eraser_index    The index of the eraser 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 string $eraser_key      The key (slug) of the eraser that provided this data.
	 */
Quick Info
  • Hook Type: Filter
  • Parameters: 6
  • File: wp-admin/includes/ajax-actions.php
Related Hooks

Related hooks will be displayed here in future updates.