站长视角
用户至上

深入了解WordPress文本编辑器

深入了解 WordPress文本编辑器

当我们在WordPress中创建或编辑文章时,如果把古腾堡编辑器禁用,我们有两个内容编辑器可供选择:TinyMCE可视化编辑器和WordPress文本编辑器。后者由一个由按钮增强的文本区域元素组成,提供了一种将HTML代码注入文章内容的快速方法。

用户可以通过单击右上角的标签轻松地从视觉模式切换到文本模式。WordPress将保留文章内容,但TinyMCE会将特殊字符转换为相应的HTML实体。出于这个原因,您可能更喜欢

推荐阅读:深入了解WordPress新的古腾堡编辑器(优点和缺点)

在文本编辑器正好说明了文章内容的HTML结构,它赋予了用户输入的完全控制权,所以这个文章是关于WordPress的文本编辑器。首先,我们将从开发人员的角度深入探讨该主题:我们将查看Quicktags JS APIquicktags_settings过滤器和wp_editor()函数。

这篇文章的最后一部分专门针对非开发人员。我将向您展示一个插件,允许用户从WordPress管理面板快速配置文本编辑器。

比较可视化和文本编辑器 比较可视化和文本编辑器。

  • WordPress文本编辑器
  • 覆盖Quicktags设置
  • WordPress编辑器包含在首页
  • 使用AddQuicktag插件增强WordPress文本编辑器

WordPress文本编辑器

如果您习惯于在文章中添加大量代码,或者您想预览内容的确切HTML结构,您可能更喜欢准系统文本编辑器,而不是高级可视化编辑器的易用性。

然而,文本编辑器不仅仅是一个表单元素。编辑器工具栏提供了一组按钮(称为快速标签),允许用户快速将大量标签注入 HTML 帖子结构。

默认情况下,WordPress提供以下快速标签:

  • a
  • strong
  • code
  • del
  • em
  • ol
  • ul
  • li
  • img
  • blockquote
  • ins
  • fullscreen
  • lookup
  • close

图像显示了WordPress文本编辑器的默认按钮

图像显示了WordPress文本编辑器的默认按钮

由于Quicktags API,可以覆盖默认设置。JavaScript API提供了一种简单的方法来添加自定义按钮并将代码和内容注入编辑器文本区域。该QTags.addButton方法增加一个按钮,工具栏和定义如下:

QTags.addButton( 
id, 
display, 
arg1, 
arg2, 
access_key, 
title, 
priority, 
instance );

此方法保留以下参数:

  • id ( string ) (required) 是按钮的HTML id;
  • display ( string ) (required) 是HTML值;
  • arg1 ( string ) (必需) 是要包含的开始标记或单击按钮时要运行的自定义回调函数
  • arg2 ( string ) (可选) 是结束标签;
  • access_key ( string ) (可选) 是按钮的快捷键;
  • title ( string ) (可选) 是HTML标题;
  • 优先级int)(可选)是一个数字,表示按钮在工具栏中的位置;
  • 实例字符串)(可选)将按钮限制为特定的Quicktags实例。

现在让我们假设我们想要添加像Prism这样的语法高亮器所需的标签,并且我们想要为编辑器工具栏提供打印以下标记的按钮:

<pre><code class="language-php"></code></pre>
<pre><code class="language-css"></code></pre>
<pre><code class="language-html"></code></pre>

要完成此任务,我们需要将以下代码添加到插件的主文件中:

function my_quicktags() {
if ( wp_script_is( 'quicktags' ) ) {
?>
<script type="text/javascript">
QTags.addButton( 'eg_php', 'PHP', '<pre><code class=/"language-php/">', '</code></pre>', 'p', 'PHP Code', 100 );
QTags.addButton( 'eg_css', 'CSS', '<pre><code class=/"language-css/">', '</code></pre>', 'q', 'CSS Code', 100 );
QTags.addButton( 'eg_html', 'HTML', '<pre><code class=/"language-html/">', '</code></pre>', 'r', 'HTML Code', 100 );
</script>
<?php
}
}
add_action( 'admin_print_footer_scripts', 'my_quicktags' );

admin_print_footer_scripts是一个动作钩子,用于在管理页面的页脚中打印脚本。回调函数检查quicktags脚本是否在使用中,然后打印JS代码。此脚本向管理面板中的Quicktags的任何实例添加了另外三个按钮,如下图所示。

图像显示了我们新的自定义按钮

图像显示了我们新的自定义按钮

向编辑器工具栏添加按钮相对简单,但我们可以使用Quicktags API做更多事情。例如,我们可以向QTags.addButton方法传递一个回调函数,当用户点击相应的按钮时运行。考虑以下代码:

function custom_quicktags() {
if ( wp_script_is( 'quicktags' ) ) {
?>
<script type="text/javascript">
QTags.addButton( 'eg_callback', 'CSS div', css_callback );
function css_callback(){
var css_class = prompt( 'Class name:', '' );
if ( css_class && css_class !== '' ) {
QTags.insertContent('<div class="' + css_class +'"></div>');
}
}
</script>
<?php
}
}
add_action( 'admin_print_footer_scripts', 'custom_quicktags' );

css_callback是一个自定义 JS 函数,当用户点击自定义按钮时运行。在我们的示例中,该函数会提示输入框以允许用户为div元素设置类名。QTags.insertContent方法将打印指定的字符串到编辑器中textarea的。

用户设置类名 我们示例的回调函数会提示一个输入框,允许用户设置类名。

到目前为止,由于admin_print_footer_scripts操作,我们一直在管理页面中向WordPress编辑器添加快速标签。如果您在站点前端有任何编辑器实例,则应将回调函数挂钩到wp_print_footer_scripts操作。

无论如何,在生产中,您应该考虑将JavaScript文件排入WordPress注册的脚本中,如如何将您的资产排入WordPress中所述。GenerateWP的Quicktags Generator是构建自定义快速标签的一个有用工具。

覆盖Quicktags设置

Quicktags API提供了一种向工具栏添加新按钮的方法。由于quicktags_settings过滤器,WordPress也允许我们删除按钮。

function my_quicktags( $qtInit, $editor_id = 'content' ) {
$qtInit['buttons'] = 'strong,em,link,block,del,ins,img,ul,ol,li,code,more,close';
return $qtInit;
}
add_filter( 'quicktags_settings', 'my_quicktags', 10, 2 );

回调函数有两个参数:$qtInit是一个设置数组,$editor_id是编辑器的唯一 ID。在我们的示例中,$editor_id默认为“content” ——编辑文章页面中的编辑器文本区域的ID。

请注意,quicktag列表中的标签名称由逗号分隔,后跟空格。

此函数将覆盖默认设置,也可用于从工具栏中删除所有按钮:

function my_quicktags( $qtInit, $editor_id = 'content' ) {
$qtInit['buttons'] = ',';
return $qtInit;
}
add_filter( 'quicktags_settings', 'my_quicktags', 10, 2 );

我们已经为$qtInit数组的“buttons”元素分配了一个逗号作为值。空字符串不会按预期工作,并且不会覆盖默认设置。

将WordPress编辑器包含在首页

wp_editor函数从3.3版开始提供,它提供了一种简单的方法来将WordPress编辑器包含在站点的任何位置。

该函数在wp-includes/general-template.php文件中定义如下:

wp_editor( $content, $editor_id, $settings = array() );
  • $content ( string ) (required) 设置编辑器的初始内容;
  • $editor_id ( string ) (必填)为textarea和TinyMCE编辑器设置id属性(只能包含小写字母和下划线);
  • $settings ( array ) (可选)参数数组。

参数数组允许为两个编辑器设置许多配置参数。特定参数可以将设置直接传递给Quicktags(请参阅Codex中的完整参数列表)。

例如,您可能希望在页面模板中包含编辑器。考虑以下示例:

$content = '';
$editor_id = 'mycustomeditor';
$settings = array( 
'wpautop' => false, 
'media_buttons' => false, 
'quicktags' => array(
'buttons' => 'strong,em,del,ul,ol,li,block,close'
),
);
wp_editor( $content, $editor_id, $settings );

这几行代码将一个id为“myeditor”的空编辑器和指定的按钮打印到文本编辑器的工具栏中。

  • wpautop参数设置为false,这样的<p>元素将被用来包裹段落到编辑器。
  • media_buttons参数设置为false,所以用户无法上传媒体文件。
  • 所述quicktags阵列确定按钮上的文本编辑器工具栏显示。

对于WordPress文本编辑器,wp_editor()函数和quicktags_settings过滤器之间的主要区别在于该函数适用于编辑器的特定实例。您可以使用它在站点的任何位置包含新的编辑器(如页面模板),而quicktags_settings过滤器过滤所有现有实例并且不能用于生成新的编辑器实例。

以上示例的完整代码可在Gist上找到。

使用AddQuicktag插件增强WordPress文本编辑器

如果您需要一个工具来快速向WordPress文本编辑器添加按钮,AddQuicktag就是适合您的插件。

AddQuicktag添加自定义按钮 AddQuicktag允许用户向WordPress文本编辑器添加自定义按钮。

该插件提供了一个可从“设置”菜单访问的选项页面。在此页面上,管理员用户可以添加自定义按钮和删除现有按钮。

AddQuicktag允许专门为文章、页面和其他启用编辑器的文本区域(评论、文本小部件等)配置编辑器。

该插件还将Quicktags添加到可视化编辑器中。只需选中Visual»选项,可视化编辑器将显示带有自定义按钮的Quicktags下拉菜单

AddQuicktag选项页面的第二部分专用于内置快速标签配置。在本节中,可以删除特定文本区域中的按钮。

AddQuicktag选项设置 三个按钮已从编辑页面文本编辑器中删除

最后一部分为编辑器工具栏提供了附加功能。第一行选项增强了默认代码按钮,提供了一个选择菜单,根据所选语言为代码标签设置CSS类。

第二行提供了两个用于编码和解码特殊字符 ( htmlentities ) 的按钮。

高级AddQuicktag功能

高级AddQuicktag功能

小结

如果您是开发人员,您可能会发现向WordPress编辑器添加主题或特定于插件的功能会很有帮助。Quicktags API和许多过滤器和功能提供了有价值的工具来为我们的产品增加价值。如果您不是开发人员,您也可以配置WordPress编辑器,这要归功于WordPress插件目录中的几个免费插件,例如本文中介绍的AddQuicktag插件。

香港110M(含10M CN2)大带宽独服限量促销,香港E3-8G-1T硬盘-3IP,月付仅799!
赞(0) 打赏
版权声明:本文采用知识共享 署名4.0国际许可协议 [BY-NC-SA] 进行授权, 转载请注明出处。
文章名称:《深入了解WordPress文本编辑器》
文章链接:https://cnidc.co/26186.html
【声明】:国外主机测评仅分享信息,不参与任何交易,也非中介,所有内容仅代表个人观点,均不作直接、间接、法定、约定的保证,读者购买风险自担。一旦您访问国外主机测评,即表示您已经知晓并接受了此声明通告。
【关于安全】:任何 IDC商家都有倒闭和跑路的可能,备份永远是最佳选择,服务器也是机器,不勤备份是对自己极不负责的表现,请保持良好的备份习惯。
标签:
广告位招租,欢迎骚扰
香港110M(含10M CN2)大带宽独服限量促销,香港E3-8G-1T硬盘-3IP,月付仅799!

觉得文章有用就打赏一下文章作者

非常感谢你的打赏,我们将继续给力更多优质内容,让我们一起创建更加美好的网络世界!

支付宝扫一扫打赏

微信扫一扫打赏