プラグインWooCommerceのwoocommerce_privacy_remove_order_personal_data_metaフィルタの使用方法・解説

概要

woocommerce_privacy_remove_order_personal_data_meta フィルタは、WooCommerceのプラグインにおいて、注文に関連する個人データのメタ情報を削除するために使用されます。このフィルタは、データプライバシーに関する要求やGDPRの遵守を行う際に役立ちます。具体的には以下の利用シーンが考えられます。

顧客がアカウントを削除した際に関連するメタデータをクリーンアップする。
オーダーの削除リクエストに対して自動的に個人情報を取り除く。
管理者が注文データをエクスポートする際に、プライバシーに配慮した情報のみにフィルタリングする。
データ保護法に基づく個人データの削除リクエストを処理するためのカスタムロジックを実装する。
機密情報が保存されている場合、システム管理者がそれを無効にするための特別なマネジメントを提供する。
特定の条件下でのみ個人データを保持するカスタムルールを作成する。

構文

add_filter('woocommerce_privacy_remove_order_personal_data_meta', 'my_custom_function');

パラメータ

このフィルタには、メタ情報を保持または削除するためのカスタム値が渡されます。

戻り値

フィルタは、削除されるメタデータを含む配列を返します。

WooCommerce と WordPress のバージョン

WooCommerce: 4.0 以上
WordPress: 5.0 以上

サンプルコード

サンプルコード1: 特定のメタデータを削除する

add_filter('woocommerce_privacy_remove_order_personal_data_meta', 'remove_custom_order_meta', 10, 2);

function remove_custom_order_meta($meta_keys, $order) {
    // 'billing_phone' メタデータを削除対象として追加
    $meta_keys[] = 'billing_phone';
    return $meta_keys;
}

このサンプルコードは、注文から「billing_phone」というメタデータを削除するように指定します。

サンプルコード2: 条件付きでメタデータを削除

add_filter('woocommerce_privacy_remove_order_personal_data_meta', 'conditionally_remove_meta', 10, 2);

function conditionally_remove_meta($meta_keys, $order) {
    if ($order->get_total() > 100) {
        // 合計金額が100ドルを超える場合、'billing_email' メタデータを削除
        $meta_keys[] = 'billing_email';
    }
    return $meta_keys;
}

このコードでは、合計金額が100ドルを超える場合に「billing_email」メタデータを削除します。

サンプルコード3: カスタムメタデータの追加削除

add_filter('woocommerce_privacy_remove_order_personal_data_meta', 'add_custom_meta_to_remove', 10, 2);

function add_custom_meta_to_remove($meta_keys, $order) {
    // 独自のメタデータ 'custom_note' を削除対象に追加
    $meta_keys[] = 'custom_note';
    return $meta_keys;
}

このサンプルコードは、カスタムメタデータ「custom_note」を削除対象として追加します。

サンプルコード4: 複数のメタデータを一度に削除

add_filter('woocommerce_privacy_remove_order_personal_data_meta', 'remove_multiple_meta', 10, 2);

function remove_multiple_meta($meta_keys, $order) {
    // 一度に複数のメタデータを削除
    $meta_keys = array_merge($meta_keys, ['billing_address_1', 'billing_address_2']);
    return $meta_keys;
}

このコードは、一度に「billing_address_1」と「billing_address_2」の両方のメタデータを削除対象にします。

サンプルコード5: ユーザーのロールによるメタデータの削除

add_filter('woocommerce_privacy_remove_order_personal_data_meta', 'remove_meta_based_on_role', 10, 2);

function remove_meta_based_on_role($meta_keys, $order) {
    if (current_user_can('administrator')) {
        // 管理者の場合、特定のメタデータを削除しない
        return $meta_keys;
    }
    // その他のユーザーの場合、特定のメタデータを削除
    $meta_keys[] = 'order_responsible';
    return $meta_keys;
}

このサンプルコードでは、管理者ユーザーの場合には特定のメタデータを削除せず、他のユーザーの場合には「order_responsible」メタデータを削除します。

この関数のアクションでの使用可能性

アクション名	使用可能性
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init
register_sidebar
wp_loaded
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head

概要

構文