add_settings_field( string $id, string $title, callable $callback, string $page, string $section = 'default', array $args = array() )

使用示例

• 示例1

  带label标签

  将id为myprefix_setting-id的设置添加到“常规设置”页面。myprefix应该是插件或主题的唯一字符串。设置label标签，以便可以单击设置标题以聚焦字段。

  add_settings_field( 'myprefix_setting-id',
  	'This is the setting title',
   	'myprefix_setting_callback_function',
  	'general',
  	'myprefix_settings-section-name',
  	array( 'label_for' => 'myprefix_setting-id' ) );
  
  

• 示例2

  只需查找isset，即可在前端选中复选框设置字段。无需添加额外的检查，如1、0、true、false…。如果未设置复选框，则返回false。

  /* **************** CHECKBOXES **************** */
      // settings checkbox 
      add_settings_field(
          'wpdevref_removestyles_field',
          esc_attr__('Remove Plugin Styles', 'wpdevref'),
          'wpdevref_removestyles_field_cb',
          'wpdevref_options',
          'wpdevref_options_section',
          array( 
              'type'         => 'checkbox',
              'option_group' => 'wpdevref_options', 
              'name'         => 'wpdevref_removestyles_field',
              'label_for'    => 'wpdevref_removestyles_field',
              'value'        => (empty(get_option('wpdevref_options')['wpdevref_removestyles_field']))
              ? 0 : get_option('unitizr_options')['wpdevref_removestyles_field'],
              'description'  => __( 'Check to remove preset plugin overrides.', 
                              'wpdevref' ),
              'checked'      => (!isset(get_option('wpdevref_options')['wpdevref_removestyles_field']))
                                 ? 0 : get_option('wpdevref_options')['wpdevref_removestyles_field'],
              // Used 0 in this case but will still return Boolean not[see notes below] 
              'tip'          => esc_attr__( 'Use if plugin fields drastically changed when installing this plugin.', 'wpdevref' ) 
              )
      ); 

  添加回调，如下所示：

  /** 
   * switch for 'remove styles' field
   * @since 2.0.1
   * @input type checkbox
   */
  function wpdevref_removestyles_field_cb($args)
  { 
      $checked = '';
      $options = get_option($args['option_group']);
      $value   = ( !isset( $options[$args['name']] ) ) 
                  ? null : $options[$args['name']];
      if($value) { $checked = ' checked="checked" '; }
          // Could use ob_start.
          $html  = '';
          $html .= '<input id="' . esc_attr( $args['name'] ) . '" 
          name="' . esc_attr( $args['option_group'] . '['.$args['name'].']') .'" 
          type="checkbox" ' . $checked . '/>';
          $html .= '<span class="wndspan">' . esc_html( $args['description'] ) .'</span>';
          $html .= '<b class="wntip" data-title="'. esc_attr( $args['tip'] ) .'"> ? </b>';
  
          echo $html;
  }

  将在前端使用检测渲染的动作：

   // Options getter could be a function with arguments.
      $options = get_option('wpdevref_options');
      $value   = ( !isset($options['wpdevref_removestyles_field'] ) ) 
                   ? '' : $options['wpdevref_removestyles_field'];
      if ( !$value ) { 
      // Do some magic
      }
  

  或者，您可以将“false”添加到任何条件（empty, null, '', 0）中。

• 示例3

  我怀疑标签的“id”属性中使用的可能会被重写为标签的“name”属性。
  我认为$id参数是用来识别被WP识别的字段，并显示该字段或获取其值。是否用作实际标签的id属性的值取决于具体情况（在$callback中）。
  通常情况下，name属性可能会被用于这个目的。
  我一直不明白这个参数的意思是为某些表单元素生成属性，但似乎不是。当把‘label_for’放入将被传递到$callback的$args中时，将自动生成带有属性的label标签。所以这个值应该和你写的$callback中的实际id的值一样。

• 示例4

  add_action('admin_init', 'your_function');
  function your_function(){
  	add_settings_field(
  		'myprefix_setting-id',
  		'This is the setting title',
  		'myprefix_setting_callback_function',
  		'general',
  		'default',
  		array( 'label_for' => 'myprefix_setting-id' )
  	);
  }
  
  function myprefix_setting_callback_function($args){
  	echo 'Content here';
  }

• 示例5

  $id参数描述说“用于标签的‘id’属性”，然而这意味着你必须确保这个$id被用作与字段相关的input元素的HTML id标签。 WP只使用这个$id来为你的字段在它的内部settings_field列表（$wp_settings_fields）中提供一个唯一的键。
  由于WP不控制input元素被添加到你的管理页面HTML中的方式，你必须确保你输出的input元素的id与$id标签相匹配。这可以通过将$callback配置为一个函数来完成，它将产生具有正确id标签的正确input元素。
  $args数组中的'label_for'元素也应该与相同的id相匹配，以便让浏览器了解哪个label属于哪个input字段。

  另外值得注意的是，input元素的id标记还应与register_setting()调用中使用的$option_name（第二个）参数匹配，否则设置API将无法将$_POST中浏览器发送的值与您的设置匹配，并且您的设置将永远不会保存。

  长话短说，我们有一堆不同的名称和参数，但基本上，add_settings_field()调用的$id和$args['label_for']，以及register_setting()调用中的$option_name，再加上input字段回调中使用的id，都应该是相同、唯一的id。此外，在get_option($option)调用中，应将相同的id用作$option参数，以获取设置值。

  register_setting( 'mygroup', 'mynewcheckboxID' );
  add_settings_field(
  		'mynewcheckboxID', 
  		'My New Checkbox',
  		'callback_input_myid',
  		'myAdminPage',
  		'myAdminSection', 
  		[
  			'label_for' => 'mynewcheckboxID'
  		] );
  
  function callback_input_myid() {
  	echo "<input type='checkbox' id='mynewcheckboxID' value='1'"
  	if ( get_option('mynewcheckboxID') == '1' ) {
  		echo ' checked';
  	}
   	echo '/>';
  }
  

• 示例6

  面向对象：

  class ClassName {
  	public function __construct() {
  		add_action( 'admin_init', array( $this, 'your_function' ) );
  	}
  
  	function your_function() {
  		add_settings_field(
  			'myprefix_setting-id',
  			'This is the setting title',
  			array( $this, 'myprefix_setting_callback_function' ),
  			'general',
  			'default',
  			array( 'label_for' => 'myprefix_setting-id' ),
  		);
  	}
  
  	function myprefix_setting_callback_function( $args ) {
  		echo 'Content here';
  	}
  }
  
  $ClassName = new ClassName();