get_site_by_path

SummerySummery

Retrieves the closest matching site object by its domain and path.

Syntax

get_site_by_path( string $domain, string $path, int|null $segments = null )

DescriptionDescription

This will not necessarily return an exact match for a domain and path. Instead, it breaks the domain and path into pieces that are then used to match the closest possibility from a query.

The intent of this method is to match a site object during bootstrap for a requested site address

ParametersParameters

$domain

(string) (Required) Domain to check.

$path

(string) (Required) Path to check.

$segments

(int|null) (Optional) Path segments to use. Defaults to null, or the full path.

Default value: null

ReturnReturn

(WP_Site|false) Site object if successful. False when no site is found.

SourceSource

File: wp-includes/ms-load.php


			

ChangelogChangelog

Changelog
Version Description
4.7.0 Updated to always return a WP_Site object.
3.9.0 Introduced.
Scroll to Top