wp_privacy_generate_personal_data_export_group_html( array $group_data, string $group_id = '', int $groups_count = 1 ): string

Compatibility

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

Parameters

$group_dataarray

The group data to render.

• $group_labelstring

  The user-facing heading for the group, e.g. 'Comments'.

• $itemsarray

  { An array of group items.

• $group_item_dataarray

  { An array of name-value pairs for the item.

• $namestring

  The user-facing name of an item name-value pair, e.g. 'IP Address'.

• $valuestring

  The user-facing value of an item data pair, e.g. '50.60.70.0'. } }

$group_idstringoptional

The group identifier.Default: ''

$groups_countintoptional

The number of all groupsDefault: 1

Return value

string

The HTML for this group and its items.

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

38–60

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()one call below wp_privacy_generate_personal_data_export_group_html()

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

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

Uses · 8

• sanitize_title_with_dashes()Sanitizes a title, replacing whitespace and a few other characters with dashes.
• esc_attr()Escaping for HTML attributes.
• esc_html()Escaping for HTML blocks.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• esc_url()Checks and cleans a URL.
• wp_kses()Filters text content and strips out disallowed HTML.
• esc_html__()Retrieves the translation of $text and escapes it for safe use in HTML output.

Used by · 1

• wp_privacy_generate_personal_data_export_file()Generate the personal data export file.

Source code

View on Trac ↗View on GitHub ↗

258function wp_privacy_generate_personal_data_export_group_html( $group_data, $group_id = '', $groups_count = 1 ) {259	$group_id_attr = sanitize_title_with_dashes( $group_data['group_label'] . '-' . $group_id );260 261	$group_html  = '<h2 id="' . esc_attr( $group_id_attr ) . '">';262	$group_html .= esc_html( $group_data['group_label'] );263 264	$items_count = count( (array) $group_data['items'] );265	if ( $items_count > 1 ) {266		$group_html .= sprintf( ' <span class="count">(%d)</span>', $items_count );267	}268 269	$group_html .= '</h2>';270 271	if ( ! empty( $group_data['group_description'] ) ) {272		$group_html .= '<p>' . esc_html( $group_data['group_description'] ) . '</p>';273	}274 275	$group_html .= '<div>';276 277	foreach ( (array) $group_data['items'] as $group_item_id => $group_item_data ) {278		$group_html .= '<table>';279		$group_html .= '<tbody>';280 281		foreach ( (array) $group_item_data as $group_item_datum ) {282			$value = $group_item_datum['value'];283			// If it looks like a link, make it a link.284			if ( ! str_contains( $value, ' ' ) && ( str_starts_with( $value, 'http://' ) || str_starts_with( $value, 'https://' ) ) ) {285				$value = '<a href="' . esc_url( $value ) . '">' . esc_html( $value ) . '</a>';286			}287 288			$group_html .= '<tr>';289			$group_html .= '<th>' . esc_html( $group_item_datum['name'] ) . '</th>';290			$group_html .= '<td>' . wp_kses( $value, 'personal_data_export' ) . '</td>';291			$group_html .= '</tr>';292		}293 294		$group_html .= '</tbody>';295		$group_html .= '</table>';296	}297 298	if ( $groups_count > 1 ) {299		$group_html .= '<div class="return-to-top">';300		$group_html .= '<a href="#top"><span aria-hidden="true">&uarr; </span> ' . esc_html__( 'Go to top' ) . '</a>';301		$group_html .= '</div>';302	}303 304	$group_html .= '</div>';305 306	return $group_html;307}

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.