Changeset 43303

Timestamp:

05/21/2018 01:02:55 PM (8 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing documentation and duplicate hook references for wp_privacy_personal_data_export_file, wp_privacy_personal_data_exporters, and wp_privacy_personal_data_erasers hooks.

Props birgire.
See #44125.

Location:

trunk/src/wp-admin/includes

Files:

• file.php (modified) (7 diffs)
• user.php (modified) (4 diffs)

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

@@ -1941 +1941 @@
  * @since 4.9.6
  *
- * @param array  $group_data {
+ * @param array $group_data {
  *     The group data to render.
  *
@@ -2003 +2003 @@
  * @since 4.9.6
  *
- * @param int  $request_id  The export request ID.
+ * @param int $request_id The export request ID.
  */
 function wp_privacy_generate_personal_data_export_file( $request_id ) {
@@ -2167 +2167 @@
              * @param string $archive_url          The URL of the archive file.
              * @param string $html_report_pathname The full path to the personal data report on the filesystem.
-             * @param string $request_id           The export request ID.
+             * @param int    $request_id           The export request ID.
              */
             do_action( 'wp_privacy_personal_data_export_file_created', $archive_pathname, $archive_url, $html_report_pathname, $request_id );
@@ -2188 +2188 @@
  * @since 4.9.6
  *
- * @param int  $request_id  The request ID for this personal data export.
- * @return true|WP_Error    True on success or `WP_Error` on failure.
+ * @param int $request_id The request ID for this personal data export.
+ * @return true|WP_Error True on success or `WP_Error` on failure.
  */
 function wp_privacy_send_personal_data_export_email( $request_id ) {
@@ -2199 +2199 @@
     }
 
-    /** This filter is documented in wp-admin/includes/file.php */
+    /** This filter is documented in wp-includes/functions.php */
     $expiration      = apply_filters( 'wp_privacy_export_expiration', 3 * DAY_IN_SECONDS );
     $expiration_date = date_i18n( get_option( 'date_format' ), time() + $expiration );
@@ -2321 +2321 @@
 
     // If we are not yet on the last page of the last exporter, return now.
+    /** This filter is documented in wp-admin/includes/ajax-actions.php */
     $exporters = apply_filters( 'wp_privacy_personal_data_exporters', array() );
     $is_last_exporter = $exporter_index === count( $exporters );
@@ -2356 +2357 @@
     update_post_meta( $request_id, '_export_data_grouped', $groups );
 
-    // Generate the export file from the collected, grouped personal data.
+    /**
+     * Generate the export file from the collected, grouped personal data.
+     *
+     * @since 4.9.6
+     *
+     * @param int $request_id The export request ID.
+     */
     do_action( 'wp_privacy_personal_data_export_file', $request_id );
 

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

@@ -1422 +1422 @@
      */
     public function column_email( $item ) {
+        /** This filter is documented in wp-admin/includes/ajax-actions.php */
         $exporters       = apply_filters( 'wp_privacy_personal_data_exporters', array() );
         $exporters_count = count( $exporters );
@@ -1462 +1463 @@
                 break;
             case 'request-confirmed':
+                /** This filter is documented in wp-admin/includes/ajax-actions.php */
                 $exporters       = apply_filters( 'wp_privacy_personal_data_exporters', array() );
                 $exporters_count = count( $exporters );
@@ -1534 +1536 @@
         $status = $item->status;
         if ( 'request-confirmed' !== $status ) {
+            /** This filter is documented in wp-admin/includes/ajax-actions.php */
             $erasers       = apply_filters( 'wp_privacy_personal_data_erasers', array() );
             $erasers_count = count( $erasers );
@@ -1574 +1577 @@
                 break;
             case 'request-confirmed':
+                /** This filter is documented in wp-admin/includes/ajax-actions.php */
                 $erasers       = apply_filters( 'wp_privacy_personal_data_erasers', array() );
                 $erasers_count = count( $erasers );