WordPress教程

使用Kirki框架更快地构建WordPress Customizer定制器设置

也想出现在这里?联系我们
面包多

开始之前,可能有些朋友对我所说的 wordpress 定制器 Customizer 有些陌生,其实就是我们后台 外观-自定义 进入的界面,如下图所示,左边的部分就是:
使用Kirki框架更快地构建WordPress Customizer定制器设置-创客云
按照 WordPress 的开发规范,是建议开发者可以尽可能使用这个 Customizer 来添加设置选项。如果你曾经开发过 Customizer 设置选项,你会发现,添加一个选项所需要的代码和步骤是有些多的,倡萌也很不喜欢这样的添加方式。而今天介绍的主角 Kirki 就是用来更快地添加设置选项的框架。

Kirki 简介

使用Kirki框架更快地构建WordPress Customizer定制器设置-创客云
Kirki 是一个免费的开源(由 MIT 许可)框架,专门为主题或插件开发者开发,用于添加定制器(Customizer)设置选项到主题或插件中。

也想出现在这里?联系我们
创客主机

官方网站: https://kirki.org/

自 2014 年以来,Kirki 的主要开发人员 Aristeides Stathopoulos 一直在研究该框架。通过不断的更新和改进,Kirki 在 Github 上建立了一个社区,其中包括 1000 多颗星星和 300 个复制。在 Kirki 之前,我从未接触过 WordPress 的定制器( Customizer )。Kirki 帮助我了解了定制器,并在更少的时间内完成了很多工作!

也想出现在这里?联系我们
创客主机

WordPress 核心 Customizer 控件

默认情况下,WordPress 核心包括一些基本的 Customizer 控件。例如:文本、文本区域、复选框、单选、选择、下拉页面、电子邮件、网址、数字、隐藏和日期控件。

Kirki 除了支持这些核心控件,还支持其他二十多个。可以说,Kirki 控件涵盖了更高级的用例。例如:

  • 排版
  • 调色板
  • TinyMCE 编辑器
  • 可排序字段

Kirki 还提供 WordPress 和兴中不可用的功能,例如自动生成 CSS 输出和 postMessage 脚本。这些功能(我们将在本文后面介绍)可以轻松地将开发时间缩短一半。

Kirki 很慢?

通常针对 Kirki 的一种批评是它运行缓慢。实际上,这种批评被用于大多数框架(包括 WordPress)。有道理吧?您正在加载很多您可能永远不会使用的代码。在这种情况下,事实是相反。实际上,使用 Kirki 构建的大多数时间控制面板实际上都比使用核心 Controls 构建的相同时间面板要快。这是因为 Kirki 添加了 WordPress 中未内置的优化层。

初始化自定义程序后,WordPress 会立即尝试加载所有 Customizer 控件,即使它们位于某个部分或面板中,并且用户还没有与其进行交互。相比之下,Kirki 将加载推迟到用户与控件进行交互之前。为了在实践中看到这种效果,让我们尝试使用两种不同方法添加 50 个颜色控件。
WordPress 核心方法:

  1. for ($i = 0; $i < 50; $i++){
  2. 	$wp_customize->add_setting( 'color_setting_hex_' . $i , array(
  3. 		'default' => '#0088CC'
  4. 	) );
  5.  
  6. 	// add color picker control
  7. 	$wp_customize->add_control( new WP_Customize_Color_Control( $wp_customize, 'color_setting_hex_' . $i, array(
  8. 		'label' => 'Color Control',
  9. 		'section' => 'title_tagline',
  10. 		'settings' => 'color_setting_hex_' . $i,
  11. 	) ) );
  12. }

使用 Kirki:

  1. for ($i = 0; $i < 50; $i++) {
  2.      Kirki::add_field( 'config_id', array(
  3.          'type'        => 'color',
  4.          'settings'    => 'color_setting_hex_' . $i,
  5.          'label'       => __( 'Color Control', 'kirki' ),
  6.          'section'     => 'title_tagline',
  7.          'default'     => '#0088CC',
  8.      ) );
  9.  }

结果:
使用Kirki框架更快地构建WordPress Customizer定制器设置-创客云

将 Kirki 集成到您的项目中

有很多种方法可以将 Kirki 框架集成到您的项目中,官方文档很好地介绍了不同的方法。我建议开发人员指导用户安装 Kirki 插件版本,而不是直接在项目代码中包含框架。可以使用 TGMPA 或提供的脚本来完成。采取插件途径的原因是 Kirki 经常得到更新和改进。通过安装插件版本,您的用户将可以尽快获取错误修复和安全更新。相反,当您将框架作为项目的一部分包含在项目时,仅当您更新主题或插件时,用户才会收到更新,更新的频率可能比所需的少。无论使用哪种方法,请确保在添加设置之前检查 Kirki 是否已初始化:

  1. // 如果 Kirki 类不存在就退出
  2. if ( ! class_exists( 'Kirki' ) ) {
  3.     return;
  4. }

字段 Fields

在“WordPress 核心方法”示例中,我们首先创建了一个设置,然后为其创建了一个控件。在大多数情况下,两者是直接链接的。Kirki 简化了流程,并允许我们创建一个“字段”。创建字段后,它将在后台为我们构建设置和控件。字段支持您期望的所有控制参数(标签、描述、部分、默认值)以及某些 Kirki 特定参数。

'type'参数允许您选择 Kirki 的 30 种控件类型之一:https://kirki.org/docs/controls/

部分 Sections

Customizer 定制器部分允许您将控件分组在一起。WordPress 有六个内置部分,您也可以添加控件:

  • title_tagline –站点身份
  • colors –颜色
  • header_image –标题图片
  • background_image –背景图片
  • static_front_page –主页设置
  • custom_css –自定义 CSS

Kirki 中的部分与核心中的完全相同,Kirki::add_section() 方法只是$wp_customize->add_section()的封装,并接受相同的参数和值。

  1. Kirki::add_section( 'section_id', array(
  2.      'title'          => esc_html__( 'My Section', 'kirki' ),
  3.      'description'    => esc_html__( 'My section description.', 'kirki' ),
  4.  ) );

面板 Panels

面板允许您通过将各部分分组在一起来创建另一个层次结构。WordPress 核心具有一个内置面板,即“菜单”。同样,Kirki 实现只是核心功能的封装。

  1. Kirki::add_panel( 'panel_id', array(
  2.      'priority'    => 10,
  3.      'title'       => esc_html__( 'My Panel', 'kirki' ),
  4.      'description' => esc_html__( 'My panel description', 'kirki' ),
  5.  ) );

'transport' => 'auto'
在创建“定制器控件”时,您有两个用于传输参数的选项:

  • Refresh –即刷新,每次用户进行更改时,都会刷新预览窗口来显示更改。这可能需要几秒钟。
  • postMessage –每次用户进行更改时,预览窗口都会使用 Javascript 更新,而无需刷新并且几乎是即时的。

毫无疑问,postMessage 是更新预览器的上乘方法,应尽可能使用它。但是,有一个缺点,使用 postMessage 意味着您需要为每个控件创建编写自定义 JS 代码。一个简单的实现看起来像这样:

  1. // 实时更新网站标题...
  2. wp.customize( 'blogname', function( value ) {
  3.     value.bind( function( newval ) {
  4.         $( '#site-title a' ).html( newval );
  5.     } );
  6. } );

当您进行许多设置时,就需要不断重复这些代码。这就是 Kirki 大放异彩的地方,它添加了第三个选项:'transport'=>'auto'。'transport'=>'auto'与 Kirki 添加的另一个名为'output'的参数一起使用。定义两个值后,Kirki 将为您自动生成 postMessage 脚本。这意味着您无需编写任何 Javascript 代码即可获得使用 postMessage 的所有好处。使用 transport =>'auto'的字段如下所示:

  1. Kirki::add_field( 'config_id', array(
  2.      'type'        => 'color',
  3.      'settings'    => 'color_setting_hex',
  4.      'label'       => __( 'Color Control', 'kirki' ),
  5.      'section'     => 'colors',
  6.      'default'     => '#0088CC',
  7.      'transport'   => 'auto',
  8.      'output' => array(
  9.          array(
  10.              'element'  => 'body',
  11.              'property' => 'background-color',
  12.          ),
  13.      ),
  14.  ) );

Kirki 的这种省时功能意味着大部分时间不再需要编写或排队自己的 postMessage 脚本。

前端 CSS 输出

创建 Customizer 设置的另一部分是在前端生成 CSS 输出。一个简单的示例可能如下所示:

  1. /**
  2.  * Output the Customizer CSS to wp_head
  3.  */
  4. function wptavern_customizer_css() {
  5. 	$bg_color = get_theme_mod( 'color_setting_hex' );
  6. 	?>
  7. 	<style>
  8. 		body {
  9. 			background-color: <?php echo sanitize_hex_color( $bg_color ); ?>;
  10. 		}
  11. 	</style>
  12. 	<?php
  13. }
  14. add_action( 'wp_head', wptavern_customizer_css );

像 postMessage 示例一样,如果您有很多设置,就需要不断重复类似的代码。幸运的是,'transport'=>'auto'也会为您处理前端输出。即使在我们的简化示例中, 'transport'=>'auto' 也将我们需要编写的代码减少了约 50%。

总结

在本文中,我们仅考察了 Kirki 框架的基础知识及其两个参数,已经可以看到它如何使我们能够更快地创建 Customizer 控件而又不影响性能。

当您接触 Kirki 时,您会很快发现它在 Customize API 之上添加的丰富功能。毫不奇怪,它已在超过 400,000 个网站上使用,并且是市场上一些最大的 WordPress 主题的核心部分。

服务范围 1、专业提供WordPress主题、插件汉化、优化、PHP环境配置等服务请详询在线客服
2、本站承接 WordPress、DedeCMS、ThinkPHP 等系统建站、仿站、开发、定制等服务
3、英文模板(主题)安装费用为120元/次,汉化主题首次免费安装(二次安装30元/次)
售后时间 周一至周五(法定节假日除外) 10:00-22:00
免责声明 本站所提供的模板(主题/插件)等资源仅供学习交流,若使用商业用途,请购买正版授权,否则产生的一切后果将由下载用户自行承担,有部分资源为网上收集或仿制而来,若模板侵犯了您的合法权益,请来信通知我们(Email: 2107117185@qq.com),我们会及时删除,给您带来的不便,我们深表歉意!
也想出现在这里?联系我们
360uxc
(0)

本文由来源 WordPress大学,由 PetitQ 整理编辑!

也想出现在这里?联系我们
创客主机

热评文章

发表评论

精彩推荐

Tabula - 艺术音乐外语培训学校网站WordPress模板

Envato Affiliates

本站承接 WordPress / DedeCMS / ThinkPHP 等
系统建站、仿站、开发、定制等业务!

Hi, 如果您有主题插件代购汉化等建站相关业务,可以 跟我联系 哦!
欢迎投稿
嘿,欢迎咨询!