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

概要

woocommerce_customer_get_downloadable_productsフィルタは、WooCommerceにおいて顧客がダウンロード可能な製品を取得する際に使用されるフックです。このフィルタは、特定の顧客に関連付けられたダウンロード可能な商品をカスタマイズするために使用されます。具体的な用途としては以下のようなケースがあります。

ステータスに応じたダウンロード可能商品フィルタリング
購入した商品のカスタムメタデータの追加
ダウンロード可能商品の表示内容の変更
使用制限に基づいたダウンロードの制御
バンドル商品のダウンロードリンクの修正
顧客の地域に基づいたダウンロード製品のフィルタリング

構文

add_filter( 'woocommerce_customer_get_downloadable_products', 'custom_function_name', 10, 3 );

パラメータ

$downloads: ダウンロード可能な製品の配列（初期値としてWooCommerceが用意するデータ）
$customer_id: 現在の顧客のID
$order: 顧客の注文情報（オプション）

戻り値

フィルタ後のダウンロード可能な製品の配列

使用可能なWooCommerceのバージョン

WooCommerce 2.0以上

使用可能なWordPressのバージョン

WordPress 4.0以上

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

アクション	使用可能性
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_customer_get_downloadable_products', 'filter_downloadable_products_by_stock', 10, 3 );

function filter_downloadable_products_by_stock( $downloads, $customer_id, $order ) {
    foreach ($downloads as $key => $download) {
        // 在庫がない商品は除外
        if ( ! $download['product']->is_in_stock() ) {
            unset($downloads[$key]);
        }
    }
    return $downloads;
}

サンプル2: ダウンロードリンクにカスタムメタデータを追加

このサンプルは、ダウンロード可能な商品のリンクにカスタムメタデータを追加しています。

add_filter( 'woocommerce_customer_get_downloadable_products', 'add_custom_meta_to_download_links', 10, 3 );

function add_custom_meta_to_download_links( $downloads, $customer_id, $order ) {
    foreach ($downloads as &$download) {
        // 商品にカスタムフィールドを追加
        $download['custom_meta'] = get_post_meta( $download['product_id'], '_custom_meta_key', true );
    }
    return $downloads;
}

サンプル3: 地域に基づくフィルタリング

このコードは、顧客が居住する地域に基づいてダウンロード商品をフィルタリングします。

add_filter( 'woocommerce_customer_get_downloadable_products', 'filter_downloads_by_customer_region', 10, 3 );

function filter_downloads_by_customer_region( $downloads, $customer_id, $order ) {
    $customer = new WC_Customer( $customer_id );
    $region = $customer->get_billing_state();

    foreach ($downloads as $key => $download) {
        // 特定の地域の商品を除外
        if ( $region === 'CA' && $download['product']->get_id() == 123 ) {
            unset($downloads[$key]);
        }
    }
    return $downloads;
}

サンプル4: ダウンロード可能商品リストの内容を変更

このコードは、ダウンロード可能商品のリストに特定のメッセージを追加します。

add_filter( 'woocommerce_customer_get_downloadable_products', 'modify_downloadable_products_list', 10, 3 );

function modify_downloadable_products_list( $downloads, $customer_id, $order ) {
    foreach ($downloads as &$download) {
        // リストにカスタムメッセージを追加
        $download['message'] = 'この商品はダウンロード可能です。';
    }
    return $downloads;
}

サンプル5: 限定商品のダウンロード制御

このコードは、特定の条件を満たす場合にのみダウンロードを許可します。

add_filter( 'woocommerce_customer_get_downloadable_products', 'restrict_downloads_based_on_conditions', 10, 3 );

function restrict_downloads_based_on_conditions( $downloads, $customer_id, $order ) {
    // 例: 購入が5回以上の場合のみダウンロードを許可
    $purchase_count = get_user_meta( $customer_id, 'purchase_count', true );

    if ( $purchase_count < 5 ) {
        foreach ($downloads as $key => $download) {
            unset($downloads[$key]);
        }
    }
    return $downloads;
}

これらのサンプルコードを使って、woocommerce_customer_get_downloadable_productsフィルタを利用したさまざまなカスタマイズを行うことができます。

概要

構文