How to use home_url filter in WordPress

home_url filter

Filters the home URL.

To use the home_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_home_url_defaults which takes 4 parameters and we registered using add_filter. The first parameter home_url is the name of the hook, the second parameter weplugins_modify_home_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 the home_url filter.

Parameters

Below are the 4 parameters required to use this hook.

• $url : (string) The complete home URL including scheme and path.
• $path : (string) Path relative to the home URL. Blank string if no path is specified.
• $orig_scheme : (string|null) Scheme to give the home URL context. Accepts ‘http’, ‘https’, ‘relative’, ‘rest’, or null.
• $blog_id : (int|null) Site ID, or null for the current site.

Live Example

apply_filters( 'home_url', string $url, string $path, string|null $orig_scheme, int|null $blog_id )

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

Example 1: Basic Usage

This example shows how to modify the home URL by updating the $url variable.

        function weplugins_modify_home_url_defaults($url, $path, $orig_scheme, $blog_id) { 
            // 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( "home_url", "weplugins_modify_home_url_defaults", 10, 4 );
    

Example 2: Conditional URL Modification

In this example, we conditionally modify the $url based on the path.

        function weplugins_modify_home_url_conditionally($url, $path, $orig_scheme, $blog_id) { 
            if ($path == 'special-path') {
                // Modify the URL for a specific path
                $url = 'https://example.com/special/';
            }
            return $url; 
        }
        // add the filter
        add_filter( "home_url", "weplugins_modify_home_url_conditionally", 10, 4 );
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

        remove_filter( "home_url", "weplugins_modify_home_url_defaults", 10, 4 );
    

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

Contact Us

If you need customization or assistance with this hook, please contact us.