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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

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 value

array

The filtered response.

Performance profile

How much work a call to wp_privacy_process_personal_data_export_page() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Expensive

Sends mail via wp_mail().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

10–104

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 171.

Plugin surface

2 hooks

Third-party callbacks on 'wp_privacy_personal_data_exporters', 'wp_privacy_personal_data_export_file' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()one call below wp_privacy_process_personal_data_export_page()
• optionoption read or writeget_option()one call below wp_privacy_process_personal_data_export_page()
• mailsends mailwp_mail()one call below wp_privacy_process_personal_data_export_page()

Further down the call graph this can also reach serialize, cache and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 17 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_privacy_process_personal_data_export_page() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters 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 822 (+47 into the body)

   Filters the array of exporter callbacks.

2. 2
   do_action( wp_privacy_personal_data_export_file )actionline 871 (+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 code

View on Trac ↗View on GitHub ↗

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

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 7.1.0 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.