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

概要

woocommerce_checkout_cart_item_visibleフィルタは、WooCommerceのチェックアウトページでカートアイテムが表示されるかどうかを制御するためのフックです。このフィルタを使用することで、特定の条件に基づいてカートアイテムの表示を制御できます。これにより、カスタム機能を実装する際に役立ちます。

一般的に、woocommerce_checkout_cart_item_visibleフィルタは以下のような機能を実装する際によく使われます。

特定のカートアイテムを非表示にする
ユーザーのロールに基づいてアイテムの表示を制御する
プロモーションやバンドルに関連するアイテムの表示を制御する
残りの在庫がない商品を非表示にする
チェックアウト手続きを分岐させる条件として使用する
カスタムメッセージを表示するための条件を制御する

構文

add_filter('woocommerce_checkout_cart_item_visible', 'your_function_name', 10, 3);

パラメータ

$visible (bool): アイテムが表示されるかどうかのフラグ。
$cart_item (array): カートアイテムの情報。
$cart_item_key (string): カートアイテムのキー。

戻り値

bool: アイテムが表示される場合はtrue、非表示にする場合はfalseを返す。

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

WooCommerce 2.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: 特定の商品を非表示にする

このサンプルコードは、IDが123の商品をチェックアウトページで非表示にするためのものです。

add_filter('woocommerce_checkout_cart_item_visible', 'hide_specific_product_on_checkout', 10, 3);

function hide_specific_product_on_checkout($visible, $cart_item, $cart_item_key) {
    if ($cart_item['product_id'] === 123) {
        return false; // 商品IDが123のアイテムを非表示にする
    }
    return $visible;
}

サンプルコード2: 管理者以外のユーザーからアイテムを非表示にする

このコードは、管理者以外のユーザーには特定のカートアイテムを非表示にします。

add_filter('woocommerce_checkout_cart_item_visible', 'hide_item_for_non_admins', 10, 3);

function hide_item_for_non_admins($visible, $cart_item, $cart_item_key) {
    if (!current_user_can('administrator') && $cart_item['product_id'] === 456) {
        return false; // 商品IDが456のアイテムを管理者以外には非表示
    }
    return $visible;
}

サンプルコード3: 在庫なしのアイテムを非表示にする

このサンプルコードは、在庫がないアイテムをチェックアウトから非表示にします。

add_filter('woocommerce_checkout_cart_item_visible', 'hide_out_of_stock_items', 10, 3);

function hide_out_of_stock_items($visible, $cart_item, $cart_item_key) {
    if (!$cart_item['data']->is_in_stock()) {
        return false; // 在庫がない場合、非表示にする
    }
    return $visible;
}

サンプルコード4: プロモーションアイテムの表示制御

このコードでは、特定のプロモーションが適用されている場合にのみアイテムを表示します。

add_filter('woocommerce_checkout_cart_item_visible', 'show_item_for_promotion', 10, 3);

function show_item_for_promotion($visible, $cart_item, $cart_item_key) {
    if (isset($_SESSION['promotion_active']) && $_SESSION['promotion_active'] === true) {
        return true; // プロモーションがアクティブな場合、表示
    }
    return false; // それ以外は非表示
}

サンプルコード5: カスタムメッセージの表示を条件付きにする

このサンプルコードは、特定の条件を満たす場合にのみカスタムメッセージを表示します。

add_filter('woocommerce_checkout_cart_item_visible', 'conditional_custom_message', 10, 3);

function conditional_custom_message($visible, $cart_item, $cart_item_key) {
    if ($cart_item['quantity'] > 5) {
        // 大量に購入された場合、カスタムメッセージを表示（ここではメッセージ表示ロジックを追加）
        // return true; （可能なら表示するための処理）
    }
    return $visible;
}

適宜、サンプルコードの説明を変更して、詳細を追加してください。

参考文献として著作権フリーの情報を提供することは難しいため、具体的なURLは示せませんが、WordPressやWooCommerceの公式ドキュメントを参考にすることをお勧めします。

概要

構文