How to use deprecated_function_run action in WordPress

deprecated_function_run action

Fires when a deprecated function is called.

To use deprecated_function_run 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_deprecated_function_run_event which takes 3 parameters and we registered using add_action. The first parameter deprecated_function_run is the name of the hook, the second parameter weplugins_execute_on_deprecated_function_run_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 deprecated_function_run action.

Parameters

Below are the 3 parameters required to use this hook.

• $function: (string) The function that was called.
• $replacement: (string) The function that should have been called.
• $version: (string) The version of WordPress that deprecated the function.

Live Example 1

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

        function weplugins_execute_on_deprecated_function_run_event($function, $replacement, $version) {
           // 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("deprecated_function_run", "weplugins_execute_on_deprecated_function_run_event", 10, 3);
    

Live Example 2

To remove a hook callback, use the example below.

        remove_action("deprecated_function_run", "weplugins_execute_on_deprecated_function_run_event", 10, 3);
    

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

Live Example 3

In this example, we will log the deprecated function information to the debug log.

        function weplugins_log_deprecated_function($function, $replacement, $version) {
            if (WP_DEBUG) {
                error_log("Deprecated function called: $function. Use $replacement instead. Deprecated since version $version.");
            }
        }
        add_action("deprecated_function_run", "weplugins_log_deprecated_function", 10, 3);
    

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.