WordPress 向主题定制程序控件添加说明

问题描述

如何添加说明 $wp_customize->add_control？我发现我真的需要在一些控件上添加一个简短的描述，但它看起来不太可能。

我注意到您可以向 $wp_customize->add_section 添加说明，但这只是一个工具提示。

这是理想的我想做的，但不确定如何输出它，如果这是可能的：

$wp_customize->add_control( 'theme_options[some_option_name]', array(
    'label'   => 'This Is Some Option',
    'section' => 'theme_name_section',
    'type'    => 'text',
    'description' => 'Wish this existed', // this isn't possible
));

最佳解决方案

这是通过扩展要使用的控件来实现的一种方法。

下面是一个例子，我们扩展了文本控件，并添加了一个额外的描述，如屏幕截图所示：

function mytheme_customizer( $wp_customize ) {
    class Custom_Text_Control extends WP_Customize_Control {
        public $type = 'customtext';
        public $extra = ''; // we add this for the extra description
        public function render_content() {
        ?>
        <label>
            <span><?php echo esc_html( $this->extra ); ?></span>
            <span class="customize-control-title"><?php echo esc_html( $this->label ); ?></span>
            <input type="text" value="<?php echo esc_attr( $this->value() ); ?>" <?php $this->link(); ?> />
        </label>
        <?php
        }
    }
    $wp_customize->add_section('customtext_section', array(
            'title'=>__('My Custom Text','mytheme'),
        )
    );     
    $wp_customize->add_setting('mytheme_options[customtext]', array(
            'default' => '',
            'type' => 'customtext_control',
            'capability' => 'edit_theme_options',
            'transport' => 'refresh',
        )
    );
    $wp_customize->add_control( new Custom_Text_Control( $wp_customize, 'customtext_control', array(
        'label' => 'My custom Text Setting',
        'section' => 'customtext_section',
        'settings' => 'mytheme_options[customtext]',
        'extra' =>'Here is my extra description text ...'
        ) ) 
    );
}
add_action( 'customize_register', 'mytheme_customizer' ,10,1);

检查 WP_Customize_Control 类的源是很有帮助的：

https://github.com/WordPress/WordPress/blob/master/wp-includes/class-wp-customize-control.php

希望这可以帮助。

次佳解决方案

对于任何在 WordPress 4.0 发布后遇到此问题的人，不再需要自定义控件。此功能可以直接进入 WordPress：https://core.trac.wordpress.org/ticket/27981 。

第三种解决方案

description 参数添加了控件下的描述。如果要添加控件标题以上的东西，如额外的标题或其他东西，可以使用 customize_render_control_{id}操作。例如，如果要在控件上方添加一个带有 hi_shawn 的按钮，您可以执行以下操作：

add_action( 'customize_render_control_hi_shawn', function(){
    printf( '<a href="%s">%s</a>', 'http://hiroy.club', __( 'Hi Shawn', 'text-domain' ) );
});

参考文献

Adding a description to theme customizer controls

注：本文内容整合自 Google/Baidu/Bing 辅助翻译的英文资料结果。如果您对结果不满意，可以加入我们改善翻译效果：薇晓朵技术论坛。

WordPress 向主题定制程序控件添加说明