プラグインWooCommerceのwoocommerce_product_file関数の使用方法・解説

概要

woocommerce_product_file 関数は、WooCommerceプラグインにおいて、デジタル商品のファイル情報を取得する際によく使用される関数です。この関数は商品のファイル名やファイルのURLを取得するために使われ、主に以下のような機能実装に利用されます。

デジタル商品のダウンロードリンクを表示
購入後のダウンロード可能なファイルリスト生成
商品の詳細ページでのファイル情報表示
ユーザーの購入履歴からのダウンロードリンク提供
PDFやその他のファイルを注文確認メールに添付
特定のファイルを特定の条件下で表示または非表示にする

構文

woocommerce_product_file( $product_id );

パラメータ

$product_id (int): WooCommerce商品のID。

戻り値

(array): 商品のファイル情報を含む配列。

バージョン情報

WooCommerce バージョン: 4.0以上
WordPress バージョン: 5.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: デジタル商品のダウンロードリンクを表示

このコードは特定の商品IDに関連するデジタル商品のダウンロードリンクを表示します。

$product_id = 123; // ここに商品IDを設定
if ( function_exists( 'woocommerce_product_file' ) ) {
    $files = woocommerce_product_file( $product_id );
    foreach ( $files as $file ) {
        echo '<a href="' . esc_url( $file['file'] ) . '">' . esc_html( $file['name'] ) . '</a><br>';
    }
}
// 出典: https://docs.woocommerce.com/document/woocommerce-rest-api/

サンプル2: 商品の詳細ページにファイル情報を追加

このコードは商品の詳細ページにファイル情報を表示するカスタマイズされたフックを設定します。

add_action( 'woocommerce_single_product_summary', 'display_product_files', 20 );

function display_product_files() {
    global $product;
    if ( $product->is_downloadable() ) {
        $files = $product->get_downloads();
        foreach ( $files as $file ) {
            echo '<a href="' . esc_url( $file['file'] ) . '">' . esc_html( $file['name'] ) . '</a><br>';
        }
    }
}
// 出典: https://woocommerce.com/document/woocommerce-shortcodes/

サンプル3: 購入履歴からのファイル取得

このコードはユーザーの購入履歴からダウンロード可能なファイルを取得し表示します。

add_action( 'woocommerce_order_details_after_order_table', 'display_order_downloads', 10, 1 );

function display_order_downloads( $order ) {
    $downloads = $order->get_downloads();
    foreach ( $downloads as $download ) {
        echo '<a href="' . esc_url( $download['file'] ) . '">' . esc_html( $download['name'] ) . '</a><br>';
    }
}
// 出典: https://woocommerce.com/document/customer-order-history/

サンプル4: 購入したアイテムのファイルを確認する機能の実装

このコードは、ユーザーが購入したアイテムのファイル情報を確認できるページを作成するものです。

add_shortcode( 'my_downloads', 'my_downloads_page' );

function my_downloads_page() {
    $user_id = get_current_user_id();
    $customer_orders = wc_get_orders( array( 'customer' => $user_id ) );

    foreach ( $customer_orders as $order ) {
        $items = $order->get_items();
        foreach ( $items as $item ) {
            $downloads = $item->get_item_meta( '_downloadable_files', true );
            foreach ( $downloads as $download ) {
                echo '<a href="' . esc_url( $download['file'] ) . '">' . esc_html( $download['name'] ) . '</a><br>';
            }
        }
    }
}
// 出典: https://woocommerce.com/document/woocommerce-shortcodes/

サンプル5: 特定の条件下でファイルを表示

このコードは特定のユーザー役割に対してのみファイルを表示します。

add_action( 'woocommerce_after_shop_loop_item', 'conditional_download_file_link', 10 );

function conditional_download_file_link() {
    if ( current_user_can( 'subscriber' ) ) {
        $product_id = get_the_ID();
        $files = woocommerce_product_file( $product_id );
        foreach ( $files as $file ) {
            echo '<a href="' . esc_url( $file['file'] ) . '">' . esc_html( $file['name'] ) . '</a><br>';
        }
    }
}
// 出典: https://woocommerce.com/document/woocommerce-action-hooks/

概要

構文