Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* List Table API: WP_Privacy_Requests_Table class

[2] Fix | Delete

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage Administration

[5] Fix | Delete

* @since 4.9.6

[6] Fix | Delete

[7] Fix | Delete

[8] Fix | Delete

abstract class WP_Privacy_Requests_Table extends WP_List_Table {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Action name for the requests this table will work with. Classes

[12] Fix | Delete

* which inherit from WP_Privacy_Requests_Table should define this.

[13] Fix | Delete

[14] Fix | Delete

* Example: 'export_personal_data'.

[15] Fix | Delete

[16] Fix | Delete

* @since 4.9.6

[17] Fix | Delete

[18] Fix | Delete

* @var string $request_type Name of action.

[19] Fix | Delete

[20] Fix | Delete

protected $request_type = 'INVALID';

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Post type to be used.

[24] Fix | Delete

[25] Fix | Delete

* @since 4.9.6

[26] Fix | Delete

[27] Fix | Delete

* @var string $post_type The post type.

[28] Fix | Delete

[29] Fix | Delete

protected $post_type = 'INVALID';

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Gets columns to show in the list table.

[33] Fix | Delete

[34] Fix | Delete

* @since 4.9.6

[35] Fix | Delete

[36] Fix | Delete

* @return string[] Array of column titles keyed by their column name.

[37] Fix | Delete

[38] Fix | Delete

public function get_columns() {

[39] Fix | Delete

$columns = array(

[40] Fix | Delete

'cb' => '<input type="checkbox" />',

[41] Fix | Delete

'email' => __( 'Requester' ),

[42] Fix | Delete

'status' => __( 'Status' ),

[43] Fix | Delete

'created_timestamp' => __( 'Requested' ),

[44] Fix | Delete

'next_steps' => __( 'Next steps' ),

[45] Fix | Delete

);

[46] Fix | Delete

return $columns;

[47] Fix | Delete

}

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Normalizes the admin URL to the current page (by request_type).

[51] Fix | Delete

[52] Fix | Delete

* @since 5.3.0

[53] Fix | Delete

[54] Fix | Delete

* @return string URL to the current admin page.

[55] Fix | Delete

[56] Fix | Delete

protected function get_admin_url() {

[57] Fix | Delete

$pagenow = str_replace( '_', '-', $this->request_type );

[58] Fix | Delete

[59] Fix | Delete

if ( 'remove-personal-data' === $pagenow ) {

[60] Fix | Delete

$pagenow = 'erase-personal-data';

[61] Fix | Delete

}

[62] Fix | Delete

[63] Fix | Delete

return admin_url( $pagenow . '.php' );

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Gets a list of sortable columns.

[68] Fix | Delete

[69] Fix | Delete

* @since 4.9.6

[70] Fix | Delete

[71] Fix | Delete

* @return array Default sortable columns.

[72] Fix | Delete

[73] Fix | Delete

protected function get_sortable_columns() {

[74] Fix | Delete

[75] Fix | Delete

* The initial sorting is by 'Requested' (post_date) and descending.

[76] Fix | Delete

* With initial sorting, the first click on 'Requested' should be ascending.

[77] Fix | Delete

* With 'Requester' sorting active, the next click on 'Requested' should be descending.

[78] Fix | Delete

[79] Fix | Delete

$desc_first = isset( $_GET['orderby'] );

[80] Fix | Delete

[81] Fix | Delete

return array(

[82] Fix | Delete

'email' => 'requester',

[83] Fix | Delete

'created_timestamp' => array( 'requested', $desc_first ),

[84] Fix | Delete

);

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Returns the default primary column.

[89] Fix | Delete

[90] Fix | Delete

* @since 4.9.6

[91] Fix | Delete

[92] Fix | Delete

* @return string Default primary column name.

[93] Fix | Delete

[94] Fix | Delete

protected function get_default_primary_column_name() {

[95] Fix | Delete

return 'email';

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

/**

[99] Fix | Delete

* Counts the number of requests for each status.

[100] Fix | Delete

[101] Fix | Delete

* @since 4.9.6

[102] Fix | Delete

[103] Fix | Delete

* @global wpdb $wpdb WordPress database abstraction object.

[104] Fix | Delete

[105] Fix | Delete

* @return object Number of posts for each status.

[106] Fix | Delete

[107] Fix | Delete

protected function get_request_counts() {

[108] Fix | Delete

global $wpdb;

[109] Fix | Delete

[110] Fix | Delete

$cache_key = $this->post_type . '-' . $this->request_type;

[111] Fix | Delete

$counts = wp_cache_get( $cache_key, 'counts' );

[112] Fix | Delete

[113] Fix | Delete

if ( false !== $counts ) {

[114] Fix | Delete

return $counts;

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

$query = "

[118] Fix | Delete

SELECT post_status, COUNT( * ) AS num_posts

[119] Fix | Delete

FROM {$wpdb->posts}

[120] Fix | Delete

WHERE post_type = %s

[121] Fix | Delete

AND post_name = %s

[122] Fix | Delete

GROUP BY post_status";

[123] Fix | Delete

[124] Fix | Delete

$results = (array) $wpdb->get_results( $wpdb->prepare( $query, $this->post_type, $this->request_type ), ARRAY_A );

[125] Fix | Delete

$counts = array_fill_keys( get_post_stati(), 0 );

[126] Fix | Delete

[127] Fix | Delete

foreach ( $results as $row ) {

[128] Fix | Delete

$counts[ $row['post_status'] ] = $row['num_posts'];

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

$counts = (object) $counts;

[132] Fix | Delete

wp_cache_set( $cache_key, $counts, 'counts' );

[133] Fix | Delete

[134] Fix | Delete

return $counts;

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

/**

[138] Fix | Delete

* Gets an associative array ( id => link ) with the list of views available on this table.

[139] Fix | Delete

[140] Fix | Delete

* @since 4.9.6

[141] Fix | Delete

[142] Fix | Delete

* @return string[] An array of HTML links keyed by their view.

[143] Fix | Delete

[144] Fix | Delete

protected function get_views() {

[145] Fix | Delete

$current_status = isset( $_REQUEST['filter-status'] ) ? sanitize_text_field( $_REQUEST['filter-status'] ) : '';

[146] Fix | Delete

$statuses = _wp_privacy_statuses();

[147] Fix | Delete

$views = array();

[148] Fix | Delete

$counts = $this->get_request_counts();

[149] Fix | Delete

$total_requests = absint( array_sum( (array) $counts ) );

[150] Fix | Delete

[151] Fix | Delete

// Normalized admin URL.

[152] Fix | Delete

$admin_url = $this->get_admin_url();

[153] Fix | Delete

[154] Fix | Delete

$status_label = sprintf(

[155] Fix | Delete

/* translators: %s: Number of requests. */

[156] Fix | Delete

_nx(

[157] Fix | Delete

'All (%s)',

[158] Fix | Delete

'All (%s)',

[159] Fix | Delete

$total_requests,

[160] Fix | Delete

'requests'

[161] Fix | Delete

[162] Fix | Delete

number_format_i18n( $total_requests )

[163] Fix | Delete

);

[164] Fix | Delete

[165] Fix | Delete

$views['all'] = array(

[166] Fix | Delete

'url' => esc_url( $admin_url ),

[167] Fix | Delete

'label' => $status_label,

[168] Fix | Delete

'current' => empty( $current_status ),

[169] Fix | Delete

);

[170] Fix | Delete

[171] Fix | Delete

foreach ( $statuses as $status => $label ) {

[172] Fix | Delete

$post_status = get_post_status_object( $status );

[173] Fix | Delete

if ( ! $post_status ) {

[174] Fix | Delete

continue;

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

$total_status_requests = absint( $counts->{$status} );

[178] Fix | Delete

[179] Fix | Delete

if ( ! $total_status_requests ) {

[180] Fix | Delete

continue;

[181] Fix | Delete

}

[182] Fix | Delete

[183] Fix | Delete

$status_label = sprintf(

[184] Fix | Delete

translate_nooped_plural( $post_status->label_count, $total_status_requests ),

[185] Fix | Delete

number_format_i18n( $total_status_requests )

[186] Fix | Delete

);

[187] Fix | Delete

[188] Fix | Delete

$status_link = add_query_arg( 'filter-status', $status, $admin_url );

[189] Fix | Delete

[190] Fix | Delete

$views[ $status ] = array(

[191] Fix | Delete

'url' => esc_url( $status_link ),

[192] Fix | Delete

'label' => $status_label,

[193] Fix | Delete

'current' => $status === $current_status,

[194] Fix | Delete

);

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

return $this->get_views_links( $views );

[198] Fix | Delete

}

[199] Fix | Delete

[200] Fix | Delete

/**

[201] Fix | Delete

* Gets bulk actions.

[202] Fix | Delete

[203] Fix | Delete

* @since 4.9.6

[204] Fix | Delete

[205] Fix | Delete

* @return array Array of bulk action labels keyed by their action.

[206] Fix | Delete

[207] Fix | Delete

protected function get_bulk_actions() {

[208] Fix | Delete

return array(

[209] Fix | Delete

'resend' => __( 'Resend confirmation requests' ),

[210] Fix | Delete

'complete' => __( 'Mark requests as completed' ),

[211] Fix | Delete

'delete' => __( 'Delete requests' ),

[212] Fix | Delete

);

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

/**

[216] Fix | Delete

* Process bulk actions.

[217] Fix | Delete

[218] Fix | Delete

* @since 4.9.6

[219] Fix | Delete

* @since 5.6.0 Added support for the `complete` action.

[220] Fix | Delete

[221] Fix | Delete

public function process_bulk_action() {

[222] Fix | Delete

$action = $this->current_action();

[223] Fix | Delete

$request_ids = isset( $_REQUEST['request_id'] ) ? wp_parse_id_list( wp_unslash( $_REQUEST['request_id'] ) ) : array();

[224] Fix | Delete

[225] Fix | Delete

if ( empty( $request_ids ) ) {

[226] Fix | Delete

return;

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

$count = 0;

[230] Fix | Delete

$failures = 0;

[231] Fix | Delete

[232] Fix | Delete

check_admin_referer( 'bulk-privacy_requests' );

[233] Fix | Delete

[234] Fix | Delete

switch ( $action ) {

[235] Fix | Delete

case 'resend':

[236] Fix | Delete

foreach ( $request_ids as $request_id ) {

[237] Fix | Delete

$resend = _wp_privacy_resend_request( $request_id );

[238] Fix | Delete

[239] Fix | Delete

if ( $resend && ! is_wp_error( $resend ) ) {

[240] Fix | Delete

++$count;

[241] Fix | Delete

} else {

[242] Fix | Delete

++$failures;

[243] Fix | Delete

}

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

if ( $failures ) {

[247] Fix | Delete

add_settings_error(

[248] Fix | Delete

'bulk_action',

[249] Fix | Delete

'bulk_action',

[250] Fix | Delete

sprintf(

[251] Fix | Delete

/* translators: %d: Number of requests. */

[252] Fix | Delete

_n(

[253] Fix | Delete

'%d confirmation request failed to resend.',

[254] Fix | Delete

'%d confirmation requests failed to resend.',

[255] Fix | Delete

$failures

[256] Fix | Delete

[257] Fix | Delete

$failures

[258] Fix | Delete

[259] Fix | Delete

'error'

[260] Fix | Delete

);

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

if ( $count ) {

[264] Fix | Delete

add_settings_error(

[265] Fix | Delete

'bulk_action',

[266] Fix | Delete

'bulk_action',

[267] Fix | Delete

sprintf(

[268] Fix | Delete

/* translators: %d: Number of requests. */

[269] Fix | Delete

_n(

[270] Fix | Delete

'%d confirmation request re-sent successfully.',

[271] Fix | Delete

'%d confirmation requests re-sent successfully.',

[272] Fix | Delete

$count

[273] Fix | Delete

[274] Fix | Delete

$count

[275] Fix | Delete

[276] Fix | Delete

'success'

[277] Fix | Delete

);

[278] Fix | Delete

}

[279] Fix | Delete

[280] Fix | Delete

break;

[281] Fix | Delete

[282] Fix | Delete

case 'complete':

[283] Fix | Delete

foreach ( $request_ids as $request_id ) {

[284] Fix | Delete

$result = _wp_privacy_completed_request( $request_id );

[285] Fix | Delete

[286] Fix | Delete

if ( $result && ! is_wp_error( $result ) ) {

[287] Fix | Delete

++$count;

[288] Fix | Delete

}

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete

add_settings_error(

[292] Fix | Delete

'bulk_action',

[293] Fix | Delete

'bulk_action',

[294] Fix | Delete

sprintf(

[295] Fix | Delete

/* translators: %d: Number of requests. */

[296] Fix | Delete

_n(

[297] Fix | Delete

'%d request marked as complete.',

[298] Fix | Delete

'%d requests marked as complete.',

[299] Fix | Delete

$count

[300] Fix | Delete

[301] Fix | Delete

$count

[302] Fix | Delete

[303] Fix | Delete

'success'

[304] Fix | Delete

);

[305] Fix | Delete

break;

[306] Fix | Delete

[307] Fix | Delete

case 'delete':

[308] Fix | Delete

foreach ( $request_ids as $request_id ) {

[309] Fix | Delete

if ( wp_delete_post( $request_id, true ) ) {

[310] Fix | Delete

++$count;

[311] Fix | Delete

} else {

[312] Fix | Delete

++$failures;

[313] Fix | Delete

}

[314] Fix | Delete

}

[315] Fix | Delete

[316] Fix | Delete

if ( $failures ) {

[317] Fix | Delete

add_settings_error(

[318] Fix | Delete

'bulk_action',

[319] Fix | Delete

'bulk_action',

[320] Fix | Delete

sprintf(

[321] Fix | Delete

/* translators: %d: Number of requests. */

[322] Fix | Delete

_n(

[323] Fix | Delete

'%d request failed to delete.',

[324] Fix | Delete

'%d requests failed to delete.',

[325] Fix | Delete

$failures

[326] Fix | Delete

[327] Fix | Delete

$failures

[328] Fix | Delete

[329] Fix | Delete

'error'

[330] Fix | Delete

);

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

if ( $count ) {

[334] Fix | Delete

add_settings_error(

[335] Fix | Delete

'bulk_action',

[336] Fix | Delete

'bulk_action',

[337] Fix | Delete

sprintf(

[338] Fix | Delete

/* translators: %d: Number of requests. */

[339] Fix | Delete

_n(

[340] Fix | Delete

'%d request deleted successfully.',

[341] Fix | Delete

'%d requests deleted successfully.',

[342] Fix | Delete

$count

[343] Fix | Delete

[344] Fix | Delete

$count

[345] Fix | Delete

[346] Fix | Delete

'success'

[347] Fix | Delete

);

[348] Fix | Delete

}

[349] Fix | Delete

[350] Fix | Delete

break;

[351] Fix | Delete

}

[352] Fix | Delete

}

[353] Fix | Delete

[354] Fix | Delete

/**

[355] Fix | Delete

* Prepares items to output.

[356] Fix | Delete

[357] Fix | Delete

* @since 4.9.6

[358] Fix | Delete

* @since 5.1.0 Added support for column sorting.

[359] Fix | Delete

[360] Fix | Delete

public function prepare_items() {

[361] Fix | Delete

$this->items = array();

[362] Fix | Delete

$posts_per_page = $this->get_items_per_page( $this->request_type . '_requests_per_page' );

[363] Fix | Delete

$args = array(

[364] Fix | Delete

'post_type' => $this->post_type,

[365] Fix | Delete

'post_name__in' => array( $this->request_type ),

[366] Fix | Delete

'posts_per_page' => $posts_per_page,

[367] Fix | Delete

'offset' => isset( $_REQUEST['paged'] ) ? max( 0, absint( $_REQUEST['paged'] ) - 1 ) * $posts_per_page : 0,

[368] Fix | Delete

'post_status' => 'any',

[369] Fix | Delete

's' => isset( $_REQUEST['s'] ) ? sanitize_text_field( $_REQUEST['s'] ) : '',

[370] Fix | Delete

);

[371] Fix | Delete

[372] Fix | Delete

$orderby_mapping = array(

[373] Fix | Delete

'requester' => 'post_title',

[374] Fix | Delete

'requested' => 'post_date',

[375] Fix | Delete

);

[376] Fix | Delete

[377] Fix | Delete

if ( isset( $_REQUEST['orderby'] ) && isset( $orderby_mapping[ $_REQUEST['orderby'] ] ) ) {

[378] Fix | Delete

$args['orderby'] = $orderby_mapping[ $_REQUEST['orderby'] ];

[379] Fix | Delete

}

[380] Fix | Delete

[381] Fix | Delete

if ( isset( $_REQUEST['order'] ) && in_array( strtoupper( $_REQUEST['order'] ), array( 'ASC', 'DESC' ), true ) ) {

[382] Fix | Delete

$args['order'] = strtoupper( $_REQUEST['order'] );

[383] Fix | Delete

}

[384] Fix | Delete

[385] Fix | Delete

if ( ! empty( $_REQUEST['filter-status'] ) ) {

[386] Fix | Delete

$filter_status = isset( $_REQUEST['filter-status'] ) ? sanitize_text_field( $_REQUEST['filter-status'] ) : '';

[387] Fix | Delete

$args['post_status'] = $filter_status;

[388] Fix | Delete

}

[389] Fix | Delete

[390] Fix | Delete

$requests_query = new WP_Query( $args );

[391] Fix | Delete

$requests = $requests_query->posts;

[392] Fix | Delete

[393] Fix | Delete

foreach ( $requests as $request ) {

[394] Fix | Delete

$this->items[] = wp_get_user_request( $request->ID );

[395] Fix | Delete

}

[396] Fix | Delete

[397] Fix | Delete

$this->items = array_filter( $this->items );

[398] Fix | Delete

[399] Fix | Delete

$this->set_pagination_args(

[400] Fix | Delete

array(

[401] Fix | Delete

'total_items' => $requests_query->found_posts,

[402] Fix | Delete

'per_page' => $posts_per_page,

[403] Fix | Delete

)

[404] Fix | Delete

);

[405] Fix | Delete

}

[406] Fix | Delete

[407] Fix | Delete

/**

[408] Fix | Delete

* Returns the markup for the Checkbox column.

[409] Fix | Delete

[410] Fix | Delete

* @since 4.9.6

[411] Fix | Delete

[412] Fix | Delete

* @param WP_User_Request $item Item being shown.

[413] Fix | Delete

* @return string Checkbox column markup.

[414] Fix | Delete

[415] Fix | Delete

public function column_cb( $item ) {

[416] Fix | Delete

return sprintf(

[417] Fix | Delete

'<input type="checkbox" name="request_id[]" id="requester_%1$s" value="%1$s" />' .

[418] Fix | Delete

'<label for="requester_%1$s">%2$s</label>',

[419] Fix | Delete

esc_attr( $item->ID ),

[420] Fix | Delete

/* translators: Hidden accessibility text. %s: Email address. */

[421] Fix | Delete

sprintf( __( 'Select %s' ), $item->email )

[422] Fix | Delete

);

[423] Fix | Delete

}

[424] Fix | Delete

[425] Fix | Delete

/**

[426] Fix | Delete

* Status column.

[427] Fix | Delete

[428] Fix | Delete

* @since 4.9.6

[429] Fix | Delete

[430] Fix | Delete

* @param WP_User_Request $item Item being shown.

[431] Fix | Delete

* @return string Status column markup.

[432] Fix | Delete

[433] Fix | Delete

public function column_status( $item ) {

[434] Fix | Delete

$status = get_post_status( $item->ID );

[435] Fix | Delete

$status_object = get_post_status_object( $status );

[436] Fix | Delete

[437] Fix | Delete

if ( ! $status_object || empty( $status_object->label ) ) {

[438] Fix | Delete

return '-';

[439] Fix | Delete

}

[440] Fix | Delete

[441] Fix | Delete

$timestamp = false;

[442] Fix | Delete

[443] Fix | Delete

switch ( $status ) {

[444] Fix | Delete

case 'request-confirmed':

[445] Fix | Delete

$timestamp = $item->confirmed_timestamp;

[446] Fix | Delete

break;

[447] Fix | Delete

case 'request-completed':

[448] Fix | Delete

$timestamp = $item->completed_timestamp;

[449] Fix | Delete

break;

[450] Fix | Delete

}

[451] Fix | Delete

[452] Fix | Delete

echo '';

[453] Fix | Delete

echo esc_html( $status_object->label );

[454] Fix | Delete

[455] Fix | Delete

if ( $timestamp ) {

[456] Fix | Delete

echo ' (' . $this->get_timestamp_as_date( $timestamp ) . ')';

[457] Fix | Delete

}

[458] Fix | Delete

[459] Fix | Delete

echo '';

[460] Fix | Delete

}

[461] Fix | Delete

[462] Fix | Delete

/**

[463] Fix | Delete

* Converts a timestamp for display.

[464] Fix | Delete

[465] Fix | Delete

* @since 4.9.6

[466] Fix | Delete

[467] Fix | Delete

* @param int $timestamp Event timestamp.

[468] Fix | Delete

* @return string Human readable date.

[469] Fix | Delete

[470] Fix | Delete

protected function get_timestamp_as_date( $timestamp ) {

[471] Fix | Delete

if ( empty( $timestamp ) ) {

[472] Fix | Delete

return '';

[473] Fix | Delete

}

[474] Fix | Delete

[475] Fix | Delete

$time_diff = time() - $timestamp;

[476] Fix | Delete

[477] Fix | Delete

if ( $time_diff >= 0 && $time_diff < DAY_IN_SECONDS ) {

[478] Fix | Delete

/* translators: %s: Human-readable time difference. */

[479] Fix | Delete

return sprintf( __( '%s ago' ), human_time_diff( $timestamp ) );

[480] Fix | Delete

}

[481] Fix | Delete

[482] Fix | Delete

return date_i18n( get_option( 'date_format' ), $timestamp );

[483] Fix | Delete

}

[484] Fix | Delete

[485] Fix | Delete

/**

[486] Fix | Delete

* Handles the default column.

[487] Fix | Delete

[488] Fix | Delete

* @since 4.9.6

[489] Fix | Delete

* @since 5.7.0 Added `manage_{$this->screen->id}_custom_column` action.

[490] Fix | Delete

[491] Fix | Delete

* @param WP_User_Request $item Item being shown.

[492] Fix | Delete

* @param string $column_name Name of column being shown.

[493] Fix | Delete

[494] Fix | Delete

public function column_default( $item, $column_name ) {

[495] Fix | Delete

/**

[496] Fix | Delete

* Fires for each custom column of a specific request type in the Requests list table.

[497] Fix | Delete

[498] Fix | Delete

* Custom columns are registered using the {@see 'manage_export-personal-data_columns'}

[499] Fix | Delete