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

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

string

The HTML for this group and its items.

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

View on Trac ↗View on GitHub ↗

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

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