Changeset 43154

Timestamp:

05/03/2018 07:27:14 PM (7 years ago)

Author:

iandunn

Message:

Privacy: Store plugin callbacks in associative array for flexibility.

The personal data export and erasure tools allow plugins to register their own callbacks, in order to add additional data to the export and erasure processes. Previously, these were registered without specifying a constant identifier in the array of callbacks. Using mutable integers makes it difficult for plugins to modify the callbacks of other plugins, though.

Using associative array keys instead provides a covenient and reliable way to identify and interact with another plugin's callbacks.

Props desrosj, allendav, ocean90.
Fixes #43931.

Location:

trunk/src

Files:

• wp-admin/includes/admin-filters.php (modified) (1 diff)
• wp-admin/includes/ajax-actions.php (modified) (6 diffs)
• wp-admin/includes/file.php (modified) (1 diff)
• wp-includes/comment.php (modified) (3 diffs)
• wp-includes/media.php (modified) (1 diff)
• wp-includes/user.php (modified) (1 diff)

trunk/src/wp-admin/includes/admin-filters.php

@@ -134 +134 @@
 
 // Privacy hooks
-add_filter( 'wp_privacy_personal_data_export_page', 'wp_privacy_process_personal_data_export_page', 10, 6 );
+add_filter( 'wp_privacy_personal_data_export_page', 'wp_privacy_process_personal_data_export_page', 10, 7 );
 add_action( 'wp_privacy_personal_data_export_file', 'wp_privacy_generate_personal_data_export_file', 10 );
 

trunk/src/wp-admin/includes/ajax-actions.php

@@ -4410 +4410 @@
         }
 
-        $index = $exporter_index - 1;
-
         if ( $page < 1 ) {
             wp_send_json_error( __( 'Page index cannot be less than one.' ) );
         }
 
-        $exporter = $exporters[ $index ];
+        $exporter_keys = array_keys( $exporters );
+        $exporter_key  = $exporter_keys[ $exporter_index - 1 ];
+        $exporter      = $exporters[ $exporter_key ];
 
         if ( ! is_array( $exporter ) ) {
             wp_send_json_error(
-                /* translators: %d: array index */
-                sprintf( __( 'Expected an array describing the exporter at index %d.' ), $exporter_index )
+                /* translators: %s: array index */
+                sprintf( __( 'Expected an array describing the exporter at index %s.' ), $exporter_key )
             );
         }
         if ( ! array_key_exists( 'exporter_friendly_name', $exporter ) ) {
             wp_send_json_error(
-                /* translators: %d: array index */
-                sprintf( __( 'Exporter array at index %d does not include a friendly name.' ), $exporter_index )
+                /* translators: %s: array index */
+                sprintf( __( 'Exporter array at index %s does not include a friendly name.' ), $exporter_key )
             );
         }
@@ -4443 +4443 @@
         }
 
-        $callback = $exporters[ $index ]['callback'];
-        $exporter_friendly_name = $exporters[ $index ]['exporter_friendly_name'];
+        $callback               = $exporter['callback'];
+        $exporter_friendly_name = $exporter['exporter_friendly_name'];
 
         $response = call_user_func( $callback, $email_address, $page );
@@ -4496 +4496 @@
      * @param int    $request_id      The privacy request post ID associated with this request.
      * @param bool   $send_as_email   Whether the final results of the export should be emailed to the user.
+     * @param int    $exporter_key    The key (slug) of the exporter that provided this data.
      */
-    $response = apply_filters( 'wp_privacy_personal_data_export_page', $response, $exporter_index, $email_address, $page, $request_id, $send_as_email );
+    $response = apply_filters( 'wp_privacy_personal_data_export_page', $response, $exporter_index, $email_address, $page, $request_id, $send_as_email, $exporter_key );
 
     if ( is_wp_error( $response ) ) {
@@ -4592 +4593 @@
         }
 
-        $index  = $eraser_index - 1; // Convert to zero based for eraser index.
-        $eraser = $erasers[ $index ];
+        $eraser_keys = array_keys( $erasers );
+        $eraser_key  = $eraser_keys[ $eraser_index - 1 ];
+        $eraser      = $erasers[ $eraser_key ];
 
         if ( ! is_array( $eraser ) ) {
@@ -4615 +4617 @@
         }
 
-        $callback             = $erasers[ $index ]['callback'];
-        $eraser_friendly_name = $erasers[ $index ]['eraser_friendly_name'];
+        $callback             = $eraser['callback'];
+        $eraser_friendly_name = $eraser['eraser_friendly_name'];
 
         $response = call_user_func( $callback, $email_address, $page );
@@ -4707 +4709 @@
      *
      * @param array  $response        The personal data for the given exporter and page.
-     * @param int    $exporter_index  The index of the exporter that provided this data.
+     * @param int    $eraser_index    The index of the eraser that provided this data.
      * @param string $email_address   The email address associated with this personal data.
      * @param int    $page            The page for this response.
      * @param int    $request_id      The privacy request post ID associated with this request.
+     * @param int    $eraser_key      The key (slug) of the eraser that provided this data.
      */
-    $response = apply_filters( 'wp_privacy_personal_data_erasure_page', $response, $eraser_index, $email_address, $page, $request_id );
+    $response = apply_filters( 'wp_privacy_personal_data_erasure_page', $response, $eraser_index, $email_address, $page, $request_id, $eraser_key );
 
     if ( is_wp_error( $response ) ) {

trunk/src/wp-admin/includes/file.php

@@ -2263 +2263 @@
  * @param int    $request_id      The request ID for this personal data export.
  * @param bool   $send_as_email   Whether the final results of the export should be emailed to the user.
+ * @param string $exporter_key    The slug (key) of the exporter.
  * @return array The filtered response.
  */
-function wp_privacy_process_personal_data_export_page( $response, $exporter_index, $email_address, $page, $request_id, $send_as_email ) {
+function wp_privacy_process_personal_data_export_page( $response, $exporter_index, $email_address, $page, $request_id, $send_as_email, $exporter_key ) {
     /* Do some simple checks on the shape of the response from the exporter.
      * If the exporter response is malformed, don't attempt to consume it - let it

trunk/src/wp-includes/comment.php

@@ -3286 +3286 @@
  */
 function wp_register_comment_personal_data_exporter( $exporters ) {
-    $exporters[] = array(
+    $exporters['wordpress-comments'] = array(
         'exporter_friendly_name' => __( 'WordPress Comments' ),
         'callback'               => 'wp_comments_personal_data_exporter',
@@ -3391 +3391 @@
  */
 function wp_register_comment_personal_data_eraser( $erasers ) {
-    $erasers[] = array(
+    $erasers['wordpress-comments'] = array(
         'eraser_friendly_name' => __( 'WordPress Comments' ),
         'callback'             => 'wp_comments_personal_data_eraser',
@@ -3499 +3499 @@
     );
 }
-

trunk/src/wp-includes/media.php

@@ -4103 +4103 @@
  */
 function wp_register_media_personal_data_exporter( $exporters ) {
-    $exporters[] = array(
+    $exporters['wordpress-media'] = array(
         'exporter_friendly_name' => __( 'WordPress Media' ),
         'callback'               => 'wp_media_personal_data_exporter',

trunk/src/wp-includes/user.php

@@ -2835 +2835 @@
  */
 function wp_register_user_personal_data_exporter( $exporters ) {
-    $exporters[] = array(
+    $exporters['wordpress-user'] = array(
         'exporter_friendly_name' => __( 'WordPress User' ),
         'callback'               => 'wp_user_personal_data_exporter',