WP自定义组件Customizer api利用add_setting来生成设置项,这个东西并不会显性显示,它负责数据的处理,一个Control对应一个设置项setting,setting管理控件数据的预览、保存和清理。控件就像流水线上的产品,造型一致,功能统一,从流水线下来以后,我们取出一个产品打包(section),又给他贴了张快递面单(setting),这个时候这个产品就具有了唯一性,他有了对应的数据,客户修改了订单,要求产品上另行写上一行祝福语(修改控件值),那么最终客户会收到一个含有祝福语的产品(提交数据)。
节点管理控件的组织布局,而setting则负责包办控件的数据,控件生成时会绑定节点以确定显示位置,也需要绑定setting以定向提交数据。
用法与参数
设置项命令用法
add_setting( $id, $args );
add_setting参数
- $id (字符串)(必须)一个唯一的id,默认:None
- $args (数组)(必须)
$args 的参数
- default (可选) 相关联Controller的默认值
- transport (可选) 更新预览的方式,默认:refresh
- type (可选)保存的方式,默认:theme_mod
- capability (可选)根据用户的权限控制是否显示,默认:edit_theme_options
- theme_supports (可选)根据主题的设置是否显示,用到方法add_theme_support
- validate_callback (可选)设置值的服务器端验证回调
- sanitize_callback (可选)定义一个函数以检验或过滤控件传回的原始值
- sanitize_js_callback(可选)回调将Customize PHP设置值转换为JSON可序列化的值
- dirty(可选)很少用,创建时不管是否有脏数据,默认:false
示例
$wp_customize->add_setting( 'setting_id', array(
'type' => 'theme_mod', // or 'option'
'capability' => 'edit_theme_options',
'theme_supports' => '', // Rarely needed.
'default' => '',
'transport' => 'refresh', // or postMessage
'sanitize_callback' => '',
'sanitize_js_callback' => '', // Basically to_json.
) );
id的命名方式
请不要用诸如widget_,sidebars_widgets[],nav_menu[],或是nav_menu_item[]这样的条目来命名设置项,这些设置id分别为widget实例、边栏、导航菜单和导航菜单项保留。如果您需要在设置项id中使用"widget",请将其用作后缀而不是前缀,例如"homepage_widget"。