How to use parent_theme_file_path filter in WordPress

parent_theme_file_path filter

Filters the path to a file in the parent theme.

To use the parent_theme_file_path 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_parent_theme_file_path_defaults which takes 2 parameters and we registered using add_filter. The first parameter parent_theme_file_path is the name of the hook. The second parameter modify_parent_theme_file_path_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.

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

Parameters

Below are the 2 parameters required to use this hook.

• $path: (string) The file path.
• $file: (string) The requested file to search for.

Live Example 1

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

    function weplugins_modify_parent_theme_file_path_defaults($path, $file) { 
        // Update the $path variable according to your website requirements and return this variable. 
        // You can modify the $path variable conditionally too if you want.
        return $path; 
    }
    // add the filter
    add_filter("parent_theme_file_path", "weplugins_modify_parent_theme_file_path_defaults", 10, 2);
    

Live Example 2

To remove a hook callback, use the example below.

    remove_filter("parent_theme_file_path", "weplugins_modify_parent_theme_file_path_defaults", 10, 2);
    

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

Live Example 3

Another example of modifying the parent theme file path:

    function weplugins_custom_parent_theme_file_path($path, $file) {
        if ($file === 'custom-template.php') {
            $path = get_template_directory() . '/custom-path/' . $file;
        }
        return $path;
    }
    add_filter("parent_theme_file_path", "weplugins_custom_parent_theme_file_path", 10, 2);
    

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.