wp_privacy_personal_data_erasure_page │ filter-hook │ WP 4.9.6

Filters a page of personal data eraser data.

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

Usage

add_filter( 'wp_privacy_personal_data_erasure_page', 'wp_kama_privacy_personal_data_erasure_page_filter', 10, 6 );

/**
 * Function for `wp_privacy_personal_data_erasure_page` filter-hook.
 * 
 * @param array  $response      The personal data for the given exporter and page number.
 * @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.
 *
 * @return array
 */
function wp_kama_privacy_personal_data_erasure_page_filter( $response, $eraser_index, $email_address, $page, $request_id, $eraser_key ){

	// filter...
	return $response;
}

$response(array)

The personal data for the given exporter and page number.

• items_removed(true|false)
  Whether items were actually removed or not.

• items_retained(true|false)
  Whether items were retained or not.

• messages(string[])
  An array of messages to add to the personal data export file.

• done(true|false)
  Whether the eraser is finished or not.

$eraser_index(int)

The index of the eraser 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.

$eraser_key(string)

The key (slug) of the eraser that provided this data.

Changelog

Where the hook is called

$response = apply_filters( 'wp_privacy_personal_data_erasure_page', $response, $eraser_index, $email_address, $page, $request_id, $eraser_key );

Where the hook is used in WordPress

add_filter( 'wp_privacy_personal_data_erasure_page', 'wp_privacy_process_personal_data_erasure_page', 10, 5 );