Changeset 45825

Timestamp:

08/18/2019 02:07:00 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Privacy: Add descriptions for sections in a personal data export file.

Props garrett-eclipse, Venutius, karmatosed.
Fixes #45491.

Location:

trunk

Files:

• src/wp-admin/includes/privacy-tools.php (modified) (3 diffs)
• src/wp-includes/comment.php (modified) (1 diff)
• src/wp-includes/media.php (modified) (1 diff)
• src/wp-includes/user.php (modified) (1 diff)
• tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php (modified) (1 diff)

trunk/src/wp-admin/includes/privacy-tools.php

@@ -235 +235 @@
  */
 function wp_privacy_generate_personal_data_export_group_html( $group_data ) {
-    $group_html  = '<h2>' . esc_html( $group_data['group_label'] ) . '</h2>';
+    $group_html = '<h2>' . esc_html( $group_data['group_label'] ) . '</h2>';
+
+    if ( ! empty( $group_data['group_description'] ) ) {
+        $group_html .= '<p>' . esc_html( $group_data['group_description'] ) . '</p>';
+    }
+
     $group_html .= '<div>';
 
@@ -356 +361 @@
     $about_group = array(
         /* translators: Header for the About section in a personal data export. */
-        'group_label' => _x( 'About', 'personal data group label' ),
-        'items'       => array(
+        'group_label'       => _x( 'About', 'personal data group label' ),
+        /* translators: Description for the About section in a personal data export. */
+        'group_description' => _x( 'Overview of export report.', 'personal data group description' ),
+        'items'             => array(
             'about-1' => array(
                 array(
@@ -614 +621 @@
         $group_id    = $export_datum['group_id'];
         $group_label = $export_datum['group_label'];
+
+        $group_description = '';
+        if ( ! empty( $export_datum['group_description'] ) ) {
+            $group_description = $export_datum['group_description'];
+        }
+
         if ( ! array_key_exists( $group_id, $groups ) ) {
             $groups[ $group_id ] = array(
-                'group_label' => $group_label,
-                'items'       => array(),
+                'group_label'       => $group_label,
+                'group_description' => $group_description,
+                'items'             => array(),
             );
         }

trunk/src/wp-includes/comment.php

@@ -3435 +3435 @@
 
         $data_to_export[] = array(
-            'group_id'    => 'comments',
-            'group_label' => __( 'Comments' ),
-            'item_id'     => "comment-{$comment->comment_ID}",
-            'data'        => $comment_data_to_export,
+            'group_id'          => 'comments',
+            'group_label'       => __( 'Comments' ),
+            'group_description' => __( 'User’s comment data.' ),
+            'item_id'           => "comment-{$comment->comment_ID}",
+            'data'              => $comment_data_to_export,
         );
     }

trunk/src/wp-includes/media.php

@@ -4308 +4308 @@
 
             $data_to_export[] = array(
-                'group_id'    => 'media',
-                'group_label' => __( 'Media' ),
-                'item_id'     => "post-{$post->ID}",
-                'data'        => $post_data_to_export,
+                'group_id'          => 'media',
+                'group_label'       => __( 'Media' ),
+                'group_description' => __( 'User’s media data.' ),
+                'item_id'           => "post-{$post->ID}",
+                'data'              => $post_data_to_export,
             );
         }

trunk/src/wp-includes/user.php

@@ -2995 +2995 @@
 
     $data_to_export[] = array(
-        'group_id'    => 'user',
-        'group_label' => __( 'User' ),
-        'item_id'     => "user-{$user->ID}",
-        'data'        => $user_data_to_export,
+        'group_id'          => 'user',
+        'group_label'       => __( 'User' ),
+        'group_description' => __( 'User’s profile data.' ),
+        'item_id'           => "user-{$user->ID}",
+        'data'              => $user_data_to_export,
     );
 

trunk/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php

@@ -143 +143 @@
         $data = array(
             array(
-                'group_id'    => 'custom-exporter-group-id',
-                'group_label' => 'custom-exporter-group-label',
-                'item_id'     => 'custom-exporter-item-id',
-                'data'        => array(
+                'group_id'          => 'custom-exporter-group-id',
+                'group_label'       => 'Custom Exporter Group Label',
+                'group_description' => 'Custom Exporter Group Description',
+                'item_id'           => 'custom-exporter-item-id',
+                'data'              => array(
                     array(
                         'name'  => 'Email',