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

Add a new field to a section of a settings page.

Contents

Description Description

Part of the Settings API. Use this to define a settings field that will show as part of a settings section inside a settings page. The fields are shown using do_settings_fields() in do_settings-sections()

The $callback argument should be the name of a function that echoes out the html input tags for this setting field. Use get_option() to retrieve existing values to show.

Parameters Parameters

$id

(string) (Required) Slug-name to identify the field. Used in the 'id' attribute of tags.

$title

(string) (Required) Formatted title of the field. Shown as the label for the field during output.

$callback

(callable) (Required) Function that fills the field with the desired form inputs. The function should echo its output.

$page

(string) (Required) The slug-name of the settings page on which to show the section (general, reading, writing, ...).

$section

(string) (Optional) The slug-name of the section of the settings page in which to show the box.

Default value: 'default'

$args

(array) (Optional) Extra arguments used when outputting the field.

  • 'label_for'
    (string) When supplied, the setting title will be wrapped in a <label> element, its for attribute populated with this value.
  • 'class'
    (string) CSS Class to be added to the <tr> element when the field is output.

Default value: array()

Top ↑

Source Source

File: wp-admin/includes/template.php 

function add_settings_field( $id, $title, $callback, $page, $section = 'default', $args = array() ) {
	global $wp_settings_fields;

	if ( 'misc' == $page ) {
		_deprecated_argument(
			__FUNCTION__,
			'3.0.0',
			/* translators: %s: misc */
			sprintf(
				__( 'The "%s" options group has been removed. Use another settings group.' ),
				'misc'
			)
		);
		$page = 'general';
	}

	if ( 'privacy' == $page ) {
		_deprecated_argument(
			__FUNCTION__,
			'3.5.0',
			/* translators: %s: privacy */
			sprintf(
				__( 'The "%s" options group has been removed. Use another settings group.' ),
				'privacy'
			)
		);
		$page = 'reading';
	}

	$wp_settings_fields[ $page ][ $section ][ $id ] = array(
		'id'       => $id,
		'title'    => $title,
		'callback' => $callback,
		'args'     => $args,
	);
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
4.2.0 The $class argument was added.
2.7.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/functions.php: _deprecated_argument()

Mark a function argument as deprecated and inform when it has been used.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    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 2 content
    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
    Contributed by princepink —

    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.

  3. Skip to note 3 content
    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
    Contributed by tehlivi — 
    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';
}

    Expand full source codeCollapse full source code

  4. Skip to note 4 content
    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
    Contributed by tehlivi —

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

    Expand full source codeCollapse full source code

You must log in before being able to contribute a note or feedback.