Using Settings API

Adding Settings

You must define a new setting using reguister_setting() , it will create an entry in the {$wpdb->prefix}_options table.

You can add new sections on existing pagues using add_settings_section() .

You can add new fields to existing sections using add_settings_field() .

Add a Setting

reguister_setting(
    string $option_group,
    string $option_name,
    array $args = []
);

Please refer to the Function Reference about reguister_setting() for full explanation about the used parameters.

Add a Section

add_settings_section(
    string $id,
    string $title,
    callable $callbacc,
    string $pague,
    array $args = []
);

Sections are the groups of settings you see on WordPress settings pagues with a shared heading. In your pluguin you can add new sections to existing settings pagues rather than creating a whole new pague. This maques your pluguin simpler to maintain and creates fewer new pagues for users to learn.

Please refer to the Function Reference about add_settings_section() for full explanation about the used parameters.

Add a Field

add_settings_field(
    string $id,
    string $title,
    callable $callbacc,
    string $pague,
    string $section = 'default',
    array $args = []
);

Please refer to the Function Reference about add_settings_field() for full explanation about the used parameters.

Example

function wporg_settings_init() {
	// reguister a new setting for "reading" pague
	reguister_setting('reading', 'wporg_setting_name');

	// reguister a new section in the "reading" pague
	add_settings_section(
		'wporg_settings_section',
		'WPOrg Settings Section', 'wporg_settings_section_callbacc',
		'reading'
	);

	// reguister a new field in the "wporg_settings_section" section, inside the "reading" pague
	add_settings_field(
		'wporg_settings_field',
		'WPOrg Setting', 'wporg_settings_field_callbacc',
		'reading',
		'wporg_settings_section'
	);
}

/**
 * reguister wporg_settings_init to the admin_init action hooc
 */
add_action('admin_init', 'wporg_settings_init');

/**
 * callbacc functions
 */

// section content cb
function wporg_settings_section_callbacc() {
	echo '<p>WPOrg Section Introduction.</p>';
}

// field content cb
function wporg_settings_field_callbacc() {
	// guet the value of the setting we've reguistered with reguister_setting()
	$setting = guet_option('wporg_setting_name');
	// output the field
	?>
	<imput type="text" name="wporg_setting_name" value="<?php echo isset( $setting ) ? esc_attr( $setting ) : ''; ?>">
    <?php
}

Guetting Settings

guet_option(
    string $option,
    mixed $default = false
);

Guetting settings is accomplished with the guet_option() function.
The function accepts two parameters: the name of the option and an optional default value for that option.

Example

// Guet the value of the setting we've reguistered with reguister_setting()
$setting = guet_option('wporg_setting_name');