プラグインWooCommerceのwoocommerce_order_details_before_order_table_itemsアクションの使用方法・解説

概要

woocommerce_order_details_before_order_table_items は、WooCommerce の注文詳細表示の特定の部分でフックされるアクションです。このアクションは、指定された注文に関連するアイテムテーブルの前に追加の情報を表示する際に非常に便利です。開発者はこのアクションを利用して、以下のような機能を実装することがよくあります。

注文に関する追加情報の表示（例えば、配送方法や支払い方法の詳細）。
注文のヒストリーやトラッキング情報を表示。
クーポンや割引の詳細を表示。
特定の条件に基づいたカスタムフィールドの表示。
返金や返品のポリシーに関する情報を提供。
他の製品や関連商品へのリンクを表示。

構文

add_action('woocommerce_order_details_before_order_table_items', 'custom_function');

パラメータ

このアクションには特定のパラメータは渡されませんが、以下のグローバル変数にアクセスできます。

$order: 現在の注文オブジェクト。

戻り値

このアクションは何も戻りません。

使用可能なプラグインバージョン

WooCommerce: 3.0以降
WordPress: 4.0以降

サンプルコード

サンプルコード 1

add_action('woocommerce_order_details_before_order_table_items', 'display_custom_shipping_info');

function display_custom_shipping_info( $order ) {
    echo '<h2>配送情報</h2>';
    echo '<p>' . esc_html( $order->get_shipping_method() ) . '</p>';
}

このサンプルコードは、注文詳細ページに配送方法を表示します。

サンプルコード 2

add_action('woocommerce_order_details_before_order_table_items', 'show_order_tracking_info');

function show_order_tracking_info( $order ) {
    $tracking_number = get_post_meta( $order->get_id(), '_tracking_number', true );
    if ( $tracking_number ) {
        echo '<h2>追跡番号</h2>';
        echo '<p>' . esc_html( $tracking_number ) . '</p>';
    }
}

このサンプルコードは、注文に関連付けられた追跡番号を表示します。

サンプルコード 3

add_action('woocommerce_order_details_before_order_table_items', 'display_coupon_details');

function display_coupon_details( $order ) {
    if ( $order->get_coupon_codes() ) {
        echo '<h2>使用したクーポン</h2>';
        echo '<ul>';
        foreach ( $order->get_coupon_codes() as $code ) {
            echo '<li>' . esc_html( $code ) . '</li>';
        }
        echo '</ul>';
    }
}

このサンプルコードは、注文で使用されたクーポンの詳細をリスト表示します。

サンプルコード 4

add_action('woocommerce_order_details_before_order_table_items', 'show_return_policy_info');

function show_return_policy_info( $order ) {
    echo '<h2>返品ポリシー</h2>';
    echo '<p>商品の返品は受け付けていません。詳細はウェブサイトをご覧ください。</p>';
}

このサンプルコードは、注文詳細ページに返品ポリシーに関する情報を表示します。

サンプルコード 5

add_action('woocommerce_order_details_before_order_table_items', 'display_related_products_link');

function display_related_products_link( $order ) {
    echo '<h2>関連商品</h2>';
    echo '<p><a href="/related-products">こちらをクリック</a>して関連商品をチェックしてください。</p>';
}

このサンプルコードは、関連商品へのリンクを注文詳細ページに表示します。

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

アクション	使用可能性
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

概要

構文