How to use deprecated_file_included action in WordPress

deprecated_file_included action

Fires when a deprecated file is called.

To use the deprecated_file_included 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_deprecated_file_included_event which takes 4 parameters and we registered it using add_action. The first parameter deprecated_file_included is the name of the hook, the second parameter execute_on_deprecated_file_included_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 deprecated_file_included action.

Parameters

Below are the 4 parameters required to use this hook:

• $file: (string) The file that was called.
• $replacement: (string) The file that should have been included based on ABSPATH.
• $version: (string) The version of WordPress that deprecated the file.
• $message: (string) A message regarding the change.

Live Examples

Example 1: Basic Usage

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

    function weplugins_execute_on_deprecated_file_included_event($file, $replacement, $version, $message){
       // 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_file_included", "weplugins_execute_on_deprecated_file_included_event" , 10, 4);
    

Example 2: Remove Hook Callback

To remove a hook callback, use the example below:

    remove_action( "deprecated_file_included", "weplugins_execute_on_deprecated_file_included_event", 10, 4 );
    

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

Example 3: Logging Deprecated Files

If you want to log deprecated files for debugging purposes, you can use this example:

    function weplugins_log_deprecated_files($file, $replacement, $version, $message) {
        error_log("Deprecated file called: $file. Use $replacement instead. Deprecated since version $version. Message: $message");
    }
    add_action( "deprecated_file_included", "weplugins_log_deprecated_files", 10, 4 );
    

Contact Us

If you’re having any trouble using this hook, please Contact Us and we’d be happy to assist you.