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

概要

woocommerce_check_cart_itemsは、WooCommerceにおいてカート内のアイテムをチェックする際に使用されるアクションフックです。このフックは、カートが更新または表示されるたびに呼び出され、次のような機能を実装する際によく使われます。

1. カート内アイテムの在庫状況を確認
2. 価格変更時の警告表示
3. 特定のアイテムに対する条件を満たさない場合のエラーメッセージ表示
4. 割引クーポンの適用条件検査
5. ユーザーのカート内容に基づくリダイレクト処理
6. 定期購入商品のチェック

構文

add_action('woocommerce_check_cart_items', 'your_function_name');

パラメータ

このアクションはパラメータを持ちません。

戻り値

このアクションには戻り値はありません。

使用可能なバージョン

• WooCommerce: 2.0.0以降
• WordPress: 4.0.0以降

サンプルコード

サンプルコード1: 在庫確認のためのエラーチェック

このコードは、カート内のアイテムが品切れの場合にエラーメッセージを表示します。

add_action('woocommerce_check_cart_items', 'check_cart_items_stock');

function check_cart_items_stock() {
    foreach (WC()->cart->get_cart() as $cart_item_key => $cart_item) {
        $product = $cart_item['data'];
        if (!$product->is_in_stock()) {
            wc_add_notice(__('One or more items in your cart are out of stock.'), 'error');
        }
    }
}

URL: https://woocommerce.com/

サンプルコード2: 購入制限ルールの実装

このコードは、特定の商品の個数が制限を超えた場合にエラーメッセージを表示します。

add_action('woocommerce_check_cart_items', 'limit_cart_quantity');

function limit_cart_quantity() {
    $maximum_quantity = 5; // 最大5個まで
    foreach (WC()->cart->get_cart() as $cart_item_key => $cart_item) {
        if ($cart_item['quantity'] > $maximum_quantity) {
            wc_add_notice(__('You can only purchase a maximum of five units of this item.'), 'error');
        }
    }
}

URL: https://woocommerce.com/

サンプルコード3: 割引の適用条件確認

このコードは、特定の条件を満たさない場合に割引が適用されない旨のメッセージを表示します。

add_action('woocommerce_check_cart_items', 'check_discount_conditions');

function check_discount_conditions() {
    $minimum_amount = 50; // 割引適用の最小額
    $cart_total = WC()->cart->get_cart_total();

    if ($cart_total < $minimum_amount) {
        wc_add_notice(__('You need to have at least $50 in your cart to apply a discount.'), 'error');
    }
}

URL: https://woocommerce.com/

サンプルコード4: カート内容に基づくリダイレクト

このコードは、特定のアイテムがカートに含まれている場合、ユーザーを別のページにリダイレクトします。

add_action('woocommerce_check_cart_items', 'redirect_based_on_cart_content');

function redirect_based_on_cart_content() {
    foreach (WC()->cart->get_cart() as $cart_item_key => $cart_item) {
        if ($cart_item['product_id'] == 123) { // 特定のIDを持つ商品
            wp_redirect(home_url('/special-offer'));
            exit;
        }
    }
}

URL: https://woocommerce.com/

サンプルコード5: ユーザーへのカートアイテムの確認メッセージ

このコードは、カートに特定の商品が追加された場合に確認メッセージを表示します。

add_action('woocommerce_check_cart_items', 'confirm_cart_item');

function confirm_cart_item() {
    foreach (WC()->cart->get_cart() as $cart_item_key => $cart_item) {
        if ($cart_item['product_id'] == 456) { // 特定のIDを持つ商品
            wc_add_notice(__('You have a special item in your cart!'), 'notice');
        }
    }
}

URL: 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