WP_Privacy_Data_Removal_Requests_List_Table

💡 云策文档标注

概述

WP_Privacy_Data_Removal_Requests_List_Table 是 WordPress 中用于管理个人数据删除请求的列表表格类，继承自 WP_Privacy_Requests_Table。它定义了特定于数据删除请求的列输出和行为。

关键要点

该类用于处理个人数据删除请求的列表显示，扩展了 WP_Privacy_Requests_Table。
核心方法包括 column_email 和 column_next_steps，分别输出 Actions 列和 Next steps 列。
支持根据请求状态（如 request-confirmed、request-completed）动态生成操作按钮，如强制擦除数据、完成请求等。
使用 WordPress 的 Hook（如 wp_privacy_personal_data_erasers）和 nonce 安全机制。
从 WordPress 4.9.6 版本引入，用于替代已弃用的 WP_Privacy_Data_Removal_Requests_Table 类。

代码示例

public function column_email( $item ) {
    $row_actions = array();
    $status = $item->status;
    $request_id = $item->ID;
    if ( 'request-confirmed' !== $status ) {
        $erasers = apply_filters( 'wp_privacy_personal_data_erasers', array() );
        $erasers_count = count( $erasers );
        $nonce = wp_create_nonce( 'wp-privacy-erase-personal-data-' . $request_id );
        $remove_data_markup = '<button type="button" class="button-link remove-data">' . __( 'Force erase personal data' ) . '</button>';
        $row_actions['remove-data'] = $remove_data_markup;
    }
    return sprintf( '<a href="%1$s">%2$s</a> %3$s', esc_url( 'mailto:' . $item->email ), $item->email, $this->row_actions( $row_actions ) );
}

注意事项

该类依赖于 WP_User_Request 对象来获取请求状态和 ID，确保传入正确的参数。
在输出列时，需注意安全处理，如使用 esc_url、esc_attr 和 wp_nonce_url 函数。
状态处理逻辑需与 WordPress 核心的隐私请求流程保持一致，避免自定义修改导致功能异常。

📄 原文内容

WP_Privacy_Data_Removal_Requests_List_Table class.

Methods

Name	Description
WP_Privacy_Data_Removal_Requests_List_Table::column_email	Outputs the Actions column.
WP_Privacy_Data_Removal_Requests_List_Table::column_next_steps	Outputs the Next steps column.

Source

class WP_Privacy_Data_Removal_Requests_List_Table extends WP_Privacy_Requests_Table {
	/**
	 * Action name for the requests this table will work with.
	 *
	 * @since 4.9.6
	 *
	 * @var string $request_type Name of action.
	 */
	protected $request_type = 'remove_personal_data';

	/**
	 * Post type for the requests.
	 *
	 * @since 4.9.6
	 *
	 * @var string $post_type The post type.
	 */
	protected $post_type = 'user_request';

	/**
	 * Outputs the Actions column.
	 *
	 * @since 4.9.6
	 *
	 * @param WP_User_Request $item Item being shown.
	 * @return string Email column markup.
	 */
	public function column_email( $item ) {
		$row_actions = array();

		// Allow the administrator to "force remove" the personal data even if confirmation has not yet been received.
		$status      = $item->status;
		$request_id  = $item->ID;
		$row_actions = array();
		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 );
			$nonce         = wp_create_nonce( 'wp-privacy-erase-personal-data-' . $request_id );

			$remove_data_markup = '<span class="remove-personal-data force-remove-personal-data" ' .
				'data-erasers-count="' . esc_attr( $erasers_count ) . '" ' .
				'data-request-id="' . esc_attr( $request_id ) . '" ' .
				'data-nonce="' . esc_attr( $nonce ) .
				'">';

			$remove_data_markup .= '<span class="remove-personal-data-idle"><button type="button" class="button-link remove-personal-data-handle">' . __( 'Force erase personal data' ) . '</button></span>' .
				'<span class="remove-personal-data-processing hidden">' . __( 'Erasing data...' ) . ' <span class="erasure-progress"></span></span>' .
				'<span class="remove-personal-data-success hidden">' . __( 'Erasure completed.' ) . '</span>' .
				'<span class="remove-personal-data-failed hidden">' . __( 'Force erasure has failed.' ) . ' <button type="button" class="button-link remove-personal-data-handle">' . __( 'Retry' ) . '</button></span>';

			$remove_data_markup .= '</span>';

			$row_actions['remove-data'] = $remove_data_markup;
		}

		if ( 'request-completed' !== $status ) {
			$complete_request_markup  = '<span>';
			$complete_request_markup .= sprintf(
				'<a href="%s" class="complete-request" aria-label="%s">%s</a>',
				esc_url(
					wp_nonce_url(
						add_query_arg(
							array(
								'action'     => 'complete',
								'request_id' => array( $request_id ),
							),
							admin_url( 'erase-personal-data.php' )
						),
						'bulk-privacy_requests'
					)
				),
				esc_attr(
					sprintf(
						/* translators: %s: Request email. */
						__( 'Mark export request for “%s” as completed.' ),
						$item->email
					)
				),
				__( 'Complete request' )
			);
			$complete_request_markup .= '</span>';
		}

		if ( ! empty( $complete_request_markup ) ) {
			$row_actions['complete-request'] = $complete_request_markup;
		}

		return sprintf( '<a href="%1$s">%2$s</a> %3$s', esc_url( 'mailto:' . $item->email ), $item->email, $this->row_actions( $row_actions ) );
	}

	/**
	 * Outputs the Next steps column.
	 *
	 * @since 4.9.6
	 *
	 * @param WP_User_Request $item Item being shown.
	 */
	public function column_next_steps( $item ) {
		$status = $item->status;

		switch ( $status ) {
			case 'request-pending':
				esc_html_e( 'Waiting for confirmation' );
				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 );
				$request_id    = $item->ID;
				$nonce         = wp_create_nonce( 'wp-privacy-erase-personal-data-' . $request_id );

				echo '<div class="remove-personal-data" ' .
					'data-force-erase="1" ' .
					'data-erasers-count="' . esc_attr( $erasers_count ) . '" ' .
					'data-request-id="' . esc_attr( $request_id ) . '" ' .
					'data-nonce="' . esc_attr( $nonce ) .
					'">';

				?>
				<span class="remove-personal-data-idle"><button type="button" class="button-link remove-personal-data-handle"></button></span>
				<span class="remove-personal-data-processing hidden"> <span class="erasure-progress"></span></span>
				<span class="remove-personal-data-success success-message hidden" ></span>
				<span class="remove-personal-data-failed hidden"> <button type="button" class="button-link remove-personal-data-handle"></button></span>
				';

				break;
			case 'request-failed':
				echo '<button type="submit" class="button-link" name="privacy_action_email_retry[' . $item->ID . ']" id="privacy_action_email_retry[' . $item->ID . ']">' . __( 'Retry' ) . '</button>';
				break;
			case 'request-completed':
				echo '<a href="' . esc_url(
					wp_nonce_url(
						add_query_arg(
							array(
								'action'     => 'delete',
								'request_id' => array( $item->ID ),
							),
							admin_url( 'erase-personal-data.php' )
						),
						'bulk-privacy_requests'
					)
				) . '">' . esc_html__( 'Remove request' ) . '</a>';
				break;
		}
	}
}

View all references View on Trac View on GitHub

Uses	Description
WP_Privacy_Requests_Table`wp-admin/includes/class-wp-privacy-requests-table.php`	List Table API: WP_Privacy_Requests_Table class

Used by	Description
WP_Privacy_Data_Removal_Requests_Table`wp-admin/includes/deprecated.php`	Previous class for list table for privacy data erasure requests.

Changelog

Version	Description
4.9.6	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.

云策 WordPress 开发者社区

类文档

WP_Privacy_Data_Removal_Requests_List_Table

概述

关键要点

代码示例

注意事项

Methods

Source

Changelog

User Contributed Notes

类文档

概述

关键要点

代码示例

注意事项

Methods

Source

Related

Changelog

User Contributed Notes