How to use allowed_options filter in WordPress

allowed_options filter

Filters the allowed options list.

To use the allowed_options filter, first register it using add_filter. You can write this code into the functions.php of your activated theme or in a custom WordPress Plugin.

At WePlugins, we 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 examples below, we’ve defined a function weplugins_modify_allowed_options_defaults which takes one parameter, and we registered it using add_filter. The first parameter allowed_options is the name of the hook. The second parameter weplugins_modify_allowed_options_defaults is the name of the function 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_filter to remove the allowed_options filter.

Parameters

Below the one parameter is required to use this hook.

• $allowed_options: (array) The allowed options list.

Live Example 1

Here is an example of how you can use this hook to modify allowed options.

    function weplugins_modify_allowed_options_defaults($allowed_options) {
        // Update the $allowed_options variable according to your website requirements
        return $allowed_options;
    }
    // Add the filter
    add_filter("allowed_options", "weplugins_modify_allowed_options_defaults", 10, 1);
    

Live Example 2

Below is an example of how to add a new section to the allowed options list.

    function weplugins_add_new_section($allowed_options) {
        $allowed_options['new-section'] = array('new-option-one', 'new-option-two');
        return $allowed_options;
    }
    // Add the filter
    add_filter("allowed_options", "weplugins_add_new_section", 10, 1);
    

Live Example 3

To remove a hook callback, use the example below.

    remove_filter("allowed_options", "weplugins_modify_allowed_options_defaults", 10, 1);
    

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.