wp_privacy_process_personal_data_export_page( array $response, int $exporter_index, string $email_address, int $page, int $request_id, bool $send_as_email, string $exporter_key ): array

Parameters

$responsearray

The response from the personal data exporter for the given page.

$exporter_indexint

The index of the personal data exporter. Begins at 1.

$email_addressstring

The email address of the user whose personal data this is.

$pageint

The page of personal data for this exporter. Begins at 1.

$request_idint

The request ID for this personal data export.

$send_as_emailbool

Whether the final results of the export should be emailed to the user.

$exporter_keystring

The slug (key) of the exporter.

Return

array

The filtered response.

Hooks fired · 2

2 hooks fire while wp_privacy_process_personal_data_export_page() runs, in this order:

1. 1
   apply_filters( wp_privacy_personal_data_exporters )filterline 816 (+47 into the body)

   Filters the array of exporter callbacks.

2. 2
   do_action( wp_privacy_personal_data_export_file )actionline 865 (+96 into the body)

   Generate the export file from the collected, grouped personal data.

Uses · 12

• wp_get_user_request()Returns the user request object for the specified request ID.
• wp_send_json_error()Sends a JSON response back to an Ajax request, indicating failure.
• __()Retrieves the translation of $text.
• update_post_meta()Updates a post meta field based on the given post ID.
• get_post_meta()Retrieves a post meta field for the given post ID.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• delete_post_meta()Deletes a post meta field for the given post ID.
• do_action()Calls the callback functions that have been added to an action hook.
• wp_privacy_send_personal_data_export_email()Send an email to the user with a link to the personal data export file
• is_wp_error()Checks whether the given variable is a WordPress Error.
• _wp_privacy_completed_request()Marks a request as completed by the admin and logs the current timestamp.
• wp_privacy_exports_url()Returns the URL of the directory used to store personal data export files.

Source

View on Trac ↗View on GitHub ↗

769function wp_privacy_process_personal_data_export_page( $response, $exporter_index, $email_address, $page, $request_id, $send_as_email, $exporter_key ) {770	/* Do some simple checks on the shape of the response from the exporter.771	 * If the exporter response is malformed, don't attempt to consume it - let it772	 * pass through to generate a warning to the user by default Ajax processing.773	 */774	if ( ! is_array( $response ) ) {775		return $response;776	}777 778	if ( ! array_key_exists( 'done', $response ) ) {779		return $response;780	}781 782	if ( ! array_key_exists( 'data', $response ) ) {783		return $response;784	}785 786	if ( ! is_array( $response['data'] ) ) {787		return $response;788	}789 790	// Get the request.791	$request = wp_get_user_request( $request_id );792 793	if ( ! $request || 'export_personal_data' !== $request->action_name ) {794		wp_send_json_error( __( 'Invalid request ID when merging personal data to export.' ) );795	}796 797	$export_data = array();798 799	// First exporter, first page? Reset the report data accumulation array.800	if ( 1 === $exporter_index && 1 === $page ) {801		update_post_meta( $request_id, '_export_data_raw', $export_data );802	} else {803		$accumulated_data = get_post_meta( $request_id, '_export_data_raw', true );804 805		if ( $accumulated_data ) {806			$export_data = $accumulated_data;807		}808	}809 810	// Now, merge the data from the exporter response into the data we have accumulated already.811	$export_data = array_merge( $export_data, $response['data'] );812	update_post_meta( $request_id, '_export_data_raw', $export_data );813 814	// If we are not yet on the last page of the last exporter, return now.815	/** This filter is documented in wp-admin/includes/ajax-actions.php */816	$exporters        = apply_filters( 'wp_privacy_personal_data_exporters', array() );817	$is_last_exporter = count( $exporters ) === $exporter_index;818	$exporter_done    = $response['done'];819	if ( ! $is_last_exporter || ! $exporter_done ) {820		return $response;821	}822 823	// Last exporter, last page - let's prepare the export file.824 825	// First we need to re-organize the raw data hierarchically in groups and items.826	$groups = array();827	foreach ( (array) $export_data as $export_datum ) {828		$group_id    = $export_datum['group_id'];829		$group_label = $export_datum['group_label'];830 831		$group_description = '';832		if ( ! empty( $export_datum['group_description'] ) ) {833			$group_description = $export_datum['group_description'];834		}835 836		if ( ! array_key_exists( $group_id, $groups ) ) {837			$groups[ $group_id ] = array(838				'group_label'       => $group_label,839				'group_description' => $group_description,840				'items'             => array(),841			);842		}843 844		$item_id = $export_datum['item_id'];845		if ( ! array_key_exists( $item_id, $groups[ $group_id ]['items'] ) ) {846			$groups[ $group_id ]['items'][ $item_id ] = array();847		}848

History

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.9.7 tag, from src/wp-admin/includes/privacy-tools.php, 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.