kreativabyran/kb-mailer

此包的最新版本(v2.1.2)没有可用的许可信息。

为WordPress提供了一种简单的方法来构建和发送模板化电子邮件

v2.1.2 2024-03-19 14:21 UTC

README

安装

Composer

composer require kreativabyran/kb-mailer

插件

从最新版本下载zip文件,作为插件安装。

用法

注册电子邮件

首先您需要注册一个电子邮件,稍后您可以发送该电子邮件。这可以通过kbm_register_email()完成,它应该在init钩子上。

示例

add_action(
   'init',
   function() {
       if ( function_exists( 'kbm_register_email' ) ) {
           kbm_register_email(
               'contact',
               'Contact request',
               array(
                   'name'    => 'Name of person requesting contact',
                   'message' => 'Message from person', 
               )
           );
       }
   }
);

注意,当作为插件使用时,需要使用function_exists()检查,但不是从Composer安装时。

编辑电子邮件

转到wp-admin > KB Mailer查看所有注册电子邮件的列表,在那里您可以编辑电子邮件的每个部分,并在模板中使用注册的内容变量。

发送电子邮件

使用kbm_send_email()发送注册的电子邮件

$to      = 'contact@example.com';
$name    = 'Oskar Modig';
$message = 'Hi! I would really like to get in touch with you.';
if ( function_exists( 'kbm_send_email' ) ) {
    kbm_send_email(
        'contact',
        $to,
        array(
            'name'    => $name,
            'message' => $message,
        )
    );
} else {
    // Failsafe if plugin is unavailable.
    wp_mail( $to, 'Contact request', "<h1>Contact request from $name</h1><p>$message</p>", array( 'Content-Type: text/html; charset=UTF-8' ) );
}

当kb-mailer从Composer安装时,不需要使用安全措施。

配置

权限

KB Mailer默认显示电子邮件构建器界面,供具有manage_options权限的用户在wp-admin中查看。所需的权限可以通过kb_mailer_admin_page_capability过滤器进行更改。

变量分隔符

默认变量分隔符是%。这意味着在电子邮件内容中输入的%name%将被替换为该变量的值。变量ID之前和/或之后的百分号可以替换为以下过滤器:

  • kb_mailer_content_variable_before
  • kb_mailer_content_variable_after