プラグインWooCommerceのwc_add_to_cart_messageフィルタの使用方法・解説

概要

wc_add_to_cart_messageフィルタは、WooCommerceでの「カートに追加」操作後に表示されるメッセージをカスタマイズするために使用されます。このフィルタは、ユーザーが商品をカートに追加した際に表示されるメッセージ内容を変更するために便利です。一般的によく使われる機能は以下の通りです。

カートに追加した商品のカスタムメッセージを表示する。
メッセージに特定のスタイルを追加する。
ユーザーの購入の促進を目的としたメッセージを表示する。
Mリマインダーや特別オファーをメッセージに組み込む。
複数商品の追加時に、合計商品のカウントを表示する。
メッセージが表示されるタイミングを制御する。

構文

add_filter('wc_add_to_cart_message', 'custom_add_to_cart_message', 10, 2);

パラメータ

$message: 既定のメッセージ（文字列）。
$product_id: 追加された商品のID（整数）。

戻り値

カスタマイズされたメッセージ（文字列）。

WooCommerceのバージョン

このフィルタはWooCommerce 2.1以降で使用可能です。

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

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_filter('wc_add_to_cart_message', 'custom_add_to_cart_message', 10, 2);
function custom_add_to_cart_message($message, $product_id) {
    return '商品がカートに追加されました！';
}

このサンプルは、カートに商品が追加された際に、固定のメッセージを表示します。

サンプルコード2: 商品名を含める

add_filter('wc_add_to_cart_message', 'custom_add_to_cart_message_with_product', 10, 2);
function custom_add_to_cart_message_with_product($message, $product_id) {
    $product = wc_get_product($product_id);
    return $product->get_name() . 'がカートに追加されました！';
}

このコードは、追加された商品の名前をメッセージに含めます。

サンプルコード3: スタイルの追加

add_filter('wc_add_to_cart_message', 'styled_add_to_cart_message', 10, 2);
function styled_add_to_cart_message($message, $product_id) {
    return '<strong style="color: green;">' . $message . '</strong>';
}

こちらは、メッセージにスタイルを追加して、カートに商品が追加された際に強調表示します。

サンプルコード4: 複数商品のカウント

add_filter('wc_add_to_cart_message', 'count_products_in_cart_message', 10, 2);
function count_products_in_cart_message($message, $product_id) {
    $count = WC()->cart->get_cart_contents_count();
    return $message . ' (現在のカートの商品数: ' . $count . ')';
}

このコードは、カート内の商品の数をメッセージに追加します。

サンプルコード5: 特別オファーの追加

add_filter('wc_add_to_cart_message', 'offer_add_to_cart_message', 10, 2);
function offer_add_to_cart_message($message, $product_id) {
    return $message . ' - 今なら特別割引が適用されます！';
}

このサンプルは、購入を促進するために特別オファーをメッセージに追加します。

概要

構文