云策 WordPress 开发者社区

函数文档

_wp_privacy_account_request_confirmed_message()

查看官方原文 ↗
💡 云策文档标注

概述

_wp_privacy_account_request_confirmed_message() 函数用于生成用户确认数据请求后的消息 HTML。它根据请求类型（如导出或删除个人数据）返回相应的确认信息，并支持通过过滤器进行自定义。

关键要点

  • 函数接受一个必需的整数参数 $request_id，表示要确认的请求 ID。
  • 返回字符串类型的确认消息，内容基于请求类型动态生成。
  • 支持过滤器 user_request_action_confirmed_message，允许开发者自定义消息内容。
  • 内部使用 wp_get_user_request() 和 _wp_privacy_action_request_types() 辅助函数。

代码示例

function _wp_privacy_account_request_confirmed_message( $request_id ) {
    $request = wp_get_user_request( $request_id );

    $message  = '' . __( 'Action has been confirmed.' ) . '';
    $message .= '' . __( 'The site administrator has been notified and will fulfill your request as soon as possible.' ) . '';

    if ( $request && in_array( $request->action_name, _wp_privacy_action_request_types(), true ) ) {
        if ( 'export_personal_data' === $request->action_name ) {
            $message  = '' . __( 'Thanks for confirming your export request.' ) . '';
            $message .= '' . __( 'The site administrator has been notified. You will receive a link to download your export via email when they fulfill your request.' ) . '';
        } elseif ( 'remove_personal_data' === $request->action_name ) {
            $message  = '' . __( 'Thanks for confirming your erasure request.' ) . '';
            $message .= '' . __( 'The site administrator has been notified. You will receive an email confirmation when they erase your data.' ) . '';
        }
    }

    $message = apply_filters( 'user_request_action_confirmed_message', $message, $request_id );

    return $message;
}

注意事项

  • 此函数自 WordPress 4.9.6 版本引入，主要用于隐私数据请求处理流程。
  • 消息内容已国际化，使用 __() 函数进行翻译，确保多语言支持。
  • 开发者可通过 apply_filters() 钩子修改输出消息，以适应特定需求。
📄 原文内容

Returns request confirmation message HTML.

Parameters

$request_idintrequired
The request ID being confirmed.

Return

string The confirmation message.

Source

function _wp_privacy_account_request_confirmed_message( $request_id ) {
	$request = wp_get_user_request( $request_id );

	$message  = '<p class="success">' . __( 'Action has been confirmed.' ) . '</p>';
	$message .= '<p>' . __( 'The site administrator has been notified and will fulfill your request as soon as possible.' ) . '</p>';

	if ( $request && in_array( $request->action_name, _wp_privacy_action_request_types(), true ) ) {
		if ( 'export_personal_data' === $request->action_name ) {
			$message  = '<p class="success">' . __( 'Thanks for confirming your export request.' ) . '</p>';
			$message .= '<p>' . __( 'The site administrator has been notified. You will receive a link to download your export via email when they fulfill your request.' ) . '</p>';
		} elseif ( 'remove_personal_data' === $request->action_name ) {
			$message  = '<p class="success">' . __( 'Thanks for confirming your erasure request.' ) . '</p>';
			$message .= '<p>' . __( 'The site administrator has been notified. You will receive an email confirmation when they erase your data.' ) . '</p>';
		}
	}

	/**
	 * Filters the message displayed to a user when they confirm a data request.
	 *
	 * @since 4.9.6
	 *
	 * @param string $message    The message to the user.
	 * @param int    $request_id The ID of the request being confirmed.
	 */
	$message = apply_filters( 'user_request_action_confirmed_message', $message, $request_id );

	return $message;
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘user_request_action_confirmed_message’, string $message, int $request_id )

Filters the message displayed to a user when they confirm a data request.

Uses Description
wp_get_user_request()wp-includes/user.php

Returns the user request object for the specified request ID.
_wp_privacy_action_request_types()wp-includes/user.php

Gets all personal data request types.
__()wp-includes/l10n.php

Retrieves the translation of $text.
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Show 2 moreShow less

Changelog

Version Description
4.9.6 Introduced.