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

概要

woocommerce_add_message アクションは、WooCommerce が提供するフックで、カスタムメッセージを追加する際に使用されます。このアクションを使用することで、注文処理やカート操作などに関するカスタムフィードバックをユーザーに返すことができます。よく使われる機能として、次のような場面が考えられます。

購入完了後のサンキューメッセージのカスタマイズ
特定のプロモーションコードが適用された際のメッセージ表示
ユーザーのアカウント更新確認メッセージ
商品がカートに追加された際の通知メッセージ
注文キャンセル時の情報メッセージ
定期購買の更新やリマインダーメッセージ

構文

do_action('woocommerce_add_message', $message);

パラメータ

$message (string): 追加したいメッセージの内容

戻り値

特になし。このアクションは、特定の出力を行わず、メッセージを追加するために使用されます。

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

WooCommerce での利用は 3.0 以降

ワードプレスのバージョン

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_action('woocommerce_thankyou', 'custom_thankyou_message');
function custom_thankyou_message($order_id) {
    $order = wc_get_order($order_id);
    if ($order) {
        $message = 'ご注文ありがとうございました！発送手続きが始まります。';
        do_action('woocommerce_add_message', $message);
    }
}

このコードは、購入完了ページにカスタムメッセージを表示します。woocommerce_thankyouフックを用いて、注文IDに基づきメッセージを生成しています。引用元: https://developer.woocommerce.com/

サンプルコード2: カートに商品追加時の通知

add_action('woocommerce_add_to_cart', 'custom_add_to_cart_message', 10, 6);
function custom_add_to_cart_message($cart_item_key, $product_id, $quantity, $variation_id, $variation, $cart_item_data) {
    $message = '商品がカートに追加されました！';
    do_action('woocommerce_add_message', $message);
}

このコードは、商品がカートに追加された際に通知メッセージを表示します。woocommerce_add_to_cartフックを使用しています。引用元: https://developer.woocommerce.com/

サンプルコード3: プロモーションコード適用時のメッセージ

add_action('woocommerce_coupon_applied', 'custom_coupon_applied_message');
function custom_coupon_applied_message($coupon_code) {
    $message = "クーポン「$coupon_code」が適用されました！";
    do_action('woocommerce_add_message', $message);
}

このコードは、ユーザーがクーポンを適用したときのカスタムメッセージを表示します。woocommerce_coupon_appliedフックを使用しています。引用元: https://developer.woocommerce.com/

サンプルコード4: 注文キャンセル後のメッセージ

add_action('woocommerce_order_status_cancelled', 'custom_order_cancelled_message');
function custom_order_cancelled_message($order_id) {
    $message = 'ご注文がキャンセルされました。';
    do_action('woocommerce_add_message', $message);
}

このコードは、注文がキャンセルされるとユーザーにメッセージを表示します。woocommerce_order_status_cancelledフックを使用しています。引用元: https://developer.woocommerce.com/

サンプルコード5: アカウント情報更新時のメッセージ

add_action('woocommerce_account_update', 'custom_account_update_message');
function custom_account_update_message() {
    $message = 'アカウント情報が更新されました。';
    do_action('woocommerce_add_message', $message);
}

このコードは、ユーザーがアカウント情報を更新した際にメッセージを表示します。woocommerce_account_updateフックを使用しています。引用元: https://developer.woocommerce.com/

概要

構文