WooCommerce自定义付款提醒邮件移插件后模板找不到问题

排查方向 #

• 路径获取逻辑错误：插件中误用了主题相关的路径函数（如get_stylesheet_directory()），未切换为插件专属的路径函数（如plugin_dir_path()），导致指向了主题目录而非插件目录。
• 邮件类模板路径定义错误：迁移后未更新邮件类中get_content_html()方法里的模板路径参数，仍沿用子主题下的相对路径。
• WooCommerce模板加载优先级未适配：未通过过滤器注册插件模板路径，WooCommerce仍优先查找主题目录，忽略插件内的模板文件。
• 文件结构不匹配：插件内模板的存放目录、文件名与代码中指定的路径不一致。
• 文件权限问题：插件模板文件/目录权限不足，导致服务器无法读取文件。

解决方法 #

1. 修正路径获取函数
   在邮件类中使用插件根目录的绝对路径，避免相对路径或主题路径。例如，若邮件类文件位于插件的includes/子目录中，获取插件根目录路径的代码应为：

   $plugin_root = plugin_dir_path( dirname( __FILE__ ) );
   $template_path = $plugin_root . 'templates/emails/payment-reminder.php';
   

2. 更新邮件类的模板加载代码
   修改get_content_html()方法，明确指定插件的模板目录：

   public function get_content_html() {
       ob_start();
       wc_get_template(
           'emails/payment-reminder.php',
           array(
               'order'         => $this->object,
               'email_heading' => $this->get_heading(),
               'sent_to_admin' => false,
               'plain_text'    => false,
               'email'         => $this,
           ),
           '',
           plugin_dir_path( dirname( __FILE__ ) ) . 'templates/' // 插件模板目录的绝对路径
       );
       return ob_get_clean();
   }
   

3. 注册插件模板路径到WooCommerce加载链
   添加过滤器让WooCommerce优先查找插件内的模板：

   add_filter( 'woocommerce_locate_template', 'custom_payment_reminder_locate_template', 10, 3 );
   function custom_payment_reminder_locate_template( $template, $template_name, $template_path ) {
       // 替换为你的插件模板目录
       $plugin_template = plugin_dir_path( __FILE__ ) . 'woocommerce/' . $template_name;
       if ( file_exists( $plugin_template ) ) {
           return $plugin_template;
       }
       return $template;
   }
   

4. 验证文件结构一致性
   确保插件内的模板文件路径与代码中指定的完全匹配，例如：

   your-plugin/
   ├── includes/
   │   └── class-wc-payment-reminder-email.php
   └── templates/
       └── emails/
           └── payment-reminder.php
   

5. 检查文件权限
   将插件目录权限设置为755，模板文件权限设置为644，确保服务器拥有读取权限。

6. 禁用缓存测试
   暂时关闭WooCommerce模板缓存、服务器OPcache或缓存插件，排查是否因缓存导致路径未更新。

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