如何在自定义模板中调用WCBoost Products Compare的Plugin实例？

核心逻辑梳理 #

Plugin::instance()是插件的单例实例，list是该实例下负责对比列表管理的核心对象（用来处理商品添加、移除、存储、读取等操作）。要正常调用，必须先保证你已经完整迁移了关联的依赖代码。

具体操作步骤 #

1. 补全依赖代码迁移
   找到插件原代码里的Plugin类实现，确认list是类的直接属性还是通过魔术方法获取的对象。通常插件结构类似：

   class Plugin {
       protected static $_instance = null;
       public $list;
   
       public static function instance() {
           if ( is_null( self::$_instance ) ) {
               self::$_instance = new self();
           }
           return self::$_instance;
       }
   
       public function __construct() {
           $this->list = new WCBoost_Compare_List(); // 这里是对比列表类
           // 其他初始化逻辑（比如会话绑定、钩子注册）
       }
   }
   

   你需要把WCBoost_Compare_List类（以及它依赖的所有工具函数、会话处理代码）一并迁移到你的自定义项目中。

2. 确保初始化时机正确
   WooCommerce相关功能必须在WooCommerce加载完成后初始化，把你的代码挂到woocommerce_init钩子上：

   add_action( 'woocommerce_init', function() {
       if ( class_exists( 'Plugin' ) ) {
           $compare = Plugin::instance();
           // 此时可正常调用$compare->list的方法
       }
   } );
   

3. 调用list的常用功能
   根据插件原有逻辑，list对象通常包含这些实用方法：

   • 添加商品到对比：$compare->list->add( $product_id );
   • 移除对比商品：$compare->list->remove( $product_id );
   • 获取所有对比商品对象：$products = $compare->list->get_products();
   • 清空对比列表：$compare->list->clear();

4. 在自定义模板中渲染对比内容
   在你的模板文件里，直接调用实例和方法来输出UI：

   <?php
   $compare = Plugin::instance();
   $compare_products = $compare->list->get_products();
   
   if ( ! empty( $compare_products ) ) {
       echo '<div class="compare-wrap">';
       foreach ( $compare_products as $product ) {
           echo '<div class="compare-item">';
           echo $product->get_image();
           echo '<h4>' . esc_html( $product->get_name() ) . '</h4>';
           echo '<div class="price">' . $product->get_price_html() . '</div>';
           // 按需添加其他商品属性（比如库存、评分）
           echo '</div>';
       }
       echo '</div>';
   } else {
       echo '<p>暂无对比商品</p>';
   }
   ?>
   

关键注意点 #

• 必须迁移会话处理代码：对比列表通常存在用户会话（WC_Session）中，缺失这部分会导致列表数据无法持久化。
• 测试钩子兼容性：确保原插件绑定的WooCommerce钩子（比如添加对比按钮的钩子）你已经同步迁移并注册。

内容的提问来源于stack exchange，提问作者jacsoon jacsoon