Personal Data Report - item descriptions

[Venutius]

Regarding the personal data report, I'm finding it a bit impersonal and uninformative as to what each section means to the end user, It would be good to have an option to add a description for each section.

As I see it, it would be another option with included suggested text from the developer.

[garrett-eclipse]

Thanks @Venutius for opening this.

I followed you creating #45492 which expands on your concept and provides a path forward with a proposed filter on wp_privacy_generate_personal_data_export_group_html which would enable developers to included suggested text among other things. As such I'm closing this in favour of #45492 as I've taken ownership of it there and will be working on the functionality through that ticket. Feel free to watch that ticket and help with review/testing.

Cheers

[garrett-eclipse]

Introduces Group Descriptions to the Exporters and Export Email

[garrett-eclipse]

Sample export w/ Descriptions

[garrett-eclipse]

Add missing period from the About description

[garrett-eclipse]

Screen illustrating group descriptions on data export

[garrett-eclipse]

Hi @Venutius after feedback from @xkon on #45492 indicating that direction can lead to bad parties scrubbing data from the exports I've moved back to simply introducing the descriptions to the exporter groups.
Comment Reference - https://core.trac.wordpress.org/ticket/45492#comment:12

Attached 45491.diff to introduce support for exporter descriptions as well as provided default descriptions for core exporters as follows;
About - Overview of export report.
User - User profile data.
Comments - Users comment data.
Media - Users media data.
*Adding needs-design-feedback to get thoughts on the verbiage.

Attached example export of default data - https://core.trac.wordpress.org/attachment/ticket/45491/index%207.html

On potential improvement on this initial patch would be to provide ways to filter to label and description but it should be noted the rest of the data should be unfiltered and preserved as is.

[garrett-eclipse]

Updated w/ fixed tests and added array_key_exists checks

[garrett-eclipse]

I uploaded 45491.3.diff to introduce more checks as most plugins won't have group_description available. As well fixed unit tests as I found the following errors while running them;

There were 4 errors:

1) Tests_Privacy_WpPrivacyProcessPersonalDataExportPage::test_raw_data_post_meta with data set #0 (true)
Undefined index: group_description

/Users/garretthyder/WordPress/45492-descriptions-exporter/build/wp-admin/includes/file.php:2519
/Users/garretthyder/WordPress/45492-descriptions-exporter/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php:428

2) Tests_Privacy_WpPrivacyProcessPersonalDataExportPage::test_raw_data_post_meta with data set #1 (false)
Undefined index: group_description

/Users/garretthyder/WordPress/45492-descriptions-exporter/build/wp-admin/includes/file.php:2519
/Users/garretthyder/WordPress/45492-descriptions-exporter/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php:428

3) Tests_Privacy_WpPrivacyProcessPersonalDataExportPage::test_add_post_meta_with_groups_data_only_available_when_export_file_generated with data set #0 (true)
Undefined index: group_description

/Users/garretthyder/WordPress/45492-descriptions-exporter/build/wp-admin/includes/file.php:2519
/Users/garretthyder/WordPress/45492-descriptions-exporter/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php:467

4) Tests_Privacy_WpPrivacyProcessPersonalDataExportPage::test_add_post_meta_with_groups_data_only_available_when_export_file_generated with data set #1 (false)
Undefined index: group_description

/Users/garretthyder/WordPress/45492-descriptions-exporter/build/wp-admin/includes/file.php:2519
/Users/garretthyder/WordPress/45492-descriptions-exporter/tests/phpunit/tests/privacy/wpPrivacyProcessPersonalDataExportPage.php:467

--

[karmatosed]

Thanks for asking for design feedback, based on the screenshot here: https://core.trac.wordpress.org/attachment/ticket/45491/Screen%20Shot%202019-04-06%20at%204.34.56%20AM.png, I would say that is good. I think there are some visual adjustments could be done to report but as only adding the descriptions is in this tickets focus, let's keep to that.

[SergeyBiryukov]

In 45825:

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

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