wppaste
WordPress

apply_filters( 'wp_privacy_personal_data_erasure_page', array $response, int $eraser_index, string $email_address, int $page, int $request_id, string $eraser_key )

Since
4.9.6
Filters a page of personal data eraser data.

Description

Allows the erasure response to be consumed by destinations in addition to Ajax.

Compatibility

WordPress
since 4.9.6
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$responsearray
{ 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.
}
  • $items_removedbool

    Whether items were actually removed or not.
  • $items_retainedbool

    Whether items were retained or not.
  • $messagesstring[]

    An array of messages to add to the personal data export file.
  • $donebool

    Whether the eraser is finished or not.
$eraser_indexint
The index of the eraser that provided this data.
$email_addressstring
The email address associated with this personal data.
$pageint
The page number for this response.
$request_idint
The privacy request post ID associated with this request.
$eraser_keystring
The key (slug) of the eraser that provided this data.

Where this hook fires · 1

  • wp-admin/includes/ajax-actions.php:5337wp_ajax_wp_privacy_erase_personal_data()

Source code

	 * @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.	 */	$response = apply_filters( 'wp_privacy_personal_data_erasure_page', $response, $eraser_index, $email_address, $page, $request_id, $eraser_key ); 	if ( is_wp_error( $response ) ) {		wp_send_json_error( $response );	} 	wp_send_json_success( $response );

Changelog

Introduced in 4.9.6. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.