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

概要

woocommerce_downloadable_file_permission_dataフィルタは、WooCommerceのダウンロード可能な商品に関連するファイルの権限データをカスタマイズするための機能です。このフィルタを使用することで、特定のユーザーや条件に応じたダウンロードファイルのアクセス制御を強化できます。以下に、具体的な使用例を示します。

主な機能実装の使用例:
1. 特定のユーザーグループにのみダウンロードを許可する。
2. 購入後のダウンロードリンクの有効期限をカスタマイズする。
3. ダウンロード回数の制限を柔軟に設定する。
4. 特定の条件を満たす場合にのみ追加ファイルを提供する。
5. ユーザー情報に基づいたファイルアクセス制御。
6. APIを通じて、ファイルのダウンロードアクセスを条件付きで提供する。

このフィルタは、WooCommerceのバージョン4.0以降で利用可能で、WordPressのバージョン5.0以降でも動作します。

構文

add_filter( 'woocommerce_downloadable_file_permission_data', 'your_function_name', 10, 4 );

パラメータ

• $data: 権限データ（配列）
• $file: 対象ファイルの情報（配列）
• $order: 注文情報（WC_Orderオブジェクト）
• $user: ユーザー情報（WP_Userオブジェクト）

戻り値

このフィルタは、変更された権限データの配列を返します。

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

アクション	使用例
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

サンプルコード

サンプルコード 1

add_filter( 'woocommerce_downloadable_file_permission_data', 'custom_download_permission', 10, 4 );

function custom_download_permission( $data, $file, $order, $user ) {
    // 特定のユーザーにだけダウンロードを許可
    if ( in_array( 'subscriber', (array) $user->roles ) ) {
        // ダウンロード権限を追加
        $data['permissions'][] = 'allow_download';
    }
    return $data;
}

このサンプルコードは、契約ユーザー（subscriber）に対して特定のダウンロードファイルの権限を付与します。

引用元: https://woocommerce.com/

サンプルコード 2

add_filter( 'woocommerce_downloadable_file_permission_data', 'limit_downloads', 10, 4 );

function limit_downloads( $data, $file, $order, $user ) {
    // ダウンロード回数の上限を設定
    $data['download_limit'] = 3; // 最大3回ダウンロード可能
    return $data;
}

このサンプルコードは、ダウンロードファイルの回数を最大3回に制限します。

引用元: https://woocommerce.com/

サンプルコード 3

add_filter( 'woocommerce_downloadable_file_permission_data', 'set_download_expiration', 10, 4 );

function set_download_expiration( $data, $file, $order, $user ) {
    // ダウンロード期限を7日後に設定
    $data['download_expiry'] = strtotime('+7 days');
    return $data;
}

このコードは、ダウンロード期限を購入から7日間に設定します。

引用元: https://woocommerce.com/

サンプルコード 4

add_filter( 'woocommerce_downloadable_file_permission_data', 'conditional_additional_file', 10, 4 );

function conditional_additional_file( $data, $file, $order, $user ) {
    // 全ての条件が満たされた場合に追加ファイルを提供
    if ( $order->get_total() > 100 && has_role( 'premium_member', $user ) ) {
        $data['additional_files'][] = 'premium_file.zip';
    }
    return $data;
}

このコードは、高額の注文を行ったプレミアムメンバー向けに追加のダウンロードファイルを提供します。

引用元: https://woocommerce.com/

サンプルコード 5

add_filter( 'woocommerce_downloadable_file_permission_data', 'api_based_access_control', 10, 4 );

function api_based_access_control( $data, $file, $order, $user ) {
    // 特定のAPI条件によってダウンロード許可
    if ( isset( $_GET['api_key'] ) && $_GET['api_key'] === 'YOUR_API_KEY' ) {
        $data['permissions'][] = 'allow_download';
    }
    return $data;
}

このサンプルコードは、特定のAPIキーによってダウンロード権限を管理します。

引用元: https://woocommerce.com/