Getting the current site home URL in WordPress using get_home_url

The get_home_url function in WordPress returns the home URL of the current site. This can be useful for dynamically generating links to the homepage without hardcoding the URL.

It can be used to ensure that links to the homepage are always correct, even if the site’s URL structure changes. Additionally, it can be used to create links to the homepage within templates or plugins without needing to manually construct the URL.

Parameters Accepted by the get_home_url Function

The get_home_url function accepts the following parameters:

  • $blog_id (int, null) – optional. Default value: null. Description: Site ID. Default null (current site).
  • $path (string) – optional. Default value: ”. Description: Path relative to the home URL.
  • $scheme (string, null) – optional. Default value: null. Description: Scheme to give the home URL context. Accepts ‘http’, ‘https’, ‘relative’, ‘rest’, or null.

Value Returned by the get_home_url Function

The get_home_url function returns a string which is the Home URL link with an optional path appended.

Examples

How to get the home URL of the current site

$url = get_home_url();
echo $url;

This code snippet retrieves the home URL of the current site using the get_home_url function and then echoes the URL.

How to get the home URL of a specific site by site ID

$site_id = 2;
$url = get_home_url( $site_id );
echo $url;

This code snippet retrieves the home URL of a specific site by site ID using the get_home_url function and then echoes the URL.

How to get the home URL with a specific path appended

$path = '/about-us';
$url = get_home_url( null, $path );
echo $url;

This code snippet retrieves the home URL of the current site and appends a specific path to it using the get_home_url function, then echoes the URL.

Conclusion

In conclusion, the get_home_url function is an essential tool for retrieving the home URL of a WordPress site. It provides a flexible way to access the home URL and can be used in various contexts within a WordPress environment. By understanding how to use this function effectively, developers can improve the functionality and user experience of their WordPress websites. With its ability to accept optional parameters, the get_home_url function offers a versatile solution for customizing the home URL based on specific requirements. Overall, the get_home_url function is an essential component for WordPress developers and can greatly enhance the development process.

Related WordPress Functions

in WordPress Functions