Settings API in Wordpress - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the WordPress Settings API?

The Settings API is a WordPress tool that helps developers create, manage, and save settings pages easily and securely in the admin area.

beginner

Which function registers a setting in the WordPress Settings API?

The function register_setting() is used to register a setting so WordPress knows how to save and sanitize it.

intermediate

What are the main components you need to create a settings page using the Settings API?

You need to register settings, add settings sections, add settings fields, and create a page to display them.

intermediate

How does the Settings API help with security?

It automatically handles data sanitization and nonce verification to protect against invalid or malicious input.

beginner

What hook is commonly used to add a settings page in the WordPress admin menu?

The admin_menu hook is used to add new pages or menus in the WordPress admin area.

Which function is used to add a settings section in the Settings API?

A add_settings_section()

B register_setting()

C add_settings_field()

D add_menu_page()

The function add_settings_section() adds a new section to group settings fields.

What does register_setting() mainly do?

A Creates a new admin menu

B Adds a settings field to a section

C Displays the settings page

D Registers a setting and its sanitization callback

register_setting() tells WordPress about a setting and how to clean its data.

Which hook should you use to add your settings page to the WordPress admin menu?

A admin_menu

B admin_init

C init

D wp_head

Use admin_menu to add pages or menus in the WordPress admin dashboard.

What is the purpose of add_settings_field()?

A To register a new setting

B To add a field to a settings section

C To create a new settings page

D To sanitize user input

add_settings_field() adds input fields inside a settings section.

How does the Settings API improve user input handling?

A By automatically saving all inputs without checks

B By requiring manual database queries

C By providing built-in sanitization and validation callbacks

D By disabling user input

The API lets you define sanitization functions to clean user input before saving.

Explain the steps to create a settings page using the WordPress Settings API.

Think about registering settings, grouping them, adding fields, and showing the page.

Describe how the Settings API helps keep WordPress settings secure.

Focus on how it cleans and protects user input.

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