概要
woocommerce_review_order_before_order_total は、WooCommerceのチェックアウトページにおいて、注文合計が表示される前にカスタムコンテンツを追加するためのフックです。このアクションは、特に使いやすく、主に以下のような機能を実装する際によく利用されます。
- 追加料金や割引の表示
- カスタムフィールドの表示
- プロモーションメッセージやバナーの表示
- 特別な購入条件に関する情報の提供
- サポートやFAQへのリンクの追加
- ユーザーへの確認メッセージの表示
構文
add_action('woocommerce_review_order_before_order_total', 'your_custom_function');
パラメータ
このアクションにはパラメータはありませんが、カスタム関数内でグローバル変数を利用することが可能です。
戻り値
このアクションは値を返さず、ただ機能を追加するために使われます。
使用可能なプラグインWooCommerceのバージョン
WooCommerceバージョン2.1以降。
ワードプレスのバージョン
WordPressバージョン4.0以降。
サンプルコード
サンプルコード1: 追加料金の表示
このコードは、注文合計の前に追加料金を表示します。
add_action('woocommerce_review_order_before_order_total', 'display_additional_fee');
function display_additional_fee() {
echo '<tr class="additional-fee">
<th>' . __('Additional Fee', 'woocommerce') . '</th>
<td>¥500</td>
</tr>';
}
引用元: https://woocommerce.com
サンプルコード2: カスタムメッセージの追加
このコードは、カスタムメッセージを注文合計の前に表示します。
add_action('woocommerce_review_order_before_order_total', 'custom_checkout_message');
function custom_checkout_message() {
echo '<div class="checkout-message">' . __('Thank you for your purchase!', 'woocommerce') . '</div>';
}
引用元: https://woocommerce.com
サンプルコード3: プロモーションバナーの表示
このコードは、プロモーションバナーを表示します。
add_action('woocommerce_review_order_before_order_total', 'display_promotion_banner');
function display_promotion_banner() {
echo '<div class="promotion-banner">' . __('Get 20% off on your next order!', 'woocommerce') . '</div>';
}
引用元: https://woocommerce.com
サンプルコード4: FAQリンクの追加
このコードは、FAQリンクを表示します。
add_action('woocommerce_review_order_before_order_total', 'add_faq_link');
function add_faq_link() {
echo '<p>' . __('Have questions? Visit our ', 'woocommerce') . '<a href="/faq">' . __('FAQ', 'woocommerce') . '</a></p>';
}
引用元: https://woocommerce.com
サンプルコード5: 確認メッセージの表示
このコードは、ユーザーに確認メッセージを表示します。
add_action('woocommerce_review_order_before_order_total', 'confirmation_message');
function confirmation_message() {
echo '<div class="confirmation-message">' . __('Please review your order before proceeding!', 'woocommerce') . '</div>';
}
引用元: https://woocommerce.com
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| 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 |
この表は、woocommerce_review_order_before_order_total アクションが他のフックで使用可能かどうかを示しています。使用例がある場合は〇を記入され、ない場合は何も記入されていません。