How to use pre_update_option_option action in WordPress

pre_update_option_option action

The dynamic portion of the hook name, $option, refers to the option name.

To use pre_update_option_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 execute_on_pre_update_option_option_event which takes 3 parameters and we registered it using add_action. The first parameter pre_update_option_option is the name of the hook, the second parameter execute_on_pre_update_option_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 the pre_update_option_option action.

Parameters

Below are the 3 parameters required to use this hook.

• $value : (mixed) The new, unserialized option value.
• $old_value : (mixed) The old option value.
• $option : (string) Option name.

Live Example 1: Basic Usage

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

    function weplugins_execute_on_pre_update_option_option_event($value, $old_value, $option) {
        // You can write code here to be executed when this action occurs in WordPress.
        // Use the parameters received in the function arguments & implement the required additional custom functionality according to your website requirements.
    }
    // add the action
    add_action("pre_update_option_option", "weplugins_execute_on_pre_update_option_option_event", 10, 3);
    

Live Example 2: Updating Option Value

In this example, we update the option value before it is saved.

    add_action('init', 'weplugins_init');
    function weplugins_init() {
        add_filter('pre_update_option_foo', 'weplugins_update_field_foo', 10, 2);
    }
    function weplugins_update_field_foo($new_value, $old_value) {
        $new_value = intval($new_value);
        $new_value++;
        return $new_value;
    }
    

Live Example 3: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_action("pre_update_option_option", "weplugins_execute_on_pre_update_option_option_event", 10, 3);
    

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

Contact Us

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.