Settings API in Wordpress

Introduction

The Settings API helps you easily create and manage settings pages in WordPress without writing a lot of code. It keeps your settings organized and safe.

You want to add a new settings page for your plugin or theme.

You need to save user preferences in the WordPress admin area.

You want to create forms that store options in the WordPress database.

You want WordPress to handle security and validation for your settings.

You want a consistent look and feel for your settings pages.

Syntax

Wordpress

register_setting( $option_group, $option_name, $args );
add_settings_section( $id, $title, $callback, $page );
add_settings_field( $id, $title, $callback, $page, $section, $args );

register_setting links your option to a group and handles saving.

add_settings_section creates a section on the settings page to group fields.

Examples

This registers a setting called 'my_plugin_option_name' under the group 'my_plugin_options_group'.

Wordpress

register_setting('my_plugin_options_group', 'my_plugin_option_name');

This adds a section titled 'My Section Title' to the 'my_plugin_page' settings page.

Wordpress

add_settings_section('my_section', 'My Section Title', 'my_section_callback', 'my_plugin_page');

This adds a field labeled 'My Field Label' inside 'my_section' on 'my_plugin_page'.

Wordpress

add_settings_field('my_field', 'My Field Label', 'my_field_callback', 'my_plugin_page', 'my_section');

Sample Program

This code creates a settings page under the WordPress Settings menu. It registers one text option, shows a section with a description, and a text input field. The form saves the option safely using the Settings API.

Wordpress

<?php
// Hook to admin menu to add settings page
add_action('admin_menu', function() {
    add_options_page('My Plugin Settings', 'My Plugin', 'manage_options', 'my-plugin', 'my_plugin_settings_page');
});

// Hook to admin init to register settings
add_action('admin_init', function() {
    register_setting('my_plugin_options_group', 'my_plugin_option');

    add_settings_section(
        'my_plugin_section',
        'My Plugin Settings Section',
        function() { echo '<p>Adjust your settings below:</p>'; },
        'my-plugin'
    );

    add_settings_field(
        'my_plugin_field',
        'Enter Text',
        function() {
            $value = get_option('my_plugin_option', '');
            echo "<input type='text' name='my_plugin_option' value='" . esc_attr($value) . "' />";
        },
        'my-plugin',
        'my_plugin_section'
    );
});

// Settings page HTML
function my_plugin_settings_page() {
    ?>
    <div class="wrap">
        <h1>My Plugin Settings</h1>
        <form method="post" action="options.php">
            <?php
            settings_fields('my_plugin_options_group');
            do_settings_sections('my-plugin');
            submit_button();
            ?>
        </form>
    </div>
    <?php
}
?>

Important Notes

Always use esc_attr() when outputting saved values in input fields to keep data safe.

Use settings_fields() and do_settings_sections() inside your form to connect your settings properly.

Settings API handles security checks like nonce verification automatically when you use it correctly.

Summary

The Settings API helps you build settings pages easily and safely.

Use register_setting, add_settings_section, and add_settings_field to organize your options.

Always wrap your settings form with settings_fields and do_settings_sections for proper saving and display.

Practice

1. What is the main purpose of the WordPress Settings API?

easy

A. To optimize database queries for faster loading

B. To handle user authentication and login

C. To create and manage settings pages and options safely and easily

D. To create custom post types and taxonomies

Solution

1. Step 1: Understand the role of Settings API

   The Settings API is designed to help developers create settings pages and manage options in a standardized and secure way.

2. Step 2: Compare with other WordPress features

   User authentication, database optimization, and custom post types are handled by other parts of WordPress, not the Settings API.

3. Final Answer:

   To create and manage settings pages and options safely and easily -> Option C

4. Quick Check:

   Settings API = Manage settings pages [OK]

Hint: Settings API is for settings pages, not users or posts [OK]

Common Mistakes:

• Confusing Settings API with user login functions
• Thinking it manages posts or taxonomies
• Assuming it optimizes database queries

2. Which function is used to register a setting group and option name in the WordPress Settings API?

easy

A. register_setting()

B. add_settings_section()

C. add_settings_field()

D. settings_fields()

Solution

1. Step 1: Identify function roles

   register_setting() registers a setting group and option name for saving options.

2. Step 2: Differentiate from other functions

   add_settings_section() adds a section, add_settings_field() adds a field, and settings_fields() outputs nonce fields for the form.

3. Final Answer:

   register_setting() -> Option A

4. Quick Check:

   Register setting = register_setting() [OK]

Hint: register_setting registers options, sections and fields add UI [OK]

Common Mistakes:

• Using add_settings_section to register options
• Confusing settings_fields with registration
• Mixing add_settings_field with option registration

3. What will be the output of the following code snippet in a WordPress settings page?

register_setting('my_option_group', 'my_option_name');
add_settings_section('my_section', 'My Section', null, 'my_page');
add_settings_field('my_field', 'My Field', function() { echo ''; }, 'my_page', 'my_section');

// In the form:
settings_fields('my_option_group');
do_settings_sections('my_page');

What does this code do when the settings page loads?

medium

A. Displays a text input with the saved value of 'my_option_name' inside 'My Section'

B. Shows an error because the callback function is missing

C. Creates a checkbox input instead of a text input

D. Does not display any input because settings_fields is missing

Solution

1. Step 1: Analyze the field callback

   The callback outputs a text input with the name 'my_option_name' and sets its value to the saved option using get_option('my_option_name').

2. Step 2: Check form functions

   settings_fields('my_option_group') outputs necessary nonce and hidden fields, and do_settings_sections('my_page') outputs the registered sections and fields.

3. Final Answer:

   Displays a text input with the saved value of 'my_option_name' inside 'My Section' -> Option A

4. Quick Check:

   Field callback outputs input with saved value [OK]

Hint: Field callback outputs input; settings_fields and do_settings_sections show it [OK]

Common Mistakes:

• Assuming callback is missing or broken
• Thinking input type is checkbox
• Forgetting settings_fields is present

4. Identify the error in this WordPress Settings API code snippet:

register_setting('my_group', 'my_option');
add_settings_section('section_id', 'Section Title', null, 'my_page');
add_settings_field('field_id', 'Field Title', 'my_field_callback', 'my_page', 'section_id');

function my_field_callback() {
  echo '';
}

// In the form:
settings_fields('wrong_group');
do_settings_sections('my_page');

What is the main problem here?

medium

A. The add_settings_section callback is required but set to null

B. The callback function is missing

C. The add_settings_field is missing the page parameter

D. The settings_fields function uses a different group name than register_setting

Solution

1. Step 1: Check group names consistency

   register_setting uses 'my_group' but settings_fields uses 'wrong_group'. They must match for nonce and saving to work.

2. Step 2: Verify other parts

   The callback function exists, page parameter is present, and section callback can be null (optional).

3. Final Answer:

   The settings_fields function uses a different group name than register_setting -> Option D

4. Quick Check:

   Group names must match in register_setting and settings_fields [OK]

Hint: Match group names in register_setting and settings_fields exactly [OK]

Common Mistakes:

• Ignoring mismatch of group names
• Thinking section callback cannot be null
• Assuming missing page parameter

5. You want to create a settings page with two sections: 'General' and 'Advanced'. Each section has multiple fields. Which sequence of Settings API functions correctly sets up this page?

hard

A. add_settings_section('general_section', 'General', null, 'my_page');
add_settings_field('field1', 'Field 1', 'callback1', 'my_page', 'general_section');
register_setting('my_group', 'option1');
add_settings_section('advanced_section', 'Advanced', null, 'my_page');
add_settings_field('field2', 'Field 2', 'callback2', 'my_page', 'advanced_section');

B. register_setting('my_group', 'option1');
register_setting('my_group', 'option2');
add_settings_section('general_section', 'General', null, 'my_page');
add_settings_section('advanced_section', 'Advanced', null, 'my_page');
add_settings_field('field1', 'Field 1', 'callback1', 'my_page', 'general_section');
add_settings_field('field2', 'Field 2', 'callback2', 'my_page', 'advanced_section');

C. register_setting('my_group', 'option1');
add_settings_field('field1', 'Field 1', 'callback1', 'my_page', 'general_section');
add_settings_section('general_section', 'General', null, 'my_page');
add_settings_section('advanced_section', 'Advanced', null, 'my_page');
add_settings_field('field2', 'Field 2', 'callback2', 'my_page', 'advanced_section');

D. register_setting('my_group', 'option1');
register_setting('my_group', 'option2');
add_settings_field('field1', 'Field 1', 'callback1', 'my_page', 'general_section');
add_settings_section('general_section', 'General', null, 'my_page');
add_settings_section('advanced_section', 'Advanced', null, 'my_page');
add_settings_field('field2', 'Field 2', 'callback2', 'my_page', 'advanced_section');

Solution

1. Step 1: Register all settings first

   Use register_setting for each option before adding sections and fields.

2. Step 2: Add sections before fields

   Sections must be added before fields so fields can attach to existing sections.

3. Step 3: Add fields to correct sections

   Use add_settings_field with correct section IDs and page slug.

4. Final Answer:

   Registers settings first, adds sections then fields in the correct order -> Option B

5. Quick Check:

   Register settings -> add sections -> add fields [OK]

Hint: Register settings first, then add sections, then fields [OK]

Common Mistakes:

• Adding fields before sections exist
• Registering settings after adding fields
• Mixing order of sections and fields