プラグインWooCommerceのwoocommerce_receipt_$ORDER->GET_PAYMENT_METHODフィルタの使用方法・解説

概要

woocommerce_receipt_$ORDER->GET_PAYMENT_METHOD フィルタは、WooCommerceの決済に関するカスタマイズを行う際に使用される非常に便利なフックです。このフィルタは主に次のような機能を実装する際によく用いられます。

支払い方法のラベルの変更
特定の条件に基づいた追加情報の表示
顧客へのメッセージや手続きガイドを追加
特定の支払い方法に対するカスタムスタイルの適用
購入完了画面のカスタマイズ
外部APIとの連携結果をフィードバックする

このフィルタの構文は次のようになります。

add_filter('woocommerce_receipt_{$order->get_payment_method()}', 'your_custom_function', 10, 2);

構文

woocommerce_receipt_$ORDER->GET_PAYMENT_METHOD: フィルタ名。
your_custom_function: コールバック関数名。
10: 優先度。
2: 受け取る引数の数。

パラメータ

$posted_data: フィルタ対象データ。
$order: WooCommerceの注文オブジェクト。

戻り値

カスタマイズされた支払い方法の名前またはHTML。

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

WooCommerce: 3.0以降
WordPress: 4.0以降

サンプルコード

サンプルコード1

add_filter('woocommerce_receipt_paypal', 'custom_paypal_receipt_message', 10, 2);
function custom_paypal_receipt_message($message, $order) {
    return $message . '<p>PayPalでのお支払いありがとうございます！</p>';
}

説明: PayPalでの決済時に、領収書に感謝のメッセージを追加します。

サンプルコード2

add_filter('woocommerce_receipt_coding', 'add_custom_info_to_receipt', 10, 2);
function add_custom_info_to_receipt($message, $order) {
    if($order->get_total() > 100) {
        $message .= '<p>100ドル以上のご購入で送料無料です！</p>';
    }
    return $message;
}

説明: 合計が100ドル以上の注文の領收書に送料無料の情報を追加します。

サンプルコード3

add_filter('woocommerce_receipt_cheque', 'custom_cheque_instructions', 10, 2);
function custom_cheque_instructions($message, $order) {
    return $message . '<p>小切手を郵送する際は、以下のアドレスをご利用ください:</p><p>123 Sample St, Sample City</p>';
}

説明: 小切手支払いを選択した顧客に、送付先のアドレスを案内します。

サンプルコード4

add_filter('woocommerce_receipt_creditcard', 'credit_card_message_adjustment', 10, 2);
function credit_card_message_adjustment($message, $order) {
    return '<strong>注意:</strong> クレジットカード情報はセキュリティのため処理後に破棄されます。' . $message;
}

説明: クレジットカード支払い時の領収書に、セキュリティに関する注意事項を追加します。

サンプルコード5

add_filter('woocommerce_receipt_bacs', 'bacs_payment_info', 10, 2);
function bacs_payment_info($message, $order) {
    $message .= '<p>銀行振込の場合、2営業日以内にお振込みをお願いいたします。</p>';
    return $message;
}

説明: 銀行振込時の領収書に、振込の期限に関する情報を追加します。

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

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

概要

構文