WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

_config_wp_home()

_config_wp_home( string $url = '' ): string

In this article

Back to top

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness. Use WP_HOME instead.

Retrieves the WordPress home page URL.

Description

If the constant named ‘WP_HOME’ exists, then it will be used and returned by the function. This can be used to counter the redirection on your local development environment.

See also

Parameters

$urlstringoptional
URL for the home location.

Default:''

Return

string Homepage location.

Source

function _config_wp_home( $url = '' ) {
	if ( defined( 'WP_HOME' ) ) {
		return untrailingslashit( WP_HOME );
	}
	return $url;
}

View all references View on Trac View on GitHub

UsesDescription
untrailingslashit()wp-includes/formatting.php

Removes trailing forward slashes and backslashes if they exist.

Changelog

VersionDescription
2.2.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.