Make WordPress Core


Ignore:
Timestamp:
05/21/2018 01:02:55 PM (6 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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/file.php

    r43299 r43303  
    19411941 * @since 4.9.6
    19421942 *
    1943  * @param array  $group_data {
     1943 * @param array $group_data {
    19441944 *     The group data to render.
    19451945 *
     
    20032003 * @since 4.9.6
    20042004 *
    2005  * @param int  $request_id The export request ID.
     2005 * @param int $request_id The export request ID.
    20062006 */
    20072007function wp_privacy_generate_personal_data_export_file( $request_id ) {
     
    21672167             * @param string $archive_url          The URL of the archive file.
    21682168             * @param string $html_report_pathname The full path to the personal data report on the filesystem.
    2169              * @param string $request_id           The export request ID.
     2169             * @param int    $request_id           The export request ID.
    21702170             */
    21712171            do_action( 'wp_privacy_personal_data_export_file_created', $archive_pathname, $archive_url, $html_report_pathname, $request_id );
     
    21882188 * @since 4.9.6
    21892189 *
    2190  * @param int  $request_id The request ID for this personal data export.
    2191  * @return true|WP_Error    True on success or `WP_Error` on failure.
     2190 * @param int $request_id The request ID for this personal data export.
     2191 * @return true|WP_Error True on success or `WP_Error` on failure.
    21922192 */
    21932193function wp_privacy_send_personal_data_export_email( $request_id ) {
     
    21992199    }
    22002200
    2201     /** This filter is documented in wp-admin/includes/file.php */
     2201    /** This filter is documented in wp-includes/functions.php */
    22022202    $expiration      = apply_filters( 'wp_privacy_export_expiration', 3 * DAY_IN_SECONDS );
    22032203    $expiration_date = date_i18n( get_option( 'date_format' ), time() + $expiration );
     
    23212321
    23222322    // If we are not yet on the last page of the last exporter, return now.
     2323    /** This filter is documented in wp-admin/includes/ajax-actions.php */
    23232324    $exporters = apply_filters( 'wp_privacy_personal_data_exporters', array() );
    23242325    $is_last_exporter = $exporter_index === count( $exporters );
     
    23562357    update_post_meta( $request_id, '_export_data_grouped', $groups );
    23572358
    2358     // Generate the export file from the collected, grouped personal data.
     2359    /**
     2360     * Generate the export file from the collected, grouped personal data.
     2361     *
     2362     * @since 4.9.6
     2363     *
     2364     * @param int $request_id The export request ID.
     2365     */
    23592366    do_action( 'wp_privacy_personal_data_export_file', $request_id );
    23602367
Note: See TracChangeset for help on using the changeset viewer.