快速标签 Quicktags API

什么是 Quicktags API

Quicktags API 是 WordPress 的一种应用程序接口,使用它可以轻松添加自定义按钮到 WordPress 编辑器的工具栏中。这个 API 扮演了一个中心的角色,允许开发人员在 WordPress 编辑器中快速添加功能,增强编辑器的特性。

创建自定义按钮

要创建一个自定义按钮,需要首先调用 add_action() 函数,并使用 admin_init 这个钩子来注册我们的 Quicktags 按钮。具体代码如下:

add_action( 'admin_init', 'register_my_quicktags_button' );

function register_my_quicktags_button() {
   if ( wp_script_is( 'quicktags' ) ) { // 判断是否存在 quicktags 脚本
         ?>
         <script>
            QTags.addButton(
                  'my-button',//按钮名称
                  'My Button',//按钮短代码信息
                  function(){
                     //触发按钮点击事件的代码
                  }
            );
         </script>
      <?php
   }
}

这里使用了 QTags.addButton() 函数来创建自定义按钮,其中 my-button 是我们自定义的按钮名称,My Button 是按钮的提示信息。

触发按钮点击事件

上面的代码段中,在 QTags.addButton() 函数的最后一个参数中添加了用于触发点击事件的代码。这样,在用户点击我们的自定义按钮时,这段代码就会被执行。在这里,我们可以添加任何我们想要执行的代码,并且可以使用 jQuery 或 JavaScript 来实现。

如果我们想要添加一个短代码,可以使用以下代码:

QTags.addButton(
      'my-button',
      'My Button',
      function(){
         QTags.insertContent('[my-shortcode]'); //插入我们的短代码
      }
);

在这里,我们通过 QTags.insertContent() 函数将 [my-shortcode] 插入到当前编辑器的光标位置。

添加其他属性

对于按钮,还可以添加更多属性,如按钮样式、短代码模板等。以下是一个示例,展示了如何为按钮添加不同的类名和 ID:

QTags.addButton(
      'my-button',
      'My Button',
      function(){
         QTags.insertContent('[my-shortcode class="example" id="001"]'); //插入我们的短代码
      },
      null,
      'my_button', //按钮类名
      'my_button' //按钮 ID
);

这里通过传递两个额外的参数,即类名和 ID,来为按钮添加其他属性。