wp_comments_personal_data_eraser( string $email_address, int $page = 1 ): 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

$email_addressstring

The comment author email address.

$pageintoptional

Comment page number.Default: 1

Return value

array

Data removal results.

• $items_removedbool

  Whether items were actually removed.

• $items_retainedbool

  Whether items were retained.

• $messagesstring[]

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

• $donebool

  Whether the eraser is finished.

Performance profile

How much work a call to wp_comments_personal_data_eraser() 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_comments().

Scaling

Scales with input

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

Instructions

6–35

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

Plugin surface

1 hook

Third-party callbacks on 'wp_anonymize_comment' 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

• querycontent queryget_comments()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_delete_multiple()one call below wp_comments_personal_data_eraser()

Further down the call graph this can also reach option, 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 · 2 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while wp_comments_personal_data_eraser() runs, in this order:

1. 1
   apply_filters( wp_anonymize_comment )filterline 3916 (+54 into the body)

   Filters whether to anonymize the comment.

Uses · 6

• get_comments()Retrieves a list of comments.
• __()Retrieves the translation of $text.
• wp_privacy_anonymize_data()Returns uniform "anonymous" data by type.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• esc_html()Escaping for HTML blocks.
• clean_comment_cache()Removes a comment from the object cache.

Source code

View on Trac ↗View on GitHub ↗

3862function wp_comments_personal_data_eraser( $email_address, $page = 1 ) {3863	global $wpdb;3864 3865	if ( empty( $email_address ) ) {3866		return array(3867			'items_removed'  => false,3868			'items_retained' => false,3869			'messages'       => array(),3870			'done'           => true,3871		);3872	}3873 3874	// Limit us to 500 comments at a time to avoid timing out.3875	$number         = 500;3876	$page           = (int) $page;3877	$items_removed  = false;3878	$items_retained = false;3879 3880	$comments = get_comments(3881		array(3882			'author_email'       => $email_address,3883			'number'             => $number,3884			'paged'              => $page,3885			'orderby'            => 'comment_ID',3886			'order'              => 'ASC',3887			'include_unapproved' => true,3888		)3889	);3890 3891	/* translators: Name of a comment's author after being anonymized. */3892	$anon_author = __( 'Anonymous' );3893	$messages    = array();3894 3895	foreach ( (array) $comments as $comment ) {3896		$anonymized_comment                         = array();3897		$anonymized_comment['comment_agent']        = '';3898		$anonymized_comment['comment_author']       = $anon_author;3899		$anonymized_comment['comment_author_email'] = '';3900		$anonymized_comment['comment_author_IP']    = wp_privacy_anonymize_data( 'ip', $comment->comment_author_IP );3901		$anonymized_comment['comment_author_url']   = '';3902		$anonymized_comment['user_id']              = 0;3903 3904		$comment_id = (int) $comment->comment_ID;3905 3906		/**3907		 * Filters whether to anonymize the comment.3908		 *3909		 * @since 4.9.63910		 *3911		 * @param bool|string $anon_message       Whether to apply the comment anonymization (bool) or a custom3912		 *                                        message (string). Default true.3913		 * @param WP_Comment  $comment            WP_Comment object.3914		 * @param array       $anonymized_comment Anonymized comment data.3915		 */3916		$anon_message = apply_filters( 'wp_anonymize_comment', true, $comment, $anonymized_comment );3917 3918		if ( true !== $anon_message ) {3919			if ( $anon_message && is_string( $anon_message ) ) {3920				$messages[] = esc_html( $anon_message );3921			} else {3922				/* translators: %d: Comment ID. */3923				$messages[] = sprintf( __( 'Comment %d contains personal data but could not be anonymized.' ), $comment_id );3924			}3925 3926			$items_retained = true;3927 3928			continue;3929		}3930 3931		$args = array(3932			'comment_ID' => $comment_id,3933		);3934 3935		$updated = $wpdb->update( $wpdb->comments, $anonymized_comment, $args );3936 3937		if ( $updated ) {3938			$items_removed = true;3939			clean_comment_cache( $comment_id );3940		} else {3941			$items_retained = true;

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.7.7 tag, from src/wp-includes/comment.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.