Ticket #8013: 8013.2.patch

src/bp-activity/bp-activity-filters.php

@@ -818 +818 @@
  * Registers Activity personal data exporter.
  *
  * @since 4.0.0
+ * @since 5.0.0 adds an `exporter_bp_friendly_name` param to exporters.
  *
  * @param array $exporters  An array of personal data exporters.
  * @return array An array of personal data exporters.
  */
 function bp_activity_register_personal_data_exporter( $exporters ) {
         $exporters['buddypress-activity'] = array(
-                'exporter_friendly_name' => __( 'BuddyPress Activity Data', 'buddypress' ),
-                'callback'               => 'bp_activity_personal_data_exporter',
+                'exporter_friendly_name'    => __( 'BuddyPress Activity Data', 'buddypress' ),
+                'callback'                  => 'bp_activity_personal_data_exporter',
+                'exporter_bp_friendly_name' => _x( 'Activity Data', 'BuddyPress Activity data exporter friendly name', 'buddypress' ),
         );
 
         return $exporters;

src/bp-friends/bp-friends-filters.php

@@ -52 +52 @@
  * Registers Friends personal data exporter.
  *
  * @since 4.0.0
+ * @since 5.0.0 adds an `exporter_bp_friendly_name` param to exporters.
  *
  * @param array $exporters  An array of personal data exporters.
  * @return array An array of personal data exporters.
  */
 function bp_friends_register_personal_data_exporters( $exporters ) {
         $exporters['buddypress-friends'] = array(
-                'exporter_friendly_name' => __( 'BuddyPress Friends', 'buddypress' ),
-                'callback'               => 'bp_friends_personal_data_exporter',
+                'exporter_friendly_name'    => __( 'BuddyPress Friends', 'buddypress' ),
+                'callback'                  => 'bp_friends_personal_data_exporter',
+                'exporter_bp_friendly_name' => _x( 'Friends', 'BuddyPress Friends data exporter friendly name', 'buddypress' ),
         );
 
         $exporters['buddypress-friends-pending-sent-requests'] = array(
-                'exporter_friendly_name' => __( 'BuddyPress Friend Requests (Sent)', 'buddypress' ),
-                'callback'               => 'bp_friends_pending_sent_requests_personal_data_exporter',
+                'exporter_friendly_name'    => __( 'BuddyPress Friend Requests (Sent)', 'buddypress' ),
+                'callback'                  => 'bp_friends_pending_sent_requests_personal_data_exporter',
+                'exporter_bp_friendly_name' => _x( 'Friend Requests (Sent)', 'BuddyPress Friend Requests data exporter friendly name', 'buddypress' ),
         );
 
         $exporters['buddypress-friends-pending-received-requests'] = array(
-                'exporter_friendly_name' => __( 'BuddyPress Friend Requests (Received)', 'buddypress' ),
-                'callback'               => 'bp_friends_pending_received_requests_personal_data_exporter',
+                'exporter_friendly_name'    => __( 'BuddyPress Friend Requests (Received)', 'buddypress' ),
+                'callback'                  => 'bp_friends_pending_received_requests_personal_data_exporter',
+                'exporter_bp_friendly_name' => _x( 'Friend Requests (Received)', 'BuddyPress Friend Requests data exporter friendly name', 'buddypress' ),
         );
 
         return $exporters;

src/bp-groups/bp-groups-filters.php

@@ -370 +370 @@
  * Registers Groups personal data exporters.
  *
  * @since 4.0.0
+ * @since 5.0.0 adds an `exporter_bp_friendly_name` param to exporters.
  *
  * @param array $exporters  An array of personal data exporters.
  * @return array An array of personal data exporters.
  */
 function bp_groups_register_personal_data_exporters( $exporters ) {
         $exporters['buddypress-groups-memberships'] = array(
-                'exporter_friendly_name' => __( 'BuddyPress Group Memberships', 'buddypress' ),
-                'callback'               => 'bp_groups_memberships_personal_data_exporter',
+                'exporter_friendly_name'    => __( 'BuddyPress Group Memberships', 'buddypress' ),
+                'callback'                  => 'bp_groups_memberships_personal_data_exporter',
+                'exporter_bp_friendly_name' => _x( 'Group Memberships', 'BuddyPress Group Memberships data exporter friendly name', 'buddypress' ),
         );
 
         $exporters['buddypress-groups-pending-requests'] = array(
-                'exporter_friendly_name' => __( 'BuddyPress Pending Group Membership Requests', 'buddypress' ),
-                'callback'               => 'bp_groups_pending_requests_personal_data_exporter',
+                'exporter_friendly_name'    => __( 'BuddyPress Pending Group Membership Requests', 'buddypress' ),
+                'callback'                  => 'bp_groups_pending_requests_personal_data_exporter',
+                'exporter_bp_friendly_name' => _x( 'Pending Group Membership Requests', 'BuddyPress Pending Group Membership Requests data exporter friendly name', 'buddypress' ),
         );
 
         $exporters['buddypress-groups-pending-received-invitations'] = array(
-                'exporter_friendly_name' => __( 'BuddyPress Pending Group Invitations (Received)', 'buddypress' ),
-                'callback'               => 'bp_groups_pending_received_invitations_personal_data_exporter',
+                'exporter_friendly_name'    => __( 'BuddyPress Pending Group Invitations (Received)', 'buddypress' ),
+                'callback'                  => 'bp_groups_pending_received_invitations_personal_data_exporter',
+                'exporter_bp_friendly_name' => _x( 'Pending Group Invitations (Received)', 'BuddyPress Pending Group Invitations data exporter friendly name', 'buddypress' ),
         );
 
         $exporters['buddypress-groups-pending-sent-invitations'] = array(
-                'exporter_friendly_name' => __( 'BuddyPress Pending Group Invitations (Sent)', 'buddypress' ),
-                'callback'               => 'bp_groups_pending_sent_invitations_personal_data_exporter',
+                'exporter_friendly_name'    => __( 'BuddyPress Pending Group Invitations (Sent)', 'buddypress' ),
+                'callback'                  => 'bp_groups_pending_sent_invitations_personal_data_exporter',
+                'exporter_bp_friendly_name' => _x( 'Pending Group Invitations (Sent)', 'BuddyPress Pending Group Invitations data exporter friendly name', 'buddypress' ),
         );
 
         return $exporters;

src/bp-messages/bp-messages-filters.php

@@ -134 +134 @@
  * Register Messages personal data exporter.
  *
  * @since 4.0.0
+ * @since 5.0.0 adds an `exporter_bp_friendly_name` param to exporters.
  *
  * @param array $exporters  An array of personal data exporters.
  * @return array An array of personal data exporters.
  */
 function bp_messages_register_personal_data_exporter( $exporters ) {
         $exporters['buddypress-messages'] = array(
-                'exporter_friendly_name' => __( 'BuddyPress Messages', 'buddypress' ),
-                'callback'               => 'bp_messages_personal_data_exporter',
+                'exporter_friendly_name'    => __( 'BuddyPress Messages', 'buddypress' ),
+                'callback'                  => 'bp_messages_personal_data_exporter',
+                'exporter_bp_friendly_name' => _x( 'Private Messages', 'BuddyPress Messages data exporter friendly name', 'buddypress' ),
         );
 
         return $exporters;

src/bp-notifications/bp-notifications-filters.php

@@ -14 +14 @@
  * Register Notifications personal data exporter.
  *
  * @since 4.0.0
+ * @since 5.0.0 adds an `exporter_bp_friendly_name` param to exporters.
  *
  * @param array $exporters  An array of personal data exporters.
  * @return array An array of personal data exporters.
  */
 function bp_register_notifications_personal_data_exporter( $exporters ) {
         $exporters['buddypress-notifications'] = array(
-                'exporter_friendly_name' => __( 'BuddyPress Notifications Data', 'buddypress' ),
-                'callback'               => 'bp_notifications_personal_data_exporter',
+                'exporter_friendly_name'    => __( 'BuddyPress Notifications Data', 'buddypress' ),
+                'callback'                  => 'bp_notifications_personal_data_exporter',
+                'exporter_bp_friendly_name' => _x( 'Notifications Data', 'BuddyPress Notifications data exporter friendly name', 'buddypress' ),
         );
 
         return $exporters;

src/bp-settings/bp-settings-filters.php

@@ -13 +13 @@
  * Registers Settings personal data exporter.
  *
  * @since 4.0.0
+ * @since 5.0.0 adds an `exporter_bp_friendly_name` param to exporters.
  *
  * @param array $exporters  An array of personal data exporters.
  * @return array An array of personal data exporters.
  */
 function bp_settings_register_personal_data_exporter( $exporters ) {
         $exporters['buddypress-settings'] = array(
-                'exporter_friendly_name' => __( 'BuddyPress Settings Data', 'buddypress' ),
-                'callback'               => 'bp_settings_personal_data_exporter',
+                'exporter_friendly_name'    => __( 'BuddyPress Settings Data', 'buddypress' ),
+                'callback'                  => 'bp_settings_personal_data_exporter',
+                'exporter_bp_friendly_name' => _x( 'Personal settings', 'BuddyPress Settings Data data exporter friendly name', 'buddypress' ),
         );
 
         return $exporters;

src/bp-settings/bp-settings-functions.php

@@ -316 +316 @@
  * Piggybacks off of the 'wp_privacy_personal_data_exporters' filter and the
  * 'exporter_friendly_name' key, which is meant for the admin area.
  *
- * @todo We should look for a custom key like 'exporter_frontend_name' if available.
- *
  * @since 4.0.0
+ * @since 5.0.0 Looks for a potential exporter's BP/custom friendly name.
  */
 function bp_settings_data_exporter_items() {
         /** This filter is documented in /wp-admin/includes/ajax-actions.php */
-        $exporters = apply_filters( 'wp_privacy_personal_data_exporters', array() );
+        $exporters             = apply_filters( 'wp_privacy_personal_data_exporters', array() );
+        $custom_friendly_names = apply_filters( 'bp_settings_data_custom_friendly_names', array(
+                'wordpress-comments' => _x( 'Comments', 'WP Comments data exporter friendly name', 'buddypress' ),
+                'wordpress-media'    => _x( 'Media', 'WP Media data exporter friendly name', 'buddypress' ),
+                'wordpress-user'     => _x( 'Personal information', 'WP Media data exporter friendly name', 'buddypress' ),
+        ) );
 
 ?>
         <ul>
         <?php foreach ( $exporters as $exporter => $data ) :
+                // Use the exporter friendly name by default.
+                $friendly_name = $data['exporter_friendly_name'];
+
+                /**
+                 * Use the exporter friendly name if directly available
+                 * into the exporters array.
+                 */
+                if ( isset( $data['exporter_bp_friendly_name'] ) ) {
+                        $friendly_name = $data['exporter_bp_friendly_name'];
+
+                // Look for a potential match into the custom friendly names.
+                } elseif ( isset( $custom_friendly_names[ $exporter ] ) ) {
+                        $friendly_name = $custom_friendly_names[ $exporter ];
+                }
+
                 /**
-                 * Filters the data exporter name for display on the "Settings > Data" page.
+                 * Filters the data exporter friendly name for display on the "Settings > Data" page.
                  *
                  * @since 4.0.0
+                 * @since 5.0.0 replaces the `$name` parameter with the `$friendly_name` one.
                  *
-                 * @param string $name     Data exporter friendly name.
-                 * @param string $exporter Internal exporter name.
+                 * @param string $friendly_name Data exporter friendly name.
+                 * @param string $exporter      Internal exporter name.
                  */
-                $item = apply_filters( 'bp_settings_data_exporter_name', esc_html( $data['exporter_friendly_name'] ), $exporter );
+                $item = apply_filters( 'bp_settings_data_exporter_name', esc_html( $friendly_name ), $exporter );
         ?>
 
                 <li><?php echo $item; ?></li>

src/bp-xprofile/bp-xprofile-filters.php

@@ -666 +666 @@
  * Register XProfile personal data exporter.
  *
  * @since 4.0.0
+ * @since 5.0.0 adds an `exporter_bp_friendly_name` param to exporters.
  *
  * @param array $exporters  An array of personal data exporters.
  * @return array An array of personal data exporters.
  */
 function bp_xprofile_register_personal_data_exporter( $exporters ) {
         $exporters['buddypress-xprofile'] = array(
-                'exporter_friendly_name' => __( 'BuddyPress Extended Profile Data', 'buddypress' ),
-                'callback'               => 'bp_xprofile_personal_data_exporter',
+                'exporter_friendly_name'    => __( 'BuddyPress Extended Profile Data', 'buddypress' ),
+                'callback'                  => 'bp_xprofile_personal_data_exporter',
+                'exporter_bp_friendly_name' => _x( 'Extended Profile information', 'BuddyPress Extended Profile data exporter friendly name', 'buddypress' ),
         );
 
         return $exporters;