Changeset 43077 for branches/4.9/src/wp-includes/comment.php

Timestamp:

05/02/2018 12:11:50 AM (7 years ago)

Author:

SergeyBiryukov

Message:

Privacy: fix docs, formatting, white space, add tests for the personal data from comments exporter.

Props birgire.
Merges [42987] to the 4.9 branch.
See #43440.

Location:

branches/4.9

Files:

• . (modified) (1 prop)
• src/wp-includes/comment.php (modified) (4 diffs)

branches/4.9/src/wp-includes/comment.php

@@ -3148 +3148 @@
 
 /**
- * Registers the personal data exporter for comments
- *
- * @param array   $exporters   An array of personal data exporters.
- * @return array  An array of personal data exporters.
+ * Registers the personal data exporter for comments.
+ *
+ * @since 4.9.6
+ *
+ * @param  array $exporters An array of personal data exporters.
+ * @return array $exporters An array of personal data exporters.
  */
 function wp_register_comment_personal_data_exporter( $exporters ) {
@@ -3165 +3167 @@
  * Finds and exports personal data associated with an email address from the comments table.
  *
- * @param string  $email_address The comment author email address.
- * @param int     $page          Comment page.
- * @return array  An array of personal data.
+ * @since 4.9.6
+ *
+ * @param  string $email_address The comment author email address.
+ * @param  int    $page          Comment page.
+ * @return array  $return        An array of personal data.
  */
 function wp_comments_personal_data_exporter( $email_address, $page = 1 ) {
 
-    // Technically, strtolower isn't necessary since get_comments will match email insensitive
-    // But it is a good example for plugin developers whose targets might not be as generous
-    $email_address = trim( strtolower( $email_address ) );
-
-    // Limit us to 500 comments at a time to avoid timing out
+    // Limit us to 500 comments at a time to avoid timing out.
     $number = 500;
-    $page = (int) $page;
+    $page   = (int) $page;
 
     $data_to_export = array();
@@ -3208 +3208 @@
             $value = '';
 
-            switch( $key ) {
+            switch ( $key ) {
                 case 'comment_author':
                 case 'comment_author_email':
@@ -3228 +3228 @@
 
             if ( ! empty( $value ) ) {
-                $comment_data_to_export[] = array( 'name' => $name, 'value' => $value );
+                $comment_data_to_export[] = array(
+                    'name'  => $name,
+                    'value' => $value,
+                );
             }
         }