home_url WordPress Filter Hook

The home_url hook allows you to modify the URL of the home page. This can be useful if you want to change the home page URL to something else, or if you want to add a parameter to the home page URL.

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

Filters the home URL.

Parameters
Source
Related
- Used By
Changelog

Parameters

$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.