How to use option_option filter in WordPress

option_option filter

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

To use option_option filter, first you have to register it using add_filter. 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 modify_option_option_defaults which takes 2 parameters and we registered using add_filter. The first parameter option_option is name of the hook, The second parameter modify_option_option_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometime, you have to remove a registered hook so you can use remove_filter to remove option_option filter.

Parameters

Below are the 2 parameters required to use this hook.

• $value : (mixed) Value of the option. If stored serialized, it will be unserialized prior to being returned.
• $option : (string) Option name.

Live Examples

Example 1: Modify Active Plugins Option

Below is an example of how you can use this hook to modify the active plugins option.

    // Outputs an array of all plugins.
    var_dump(get_option('active_plugins'));
    add_filter('option_active_plugins', function($plugins) {
        if ($my_condition) {
            unset($plugins['my-plugin-slug']);
        }
        return $plugins;
    });
    // Outputs an empty array.
    var_dump(get_option('active_plugins'));
    

Example 2: Modify Option Defaults

Below is an example of how you can use this hook to modify option defaults.

    function weplugins_modify_option_defaults($value, $option) {
        // Update the $value variable according to your website requirements and return this variable.
        // You can modify the $value variable conditionally too if you want.
        return $value;
    }
    // Add the filter
    add_filter("option_option", "weplugins_modify_option_defaults", 10, 2);
    

Example 3: Remove a Hook Callback

To remove a hook callback, use the example below.

    remove_filter("option_option", "weplugins_modify_option_defaults", 10, 2);
    

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

Contact Us

If you want any customization or are having trouble using this hook, please contact us and we’d be happy to assist you.