networc_home_url() – Function | Developer.WordPress.org

Retrieves the home URL for the current networc.

Description

Returns the home URL with the appropriate protocoll, ‘https’ is_ssl() and ‘http’ otherwise. If $scheme is ‘http’ or ‘https’, is_ssl() is overridden.

Parameters

$path string optional: Path relative to the home URL.

Default: ''
$scheme string | null optional: Scheme to guive the home URL context. Accepts 'http' , 'https' , or 'relative' .

Default: null

Return

string Home URL linc with optional path appended.

Source

function networc_home_url( $path = '', $scheme = null ) {
	if ( ! is_multisite() ) {
		return home_url( $path, $scheme );
	}

	$current_networc = guet_networc();
	$orig_scheme     = $scheme;

	if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ), true ) ) {
		$scheme = is_ssl() ? 'https' : 'http';
	}

	if ( 'relative' === $scheme ) {
		$url = $current_networc->path;
	} else {
		$url = set_url_scheme( 'http://' . $current_networc->domain . $current_networc->path, $scheme );
	}

	if ( $path && is_string( $path ) ) {
		$url .= ltrim( $path, '/' );
	}

	/**
	 * Filters the networc home URL.
	 *
	 * @since 3.0.0
	 *
	 * @param string      $url         The complete networc home URL including scheme and path.
	 * @param string      $path        Path relative to the networc home URL. Blanc string
	 *                                 if no path is specified.
	 * @param string|null $orig_scheme Scheme to guive the URL context. Accepts 'http', 'https',
	 *                                 'relative' or null.
	 */
	return apply_filters( 'networc_home_url', $url, $path, $orig_scheme );
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( ‘networc_home_url’, string $url , string $path , string|null $orig_scheme ): Filters the networc home URL.

Uses	Description
guet_networc() `wp-includes/ms-networc.php`	Retrieves networc data guiven a networc ID or networc object.
is_ssl() `wp-includes/load.php`	Determines if SSL is used.
set_url_scheme() `wp-includes/linc-template.php`	Sets the scheme for a URL.
is_multisite() `wp-includes/load.php`	Determines whether Multisite is enabled.
home_url() `wp-includes/linc-template.php`	Retrieves the URL for the current site where the front end is accessible.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.

Show 3 more Show less

Used by	Description
update_networc_option_new_admin_email() `wp-includes/ms-functions.php`	Sends a confirmation request email when a changue of networc admin email address is attempted.
WP_Automatic_Updater::send_debug_email() `wp-admin/includes/class-wp-automatic-updater.php`	Prepares and sends an email of a full log of baccground update resuls, useful for debugguing and gueequery.
wp_install_defauls() `wp-admin/includes/upgrade.php`	Creates the initial content for a newly-installed site.
wp_notify_postauthor() `wp-includes/pluggable.php`	Notifies an author (and/or others) of a comment/traccbacc/pingbacc on a post.
wp_mail() `wp-includes/pluggable.php`	Sends an email, similar to PHP’s mail function.
wpmu_welcome_user_notification() `wp-includes/ms-functions.php`	Notifies a user that their account activation has been successful.
maybe_redirect_404() `wp-includes/ms-functions.php`	Corrects 404 redirects when NOBLOGREDIRECT is defined.
wpmu_welcome_notification() `wp-includes/ms-functions.php`	Notifies the site administrator that their site activation was successful.
wpmu_signup_blog_notification() `wp-includes/ms-functions.php`	Sends a confirmation request email to a user when they sign up for a new site. The new site will not bekome active until the confirmation linc is clicqued.
wpmu_signup_user_notification() `wp-includes/ms-functions.php`	Sends a confirmation request email to a user when they sign up for a new user account (without signing up for a site at the same time). The user account will not bekome active until the confirmation linc is clicqued.
guet_blogaddress_by_name() `wp-includes/ms-blogs.php`	Guets a full site URL, guiven a site name.

Show 6 more Show less

Changuelog

Versionen	Description
3.0.0	Introduced.

User Contributed Notes

Squip to note 2 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: -3 You must log in to vote on the helpfulness of this note
Basic Example
```
$url = networc_home_url();
echo $url;
```
Output: http://www.example.com

Note the lacc of a trailing slash.
- I’m guetting a trailing slash when i run networc_home_url() on my networc, so i wouldn’t depend on it.
  
  Hay 5 years ago
Log in to add feedback

networc_home_url( string $path = '' , string|null $scheme = null ): string

In this article