How to use includes_url filter in WordPress

includes_url filter

Filters the URL to the includes directory.

To use includes_url 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 weplugins_modify_includes_url_defaults which takes 3 parameters and we registered using add_filter. The first parameter includes_url is the name of the hook, the second parameter weplugins_modify_includes_url_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 includes_url filter.

Parameters

Below are the 3 parameters required to use this hook.

• $url: (string) The complete URL to the includes directory including scheme and path.
• $path: (string) Path relative to the URL to the wp-includes directory. Blank string if no path is specified.
• $scheme: (string|null) Scheme to give the includes URL context. Accepts ‘http’, ‘https’, ‘relative’, or null. Default null.

Live Example 1

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

    function weplugins_modify_includes_url_defaults($url, $path, $scheme) { 
        // Update the $url variable according to your website requirements and return this variable. 
        // You can modify the $url variable conditionally too if you want.
        return $url; 
    }
    // add the filter
    add_filter("includes_url", "weplugins_modify_includes_url_defaults", 10, 3);
    

Live Example 2

To remove a hook callback, use the example below.

    remove_filter("includes_url", "weplugins_modify_includes_url_defaults", 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

Here’s another example of modifying the URL conditionally based on the scheme.

    function weplugins_modify_includes_url_conditional($url, $path, $scheme) { 
        if ($scheme === 'https') {
            $url = str_replace('http://', 'https://', $url);
        }
        return $url; 
    }
    // add the filter
    add_filter("includes_url", "weplugins_modify_includes_url_conditional", 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.