wp_privacy_process_personal_data_erasure_page( array $response, int $eraser_index, string $email_address, int $page, int $request_id ): array

Description

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 eraser for the given page.

$eraser_indexint

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

$email_addressstring

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

$pageint

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

$request_idint

The request ID for this personal data erasure.

Return value

array

The filtered response.

Performance profile

How much work a call to wp_privacy_process_personal_data_erasure_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

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

8–47

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

Plugin surface

2 hooks

Third-party callbacks on 'wp_privacy_personal_data_erasers', 'wp_privacy_personal_data_erased' 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_erasure_page()

Further down the call graph this can also reach option, cache, serialize 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 · 5 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_erasure_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_erasure_page() runs, in this order:

1. 1
   apply_filters( wp_privacy_personal_data_erasers )filterline 949 (+34 into the body)

   Filters the array of personal data eraser callbacks.

2. 2
   do_action( wp_privacy_personal_data_erased )actionline 966 (+51 into the body)

   Fires immediately after a personal data erasure request has been marked completed.

Uses · 6

• 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.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• _wp_privacy_completed_request()Marks a request as completed by the admin and logs the current timestamp.
• do_action()Calls the callback functions that have been added to an action hook.

Source code

View on Trac ↗View on GitHub ↗

915function wp_privacy_process_personal_data_erasure_page( $response, $eraser_index, $email_address, $page, $request_id ) {916	/*917	 * If the eraser response is malformed, don't attempt to consume it; let it918	 * pass through, so that the default Ajax processing will generate a warning919	 * to the user.920	 */921	if ( ! is_array( $response ) ) {922		return $response;923	}924 925	if ( ! array_key_exists( 'done', $response ) ) {926		return $response;927	}928 929	if ( ! array_key_exists( 'items_removed', $response ) ) {930		return $response;931	}932 933	if ( ! array_key_exists( 'items_retained', $response ) ) {934		return $response;935	}936 937	if ( ! array_key_exists( 'messages', $response ) ) {938		return $response;939	}940 941	// Get the request.942	$request = wp_get_user_request( $request_id );943 944	if ( ! $request || 'remove_personal_data' !== $request->action_name ) {945		wp_send_json_error( __( 'Invalid request ID when processing personal data to erase.' ) );946	}947 948	/** This filter is documented in wp-admin/includes/ajax-actions.php */949	$erasers        = apply_filters( 'wp_privacy_personal_data_erasers', array() );950	$is_last_eraser = count( $erasers ) === $eraser_index;951	$eraser_done    = $response['done'];952 953	if ( ! $is_last_eraser || ! $eraser_done ) {954		return $response;955	}956 957	_wp_privacy_completed_request( $request_id );958 959	/**960	 * Fires immediately after a personal data erasure request has been marked completed.961	 *962	 * @since 4.9.6963	 *964	 * @param int $request_id The privacy request post ID associated with this request.965	 */966	do_action( 'wp_privacy_personal_data_erased', $request_id );967 968	return $response;969}

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