WordPress 4.9.6では、欧州連合の一般データ保護規則(GDPR)などの法律に準拠するための新しいツールが追加されました。追加されたツールの中には、特定のユーザーのすべての個人データをZIPファイルでエクスポートすることをサポートする個人データエクスポートツールがあります。WordPressのコメントなどに保存されている個人データに加えて、プラグインはエクスポータ機能にフックして、ポストメタやまったく新しいカスタム投稿タイプ(CPT)などで収集した個人データをエクスポートすることもできます。
すべてのエクスポートの「キー」はユーザーのメールアドレスです。これは、完全に登録されたユーザーと未登録のユーザー(例:ログアウトしたコメント者)の両方の個人データをエクスポートすることをサポートするために選ばれました。
ただし、個人データエクスポートを組み立てることは負荷の高いプロセスであり、機密データが含まれる可能性があるため、リクエストを確認せずに単に生成してリクエスト者にメールで送信したくありません。そのため、管理者向けのユーザーインターフェースは、すべてのリクエストを管理者がリクエストを行うユーザー名またはメールアドレスを入力することから始め、その後、リクエストを確認するためのリンクをクリックするように送信します。
リクエストが確認されると、管理者はユーザーの個人データエクスポートZIPファイルを生成してダウンロードするか、直接メールで送信することができます。また、必要に応じてエクスポートを行うこともできます。ユーザーが受け取るZIPファイルの中には、個人データがグループ(例:コメント用のグループなど)に整理されたインデックスHTMLページを含む「ミニウェブサイト」が見つかります。
管理者が個人データエクスポートZIPファイルをダウンロードするか、リクエスト者に直接送信するかにかかわらず、個人データエクスポートの組み立て方は同じです。これは、すべてのデータを収集するための「エクスポータ」コールバックにフックすることに依存しています。管理者がダウンロードまたはメールリンクをクリックすると、AJAXループが開始され、システムに登録されたすべてのエクスポータを1つずつ繰り返します。コアに組み込まれたエクスポータに加えて、プラグインは独自のエクスポータコールバックを登録できます。
エクスポータコールバックインターフェースは、できるだけシンプルに設計されています。エクスポータコールバックは、作業中のメールアドレスとページパラメータを受け取ります。ページパラメータ(1から始まる)は、プラグインが一度に収集したすべての個人データをエクスポートしようとすることでタイムアウトを引き起こすのを避けるために使用されます。適切に動作するプラグインは、ページごとに消去しようとするデータの量を制限します(例:100件の投稿、200件のコメントなど)。
エクスポータコールバックは、そのメールアドレスとページに対して持っているデータと、処理が完了したかどうかを返します。エクスポータコールバックが完了していないと報告した場合、ページパラメータが1増加した状態で再度呼び出されます。エクスポータコールバックは、エクスポート用のアイテムの配列を返すことが期待されています。各アイテムには、そのアイテムが属するグループの識別子(例:コメント、投稿、注文など)、オプションのグループラベル(翻訳済み)、アイテム識別子(例:comment-133)、およびそのアイテムのエクスポート用データを含む名前と値のペアの配列が含まれます。
値がメディアパスである場合、メディアファイルへのリンクがエクスポートのインデックスHTMLページに追加されることは注目に値します。
すべてのエクスポータが完了するまで呼び出されると、WordPressは最初にエクスポートレポートの中心となる「インデックス」HTMLドキュメントを組み立てます。プラグインがWordPressまたは別のプラグインがすでに追加したアイテムに対して追加データを報告した場合、そのアイテムのすべてのデータが一緒に表示されます。
エクスポートはサーバー上で3日間キャッシュされ、その後削除されます。
プラグインは1つ以上のエクスポータを登録できますが、ほとんどのプラグインは1つだけで十分です。コメントに対してコメント者の位置データを追加する仮想プラグインを考えてみましょう。
まず、プラグインがadd_comment_meta
を使用してmeta_key
のlatitude
とlongitude
を使用して位置データを追加したと仮定します。
プラグインが最初に行う必要があるのは、メールアドレスとページを受け入れるエクスポータ関数を作成することです。例:
/**
* Export user meta for a user using the supplied email.
*
* @param string $email_address email address to manipulate
* @param int $page pagination
*
* @return array
*/
function wporg_export_user_data_by_email( $email_address, $page = 1 ) {
$number = 500; // Limit us to avoid timing out
$page = (int) $page;
$export_items = array();
$comments = get_comments(
array(
'author_email' => $email_address,
'number' => $number,
'paged' => $page,
'order_by' => 'comment_ID',
'order' => 'ASC',
)
);
foreach ( (array) $comments as $comment ) {
$latitude = get_comment_meta( $comment->comment_ID, 'latitude', true );
$longitude = get_comment_meta( $comment->comment_ID, 'longitude', true );
// Only add location data to the export if it is not empty.
if ( ! empty( $latitude ) ) {
// Most item IDs should look like postType-postID. If you don't have a post, comment or other ID to work with,
// use a unique value to avoid having this item's export combined in the final report with other items
// of the same id.
$item_id = "comment-{$comment->comment_ID}";
// Core group IDs include 'comments', 'posts', etc. But you can add your own group IDs as needed
$group_id = 'comments';
// Optional group label. Core provides these for core groups. If you define your own group, the first
// exporter to include a label will be used as the group label in the final exported report.
$group_label = __( 'Comments', 'text-domain' );
// Plugins can add as many items in the item data array as they want.
$data = array(
array(
'name' => __( 'Commenter Latitude', 'text-domain' ),
'value' => $latitude,
),
array(
'name' => __( 'Commenter Longitude', 'text-domain' ),
'value' => $longitude,
),
);
$export_items[] = array(
'group_id' => $group_id,
'group_label' => $group_label,
'item_id' => $item_id,
'data' => $data,
);
}
}
// Tell core if we have more comments to work on still.
$done = count( $comments ) > $number;
return array(
'data' => $export_items,
'done' => $done,
);
}
次に、プラグインはwp_privacy_personal_data_exporters
フィルターを使用してエクスポータ配列をフィルタリングすることでコールバックを登録する必要があります。
登録時には、エクスポートのフレンドリーネーム(デバッグを助けるため – このフレンドリーネームは現時点では誰にも表示されません)とコールバックを提供します。例:
/**
* Registers all data exporters.
*
* @param array $exporters
*
* @return mixed
*/
function wporg_register_user_data_exporters( $exporters ) {
$exporters['my-plugin-slug'] = array(
'exporter_friendly_name' => __( 'Comment Location Plugin', 'text-domain' ),
'callback' => 'my_plugin_exporter',
);
return $exporters;
}
add_filter( 'wp_privacy_personal_data_exporters', 'wporg_register_user_data_exporters' );
これで完了です!あなたのプラグインは、エクスポート用のデータを提供するようになります!