How to use deprecated_function_trigger_error filter in WordPress

deprecated_function_trigger_error filter

Filters whether to trigger an error for deprecated functions. To use the deprecated_function_trigger_error 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.

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 below live example, we have defined a function weplugins_modify_deprecated_function_trigger_error_defaults which takes 1 parameter and is registered using add_filter. The first parameter deprecated_function_trigger_error is the name of the hook, the second parameter weplugins_modify_deprecated_function_trigger_error_defaults 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_filter to remove deprecated_function_trigger_error filter.

Parameters

Below is the 1 parameter required to use this hook.

• $trigger : (bool) Whether to trigger the error for deprecated functions. Default true.

Live Example 1

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

    function weplugins_modify_deprecated_function_trigger_error_defaults($trigger) {
        // Update the $trigger variable according to your website requirements and return this variable. You can modify the $trigger variable conditionally too if you want.
        return $trigger;
    }
    // add the filter
    add_filter("deprecated_function_trigger_error", "weplugins_modify_deprecated_function_trigger_error_defaults", 10, 1);
    

Live Example 2

To remove a hook callback, use the example below.

    remove_filter("deprecated_function_trigger_error", "weplugins_modify_deprecated_function_trigger_error_defaults", 10, 1);
    

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

Live Example 3

Another way to use the deprecated_function_trigger_error filter is by conditionally modifying the $trigger variable.

    function weplugins_modify_deprecated_function_trigger_error_conditionally($trigger) {
        // Conditionally modify the $trigger variable
        if (some_condition) {
            $trigger = false;
        }
        return $trigger;
    }
    // add the filter
    add_filter("deprecated_function_trigger_error", "weplugins_modify_deprecated_function_trigger_error_conditionally", 10, 1);
    

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