Options API for site-wide settings in Wordpress - Step-by-Step Execution

Concept Flow - Options API for site-wide settings

Define option name and value

↓

Use add_option() to save

↓

Option stored in database

↓

Use get_option() to retrieve

↓

Use update_option() to change value

↓

Use delete_option() to remove

↓

End

This flow shows how WordPress Options API stores, retrieves, updates, and deletes site-wide settings in the database.

Execution Sample

Wordpress

<?php
add_option('site_color', 'blue');
echo get_option('site_color');
update_option('site_color', 'red');
echo get_option('site_color');
delete_option('site_color');
?>

This code saves a color option, reads it, updates it, reads again, then deletes it.

Execution Table

Step	Function Called	Option Name	Value Before	Action	Value After	Output
1	add_option	site_color	none	Add 'blue'	blue	none
2	get_option	site_color	blue	Retrieve value	blue	blue
3	update_option	site_color	blue	Update to 'red'	red	none
4	get_option	site_color	red	Retrieve updated value	red	red
5	delete_option	site_color	red	Remove option	none	none
6	get_option	site_color	none	Try retrieve deleted	none	false

💡 Option deleted at step 5, so retrieval at step 6 returns false.

Variable Tracker

Variable	Start	After Step 1	After Step 3	After Step 5	After Step 6
site_color option value	none	blue	red	none	none

Key Moments - 3 Insights

Why does get_option return false after delete_option?

Because delete_option removes the option from the database, so get_option finds nothing and returns false as shown in step 6 of the execution_table.

What happens if add_option is called with an existing option name?

add_option will not overwrite an existing option. It only adds if the option does not exist, so if the option exists, the value stays unchanged as shown by the initial add_option in step 1.

How does update_option differ from add_option?

update_option changes the value if the option exists or adds it if missing. add_option only adds if missing. This is why update_option in step 3 changes 'blue' to 'red'.

Visual Quiz - 3 Questions

Look at the execution_table, what is the output of get_option at step 4?

A "blue"

B false

C "red"

D none

💡 Hint

Check the Output column at step 4 in the execution_table.

At which step does the option value change from 'blue' to 'red'?

A Step 1

B Step 3

C Step 5

D Step 6

💡 Hint

Look at the Value After column in the execution_table for the update_option call.

If we call add_option('site_color', 'green') after step 5, what will get_option('site_color') return?

A "green"

B "red"

C false

D none

💡 Hint

add_option adds a new option only if it does not exist, so after deletion at step 5, it will add 'green'.

Concept Snapshot

Options API stores site-wide settings in WordPress.
Use add_option(name, value) to save new settings.
Use get_option(name) to read settings.
Use update_option(name, value) to change existing settings.
Use delete_option(name) to remove settings.
get_option returns false if option missing.

Full Transcript

This visual trace shows how WordPress Options API manages site-wide settings. First, add_option saves a new option 'site_color' with value 'blue'. Then get_option reads it and outputs 'blue'. update_option changes the value to 'red'. Another get_option outputs 'red'. delete_option removes the option. Finally, get_option returns false because the option no longer exists. This step-by-step shows how options are stored, retrieved, updated, and deleted in WordPress.

Practice

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

easy

A. To handle user login and authentication

B. To create new posts automatically

C. To store and manage site-wide settings easily

D. To style the website with CSS

Solution

1. Step 1: Understand the role of Options API

   The Options API is designed to store settings that affect the whole site, like site title or custom settings.

2. Step 2: Compare with other options

   Creating posts, user login, and styling are handled by other parts of WordPress, not the Options API.

3. Final Answer:

   To store and manage site-wide settings easily -> Option C

4. Quick Check:

   Options API = site-wide settings [OK]

Hint: Options API is for site settings, not content or style [OK]

Common Mistakes:

• Confusing Options API with post creation
• Thinking it manages user authentication
• Assuming it handles CSS styling

2. Which function is used to retrieve a stored option value in WordPress?

easy

A. add_option()

B. get_option()

C. update_option()

D. delete_option()

Solution

1. Step 1: Identify function purposes

   add_option() adds a new option, update_option() changes it, delete_option() removes it, and get_option() retrieves the value.

2. Step 2: Match retrieval action

   Since we want to get or read the stored value, get_option() is the correct function.

3. Final Answer:

   get_option() -> Option B

4. Quick Check:

   Retrieve option = get_option() [OK]

Hint: Get means retrieve, so get_option() fetches values [OK]

Common Mistakes:

• Using add_option() to get values
• Confusing update_option() with retrieval
• Trying to delete instead of get

3. What will be the output of this code snippet?

add_option('site_color', 'blue');
update_option('site_color', 'green');
echo get_option('site_color');

medium

A. blue

B. null

C. site_color

D. green

Solution

1. Step 1: Understand add_option and update_option

   add_option sets 'site_color' to 'blue'. Then update_option changes it to 'green'.

2. Step 2: Retrieve current value

   get_option('site_color') returns the latest value, which is 'green'.

3. Final Answer:

   green -> Option D

4. Quick Check:

   Updated option value = green [OK]

Hint: Update_option overwrites add_option value [OK]

Common Mistakes:

• Assuming add_option value stays after update
• Expecting null if updated
• Confusing option name with value

4. Identify the error in this code snippet:

update_option('header_text', 'Welcome!');
add_option('header_text', 'Hello!');
echo get_option('header_text');

medium

A. No error, code works fine

B. get_option cannot retrieve 'header_text'

C. update_option cannot update existing options

D. add_option should be called before update_option

Solution

1. Step 1: Understand function order

   add_option adds a new option only if it doesn't exist. update_option updates existing or adds if missing.

2. Step 2: Analyze code order

   Calling update_option first works fine because it adds or updates the option. add_option after will fail to add since the option exists, but this does not cause an error.

3. Step 3: Correct usage

   While add_option before update_option is typical, the code runs without error.

4. Final Answer:

   No error, code works fine -> Option A

5. Quick Check:

   update_option can add option; add_option after does nothing [OK]

Hint: update_option can add option; add_option after does nothing [OK]

Common Mistakes:

• Calling add_option after update_option
• Thinking update_option can't add new options
• Assuming get_option fails here

5. You want to store a site-wide setting that controls whether comments are enabled. Which approach correctly uses the Options API to toggle this setting on and then retrieve it?

hard

A. update_option('comments_enabled', true); echo get_option('comments_enabled');

B. add_option('comments_enabled', true); update_option('comments_enabled', false); echo get_option('comments_enabled');

C. add_option('comments_enabled', true); echo get_option('comments_enabled'); update_option('comments_enabled', false);

D. delete_option('comments_enabled'); add_option('comments_enabled', true); echo get_option('comments_enabled');

Solution

1. Step 1: Understand update_option behavior

   update_option adds the option if it doesn't exist, so calling it first with true sets the value.

2. Step 2: Retrieve current value

   Calling get_option right after returns true, showing comments enabled.

3. Step 3: Toggle setting

   To toggle off, you would call update_option('comments_enabled', false) later. update_option('comments_enabled', true); echo get_option('comments_enabled'); shows correct initial set and get.

4. Final Answer:

   update_option('comments_enabled', true); echo get_option('comments_enabled'); -> Option A

5. Quick Check:

   update_option adds or updates, then get_option reads [OK]

Hint: update_option can add new option; no need to add_option first [OK]

Common Mistakes:

• Calling add_option then update_option without retrieval
• Deleting option unnecessarily
• Expecting add_option to update existing option