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.

git-svn-id: https://develop.svn.wordpress.org/trunk@43303 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2018-05-21 13:02:55 +00:00
parent 0e067ab91e
commit d612af2e5e
2 changed files with 18 additions and 7 deletions

View File

@ -2166,7 +2166,7 @@ function wp_privacy_generate_personal_data_export_file( $request_id ) {
* @param string $archive_pathname The full path to the export file on the filesystem. * @param string $archive_pathname The full path to the export file on the filesystem.
* @param string $archive_url The URL of the archive file. * @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 $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 ); do_action( 'wp_privacy_personal_data_export_file_created', $archive_pathname, $archive_url, $html_report_pathname, $request_id );
} }
@ -2198,7 +2198,7 @@ function wp_privacy_send_personal_data_export_email( $request_id ) {
return new WP_Error( 'invalid', __( 'Invalid request ID when sending personal data export email.' ) ); return new WP_Error( 'invalid', __( 'Invalid request ID when sending personal data export email.' ) );
} }
/** 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 = apply_filters( 'wp_privacy_export_expiration', 3 * DAY_IN_SECONDS );
$expiration_date = date_i18n( get_option( 'date_format' ), time() + $expiration ); $expiration_date = date_i18n( get_option( 'date_format' ), time() + $expiration );
@ -2320,6 +2320,7 @@ function wp_privacy_process_personal_data_export_page( $response, $exporter_inde
update_post_meta( $request_id, '_export_data_raw', $export_data ); update_post_meta( $request_id, '_export_data_raw', $export_data );
// If we are not yet on the last page of the last exporter, return now. // 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() ); $exporters = apply_filters( 'wp_privacy_personal_data_exporters', array() );
$is_last_exporter = $exporter_index === count( $exporters ); $is_last_exporter = $exporter_index === count( $exporters );
$exporter_done = $response['done']; $exporter_done = $response['done'];
@ -2355,7 +2356,13 @@ function wp_privacy_process_personal_data_export_page( $response, $exporter_inde
delete_post_meta( $request_id, '_export_data_raw' ); delete_post_meta( $request_id, '_export_data_raw' );
update_post_meta( $request_id, '_export_data_grouped', $groups ); 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 ); do_action( 'wp_privacy_personal_data_export_file', $request_id );
// Clear the grouped data now that it is no longer needed. // Clear the grouped data now that it is no longer needed.

View File

@ -1421,6 +1421,7 @@ class WP_Privacy_Data_Export_Requests_Table extends WP_Privacy_Requests_Table {
* @return string Email column markup. * @return string Email column markup.
*/ */
public function column_email( $item ) { 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 = apply_filters( 'wp_privacy_personal_data_exporters', array() );
$exporters_count = count( $exporters ); $exporters_count = count( $exporters );
$request_id = $item->ID; $request_id = $item->ID;
@ -1461,6 +1462,7 @@ class WP_Privacy_Data_Export_Requests_Table extends WP_Privacy_Requests_Table {
esc_html_e( 'Waiting for confirmation' ); esc_html_e( 'Waiting for confirmation' );
break; break;
case 'request-confirmed': case 'request-confirmed':
/** 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() );
$exporters_count = count( $exporters ); $exporters_count = count( $exporters );
$request_id = $item->ID; $request_id = $item->ID;
@ -1533,6 +1535,7 @@ class WP_Privacy_Data_Removal_Requests_Table extends WP_Privacy_Requests_Table {
// Allow the administrator to "force remove" the personal data even if confirmation has not yet been received. // Allow the administrator to "force remove" the personal data even if confirmation has not yet been received.
$status = $item->status; $status = $item->status;
if ( 'request-confirmed' !== $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 = apply_filters( 'wp_privacy_personal_data_erasers', array() );
$erasers_count = count( $erasers ); $erasers_count = count( $erasers );
$request_id = $item->ID; $request_id = $item->ID;
@ -1573,6 +1576,7 @@ class WP_Privacy_Data_Removal_Requests_Table extends WP_Privacy_Requests_Table {
esc_html_e( 'Waiting for confirmation' ); esc_html_e( 'Waiting for confirmation' );
break; break;
case 'request-confirmed': case 'request-confirmed':
/** This filter is documented in wp-admin/includes/ajax-actions.php */
$erasers = apply_filters( 'wp_privacy_personal_data_erasers', array() ); $erasers = apply_filters( 'wp_privacy_personal_data_erasers', array() );
$erasers_count = count( $erasers ); $erasers_count = count( $erasers );
$request_id = $item->ID; $request_id = $item->ID;