User Contributed Notes

1. Skip to note 7 content

   
   Codex
   
   
   11 years ago
   

   You must log in to vote on the helpfulness of this noteVote results for this note: 6You must log in to vote on the helpfulness of this note

   With Label

   Adds a setting with id myprefix_setting-id to the General Settings page. myprefix should be a unique string for your plugin or theme. Sets a label so that the setting title can be clicked on to focus on the field.

   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. Skip to note 8 content

   
   tradesouthwest
   
   
   6 years ago
   

   You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

   A checkbox settings field can be checked on the front end by simply looking for isset. No need to add additional checks like 1, 0, true, false…. if a checkbox is not set then it returns 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' ) 
               )
       ); 

   Then the callback would be added as such:

   /** 
    * 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;
   }

   And checking to render action on the front side would use:

    // 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
       }

   Optionally you can add a ‘false’ into any conditional (empty, null, ”, 0).

3. Skip to note 9 content

   
   princepink
   
   
   11 years ago
   

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   I suspect Used in the ‘id’ attribute of tags might be rewritten to Used in the ‘name’ attribute of tags.
   I think the $id param is used for identifying the field to be recognised by WP and to show the field or get that’s value. Whether to be used as actual tag’s attribute id‘s value or not depends on the circumstances (in $callback). Normally the name attribute might be taken for this aim.
   I just had been confused this param means to generate the attribute for some form element, but it seems not. When put ‘label_for’ in the $args that will be passed to the $callback, this generates label tag with attribute for automatically. So this value should be same as an actual id‘s value in the $callback which you write.

4. Skip to note 10 content

   
   tehlivi
   
   
   9 years ago
   

   You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

   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. Skip to note 11 content

   
   Bence Szalai
   
   
   7 years ago
   

   You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

   The $id argument description says “Used in the ‘id’ attribute of tags”, however this means you have to ensure this $id is used as the HTML id tag of your input element related to the field. WP only use this $id to have an unique key for your field in it’s internal settings_field list ($wp_settings_fields).
   As WP does not control the way the input element is added to your Admin HTML, you have to ensure you output the input element with an id that matches the $id tag. This can be done by configuring the $callback to a function, that will produce the correct input element with the correct id tag.
   The ‘label_for’ element in the $args array should also match the very same id in order for the browser to understand which label belongs to which input field.

   It worth noting also, that the id tag of the input element should also match the $option_name (2nd) parameter you are using in your register_setting() call, otherwise the Settings API will fail to match the value sent by the browser in $_POST to your setting, and your setting will never be saved.

   So long story short, we have a bunch of different names and arguments, but basically $id and $args['label_for'] of add_settings_field() call and the $option_name of register_setting() call PLUS the id you use in your input field callback, should all be the same, unique id. Also the same id should be used as the $option parameter in the get_option($option) calls to get the value of the setting.

   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 '/>';
   }

   • If storing multiple values in an array as recommended, the name attribute of each HTML input generated in your callback must be in the form name="<em>option_name</em>[<em>key</em>]". The option_name is the value passed to register_setting() (the 2nd parameter). The key sets the key of the key=>value pair in the resulting associative array that is passed to your sanitize_callback handler. Even though register_setting()‘s optional $args parameter can state that your option type is an array, there is no automatic combining or separating of individual key=>value pairs you might be storing within the array. That needs to be done by you in your sanitize_callback handler, after you get_option(), and in the add_settings_field() callbacks.

     David Brown 3 years ago

6. Skip to note 12 content

   
   tehlivi
   
   
   9 years ago
   

   You must log in to vote on the helpfulness of this noteVote results for this note: -2You must log in to vote on the helpfulness of this note

   Object Oriented:

   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();

   • Fixed Object Oriented code:

     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();

     Abhijit Rakas 6 years ago