How to use add_option action in WordPress

add_option action

This action is fired before an option is added.

To use add_option action, first you have to register it using add_action. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_execute_on_add_option_event which takes 2 parameters and we registered using add_action. The first parameter add_option is the name of the hook, the second parameter weplugins_execute_on_add_option_event is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_action to remove add_option action.

Parameters

Below are the 2 parameters required to use this hook.

• $option: (string) Name of the option to add.
• $value: (mixed) Value of the option.

Live Example 1: Basic Usage

Below is an example of how you can use this hook.

    function weplugins_execute_on_add_option_event($option, $value){
       // Code to be executed when this action occurs in WordPress.
    }
    // Add the action
    add_action("add_option", "weplugins_execute_on_add_option_event", 10, 2);
    

Live Example 2: Logging Added Options

This example shows how to log the added options into a custom log file.

    function weplugins_log_added_option($option, $value){
       $log = fopen(WP_CONTENT_DIR . '/option_log.txt', 'a');
       fwrite($log, "Option added: $option with value: $valuen");
       fclose($log);
    }
    // Add the action
    add_action("add_option", "weplugins_log_added_option", 10, 2);
    

Live Example 3: Conditional Function Execution

Execute a function only if a specific option is added.

    function weplugins_conditional_option_function($option, $value){
       if($option == 'specific_option'){
           // Execute specific code here
       }
    }
    // Add the action
    add_action("add_option", "weplugins_conditional_option_function", 10, 2);
    

To remove a hook callback, use the example below.

    remove_action("add_option", "weplugins_execute_on_add_option_event", 10, 2);
    

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.